Quick Install

Once you install TileDB, visit the Usage page to see how to use TileDB in your programs.

Python

# Install from PyPI:
$ pip install tiledb

# Or Conda:
$ conda install -c conda-forge tiledb-py

Conda will install pre-built TileDB-Py and TileDB core binaries for Windows, macOS, or Linux. Pip currently provides binary wheels for Linux, and will build all dependences from source on other platforms (see Building from Source for more information).

R

# -- from CRAN
# install most recent release from CRAN
install.packages("tiledb")

# -- alternatively, install from source via GitHub
# install the 'remotes' package if needed
# install.packages("remotes")
library(remotes)
install_github("TileDB-Inc/TileDB-R", ref = github_release())

# -- verify install
library(tiledb)
tiledb::tiledb_version()
#> major minor patch 
#>     2     0     8

TileDB needs to be installed beforehand (from a package or from source) for the TileDB-R package to build and link correctly. See Pre-built Packages for methods of installing TileDB.

Using TileDB From Custom Location

If the TileDB library is installed in a custom location, you need to pass the explicit path:

library(remotes)
install_github("TileDB-Inc/TileDB-R",
               ref = github_release(),
               args="--configure-args='--with-tiledb=/path/to/tiledb'")

Note on Installing with Conda

If you are using R inside conda and want to install TileDB-R you might run into a issue with devtools/remotes around gtar. The error is below:

Downloading GitHub repo TileDB-Inc/TileDB-R@master
sh: 1: /bin/gtar: not found
sh: 1: /bin/gtar: not found
Error: Failed to install 'tiledb' from GitHub:

To fix this, simply export the TAR environmental variable before starting R

# Inside conda environment
TAR=`which tar` R

> # Follow instructions at start for installing TileDB-R

C#

Use the TileDB.CSharp NuGet package to create a .NET console application with the .NET CLI. The TileDB NuGet package is currently compatible with .NET 5 and above.

# Create a new .NET solution
$ dotnet new sln -o TileDB-Project
$ cd TileDB-Project
# Create a new console project using .NET CLI
$ dotnet new console -o ConsoleApp
$ dotnet sln add ConsoleApp/ConsoleApp.csproj

# Add TileDB.CSharp NuGet package to the project
$ dotnet add ConsoleApp/ConsoleApp.csproj package TileDB.CSharp

After running the commands above our TileDB-Project/ConsoleApp/ConsoleApp.csproj will have the following configuration, providing access to the TileDB-CSharp API in our project.

Your project must declare a runtime identifier (RID) otherwise the native TileDB Embedded binaries will not be imported and the app might fail at runtime.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net5.0</TargetFramework>
    <RootNamespace>TileDB_Project</RootNamespace>
    <!-- Use one of the following options to set an RID: -->
    <!-- This sets a specific RID. Useful for deployment. -->
    <RuntimeIdentifier>win10-x64</RuntimeIdentifier>
    <!-- This sets the RID to the one of your machine.
    Useful for development. -->
    <UseCurrentRuntimeIdentifier>true</UseCurrentRuntimeIdentifier>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="TileDB.CSharp" Version="5.3.0" />
  </ItemGroup>

</Project>

To test our project we can edit TileDB-Project/ConsoleApp/Program.cs and obtain the version of TileDB core currently in use by TileDB.CSharp. For more examples using the C# API see the TileDB-Inc/TileDB-CSharp repository on GitHub.

using System;
using TileDB.CSharp;

namespace TileDB_Project
{
    class Program
    {
        static void Main(string[] args)
        {
            var version = CoreUtil.GetCoreLibVersion();
            Console.WriteLine($"TileDB Core version: {version}");
            // TileDB Core version: 2.13.1
        }
    }
}

C / C++

# Download the pre-built release binaries from (Windows):
# https://github.com/TileDB-Inc/TileDB/releases

# Or install via Conda (macOS, Linux, Windows):
$ conda install -c conda-forge tiledb

Go

# Go Get
$ go get -v github.com/TileDB-Inc/TileDB-Go

# Go modules
go mod init github.com/<github_username>/repository_name

Here is a sample go.mod file:

module github.com/<github_username>/repository_name

go 1.13

require (
	github.com/TileDB-Inc/TileDB-Go v0.6.0
)

TileDB needs to be installed beforehand (from a package or from source) for the TileDB-Go library to build and link correctly.

Docker

$ docker pull tiledb/tiledb
$ docker run -it tiledb/tiledb