Skip to main content

Python API for efficient storage and retrieval of single-cell data using TileDB

Project description

Overview

This is a Python implementation of the SOMA API specification for interacting with the Unified Single-cell Data Model.

Installation

TileDB-SOMA is available on PyPI and Conda, and can be installed via pip or mamba as indicated below.

python -m pip install tiledbsoma
mamba install -c conda-forge -c tiledb tiledbsoma-py

To install a specific version:

$ python -m pip install git+https://github.com/single-cell-data/TileDB-SOMA.git@0.0.6#subdirectory=apis/python

To update to the latest version:

$ python -m pip install --upgrade tiledbsoma

From source

  • This requires tiledb (see ./setup.cfg for version), in addition to other dependencies in setup.cfg.
  • Clone this repo
  • cd into your checkout and then cd apis/python
  • python -m pip install .
  • Or, if you wish to modify the code and run it, python -m pip install -v -e .
  • If the TileDB and TileDB-SOMA libraries are locally installed to a custom directory, such as /usr/local, set the path with environment variables TILEDB_PATH and TILEDBSOMA_PATH, TILEDB_PATH=/usr/local python -m pip install -v -e .
  • Optionally, if you prefer, you can run that inside venv:
    $ python -m venv venv
    $ . ./venv/bin/activate
    $ python -m pip install -v -e .
    
  • In either case:
    python -m pytest tests
    

Status

Please see https://github.com/single-cell-data/TileDB-SOMA/issues.

platform_config format

When accessing SOMA APIs, TileDB-specific settings can be configured with the platform_config parameter. The options accepted by TileDB SOMA are described here, using TypeScript interface syntax:

interface PlatformConfig {
  tiledb?: TDBConfig;
}

interface TDBConfig {
  create?: TDBCreateOptions;
}

interface TDBCreateOptions {
  dims?: { [dim: string]: TDBDimension };
  attrs?: { [attr: string]: TDBAttr };
  allows_duplicates?: bool;

  offsets_filters?: TDBFilter[];
  validity_filters?: TDBFilter[];

  capacity?: number;
  cell_order?: string;
  tile_order?: string;
}

interface TDBDimension {
  filters?: TDBFilter[];
  tile?: number;
}

interface TDBAttr {
  filters?: TDBFilter[];
}

/**
 * Either the name of a filter (in which case it will use
 * the default arguments) or a specification with filter args.
 */
type TDBFilter = string | TDBFilterSpec;

interface TDBFilterSpec {
  /** The name of the filter. */
  _name: string;
  /** kwargs that are passed when constructing the filter. */
  [kwarg: string]: any;
}

Information for developers

Please see the TileDB-SOMA wiki.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tiledbsoma-1.6.2.tar.gz (204.5 kB view details)

Uploaded Source

Built Distributions

tiledbsoma-1.6.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.6.2-cp311-cp311-macosx_11_0_arm64.whl (9.8 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

tiledbsoma-1.6.2-cp311-cp311-macosx_10_14_x86_64.whl (12.5 MB view details)

Uploaded CPython 3.11 macOS 10.14+ x86-64

tiledbsoma-1.6.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.6.2-cp310-cp310-macosx_11_0_arm64.whl (9.8 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

tiledbsoma-1.6.2-cp310-cp310-macosx_10_14_x86_64.whl (12.5 MB view details)

Uploaded CPython 3.10 macOS 10.14+ x86-64

tiledbsoma-1.6.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.6.2-cp39-cp39-macosx_11_0_arm64.whl (9.8 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

tiledbsoma-1.6.2-cp39-cp39-macosx_10_14_x86_64.whl (12.5 MB view details)

Uploaded CPython 3.9 macOS 10.14+ x86-64

tiledbsoma-1.6.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.6.2-cp38-cp38-macosx_11_0_arm64.whl (9.8 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

tiledbsoma-1.6.2-cp38-cp38-macosx_10_14_x86_64.whl (12.5 MB view details)

Uploaded CPython 3.8 macOS 10.14+ x86-64

tiledbsoma-1.6.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

tiledbsoma-1.6.2-cp37-cp37m-macosx_10_14_x86_64.whl (12.5 MB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

File details

Details for the file tiledbsoma-1.6.2.tar.gz.

File metadata

  • Download URL: tiledbsoma-1.6.2.tar.gz
  • Upload date:
  • Size: 204.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for tiledbsoma-1.6.2.tar.gz
Algorithm Hash digest
SHA256 085e7882c1b0a652fd466ee9842160002dcf4aad7e7be7f50d3dad063f3e6b70
MD5 82f5e88423bde63b7a1d6c6ad406a1af
BLAKE2b-256 c880848e3b1b4a12826a6b05843bdb68c2f49a1e9018d93107cb9149f25640b2

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7f4082ad7bb78141cbb46e657757d7349672321281b0552c77ace7a2e6778a0e
MD5 dcf7b8a1162dffd8d686383b1f31a619
BLAKE2b-256 62000b2c0abf63327c71d3660a96a2c11bbc0c9e3858b04a59bcaecf8736d860

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4bb896bda61c5633f668032d2dcb7d522e68a091053d0a413b2531d3cd4efec9
MD5 b8e79aa25b9ffa0336faf1295bcaa5dc
BLAKE2b-256 97fdf209a6fcf6a01bdd1986a9883c86c2f4c2b3786b329d56d439bbe9df6353

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp311-cp311-macosx_10_14_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 9d8a1bb91aa688299fd5995de07bf3eb4cf0bb1ecf7c8a463fb7b4877f3c7d04
MD5 088adaf503a26697946ec256fe4a222b
BLAKE2b-256 f24db0595eb214b30e080d52d569c26923b1dca4028148e17af9de2e4e650851

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 34e5306631ea2108e15df12da9dcc1c32a9a4de0612869af385f0433842b91e6
MD5 1566fb636130ab3fdbeaad586b4bff5c
BLAKE2b-256 bf930a873b9c45ca5f5baa392b41686cde7ec15a250d9cd827df63efbf41bd17

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 32b43adb10d58e1d69d10c8bed8cce463edc4964ec4cfaeddce2d0f729bd963c
MD5 07ee982addf49816c38d083c734683d6
BLAKE2b-256 5f92046d91e28ba56c2f564fa6d703a1c04d93ce20bde6cdc978fce0a809867b

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp310-cp310-macosx_10_14_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 7b1f4ee4288cb6328af6306927c1876bad3480507301417940f5a69564ea09d2
MD5 5b95da036292e7521c7b45d357531829
BLAKE2b-256 090957c526f93f02af06193bd7d7b068815e4bdce8ccb30f687a29c8abc5e404

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 fc5a7cf7b9ac47f4ea527007e7afb96e389563055a00f32711652f8a9e2ccf1a
MD5 2dc96db2d539439684809ab880b601d6
BLAKE2b-256 ba043422dfb7bb0818d9422977eca6e98244f93efbee42fa71292928f2d229e3

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8bb2f6117821fad6f1296c7227ccc20ddad61451924eaa28800de9d555947a0c
MD5 5727f959f0222998b4d9163097723c3c
BLAKE2b-256 276097377f7ded110168e5bcf1f100b385055d167b255d3abffca0efb2c15748

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp39-cp39-macosx_10_14_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 5ebba9e0073a75a47ac13546853de35fe95730dffb34836ca8f5dbeeb51ca4e5
MD5 93aa805044445674275e188b33d346cd
BLAKE2b-256 6cce50b467cf6fbcf4b357b7d0b2140b87a7bcde8e63dfb7c4001d5fb494a5f5

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5ebba8d1908cbd7a3a4d54e8d04b488126d6acd05b076405298cdeaaea78e0be
MD5 34ba829cdb291557e90b9b0bb72a2c94
BLAKE2b-256 10096aff889df1970c996e1b6f47ba2d7dc8791ab597a9c686185a851f3c223c

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp38-cp38-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 877f6cff12c813b818e9565b7960ee5bb9943a86bc4001e262605a652cf1ff47
MD5 61e2c0225f402d695757e2aa99b1dd06
BLAKE2b-256 4232ba7961d89d62bd60c1faa5626c06ea856e23922fb84893bf8af6e2f20005

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp38-cp38-macosx_10_14_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 11960bc2ce254a4a87791b46ee2cc1f362de6d1fb240380369e7e3a4162f0415
MD5 d0597d673a521f7db94c92adb9e17c6b
BLAKE2b-256 57d333b8f2769d430ab9ff5e05728494b34c9922ec19434ecfa57552ab92b149

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 dbc8b45d5e7918d86ed51f4687f5a372a6aa18e04c8ee83ba0425a05623f1df7
MD5 35bf5a713f11b3ec25d9e51384fe0f35
BLAKE2b-256 183d6f9b9914b3d2a9c0f5dcde6ab1f94e585a6cbbc639c1e9eedfc32f2f5b68

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.6.2-cp37-cp37m-macosx_10_14_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.6.2-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 42b62bbc151e05572f5baa118b936b573d6570d7b67ad82e53fabfd8a1421a63
MD5 845e18aa8ea8f29ece4d476e9fb819df
BLAKE2b-256 9c466660357ca2bbe3eca3f1f760c0b0f851a2bd1d65213d384202a719b56a19

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page