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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for atolopko-czi from gravatar.com atolopko-czi Avatar for bkmartinjr from gravatar.com bkmartinjr Avatar for johnkerl-tiledb from gravatar.com johnkerl-tiledb Avatar for mlin from gravatar.com mlin Avatar for nguyenv from gravatar.com nguyenv

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for atolopko-czi from gravatar.com atolopko-czi Avatar for bkmartinjr from gravatar.com bkmartinjr Avatar for johnkerl-tiledb from gravatar.com johnkerl-tiledb Avatar for mlin from gravatar.com mlin Avatar for nguyenv from gravatar.com nguyenv

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.15.0rc3 pre-release

1.15.0rc2 pre-release

1.15.0rc1 pre-release yanked

Reason this release was yanked:

pip allowed an rc anndata dependency to be included, which was unfortunate

1.15.0rc0 pre-release yanked

Reason this release was yanked:

Relese has post-tag failures

1.14.5

1.14.4

1.14.3

1.14.2

1.14.2rc0 pre-release

1.14.1

1.14.0 yanked

Reason this release was yanked:

Broken release; 1.14.1 upcoming

1.13.1

1.13.1rc0 pre-release

1.13.0

1.13.0rc0 pre-release

1.12.3

1.12.2

1.12.1

1.12.0

1.11.4

1.10.2

This version

1.9.5

1.8.1

1.7.3

1.6.2

1.5.3

1.4.4

1.3.0

1.2.5

1.1.1

1.0.1

1.0.0

0.1.22

0.1.21

0.1.20 yanked

Reason this release was yanked:

This was tagged on the wrong branch. Do not use.

0.1.19

0.1.18

0.1.17

0.1.16

0.1.15

0.1.14

0.1.13

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.9.5.tar.gz (278.4 kB view details)

Uploaded Source

Built Distributions

tiledbsoma-1.9.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.5 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.9.5-cp311-cp311-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.11 macOS 11.0+ x86-64

tiledbsoma-1.9.5-cp311-cp311-macosx_11_0_arm64.whl (21.3 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

tiledbsoma-1.9.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.5 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.9.5-cp310-cp310-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

tiledbsoma-1.9.5-cp310-cp310-macosx_11_0_arm64.whl (21.3 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

tiledbsoma-1.9.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.5 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.9.5-cp39-cp39-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

tiledbsoma-1.9.5-cp39-cp39-macosx_11_0_arm64.whl (21.3 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

tiledbsoma-1.9.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.5 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.9.5-cp38-cp38-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.8 macOS 11.0+ x86-64

tiledbsoma-1.9.5-cp38-cp38-macosx_11_0_arm64.whl (21.3 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: tiledbsoma-1.9.5.tar.gz
  • Upload date:
  • Size: 278.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for tiledbsoma-1.9.5.tar.gz
Algorithm Hash digest
SHA256 f9706ba6a51f820b03b2afdd8737c0c937805ae10ad0d15f407f6a80cc3a5649
MD5 70a30c57163611ee1edd2eab09439fe4
BLAKE2b-256 440118bae328a1bd22c4d9c0d527701a186234e8691d557d57748b6a592bd4c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 496e42ec75a735914ca0827af80b43ed398709fd4df9e81360df2090d4a90a8b
MD5 6c28c7c532d99eb61061f51443c73cc7
BLAKE2b-256 2477017e7efafe4955522276848b59c1d25f8e33e4b489e349fd3ba300a19b61

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.9.5-cp311-cp311-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5939420924878e05c3d5d95e0d66cebd926ec65952ac699f94788fcd84acf9cc
MD5 3f3695993d73c2cac4ea26ca4c51bfbc
BLAKE2b-256 b8821a9cdfccc3629943601e9619d1643196c7c52eb374173ab104f0d7a1895e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c9c28affb5cf29d6387896a2f48818d1d836122eab1a701842c6f2de3c11e8f5
MD5 e271d37b8d70910a60f2efb832f47818
BLAKE2b-256 eb8084fc028ef5c7391e7f631ad6bb0ceafb8dae619f59aae0b0abbf16748edc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 375bcc3269b0958c47c1fd7533ce4c38ae7d4cf793033b8326178ca15c83dd16
MD5 03accd0d8877d1cd7dbc5247d8108436
BLAKE2b-256 2c1a26817ae2e0019d166cdb921b06fed359ad443ac9006c63e304ee2cebd55f

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.9.5-cp310-cp310-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 8f5535addd8abd7318f8bd91ab2e8d6528d55825b6affbc10769a508de24f7af
MD5 db612b2187f2df315971b4594aa32382
BLAKE2b-256 ff1f37bc18fac775862ea6c56152b24076dd7d1a541777920e629ae3962cc895

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f9b8389945e51d56b9826347e9266fd6268fe94cad83f539fb7865a4758ff85a
MD5 1abaaf7fdc6660ccaaa4c5f8966a08af
BLAKE2b-256 889f465bf8d193db2386b6866274e2de3f852ad8ece2f98785bb33dba12a81ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 50d4a2796368252679e8431295bbe91baaa404fa56d797764abde2851bf70d32
MD5 5c7169862f297629d89a684fd14c689d
BLAKE2b-256 a97d57f6f1d30a86eab07fd20cbcd6c85e540e7c51a86ea2b9ba713af3f0647e

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.9.5-cp39-cp39-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 cc8115152d07c4fdb7f43db670511254a8c7790588839ccd4f2b0a9be62b219e
MD5 9993e76b28f991d0078b552eeb976f34
BLAKE2b-256 309325cca21f4f8eb310b3dfbbe0f2f96c6b1575f3d73a099ae3d4e1a44560c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 11b85ff1bf677d1c8cd3117e26e504b70be5a9405df0c75d2574b12dcd6c9223
MD5 f537500375c62d7c50f0b53732622920
BLAKE2b-256 5acdc302973e5afea6e337874d71f014637a369939a174d3ff3c3039ebc49ec4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0725ca57bb41640ab5f485482659dea38731ce2c3312038b2c35f6f756064baf
MD5 78449da43712f144b1e66ad8abf685d3
BLAKE2b-256 1df59974231cd9b26efb2a5429ba1657fc7bc9adbec6a4787df7fc42e9a8845c

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.9.5-cp38-cp38-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 7184e24d2b0d5bd00d4a8e9458440a478629cbdbb0861300c5ed3859045f5a7e
MD5 bf6633a3873fb770ec4cad9a7a272978
BLAKE2b-256 bf20087ff1ced1aedd412b3b0581a4f6016ea5d5f47c30aba1819b1c0997f802

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.9.5-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 78927daca4935f22bfc506989d1312e9e619774f0485624201c20d7858024a2d
MD5 6742f674450b4ffa23204737f4014a93
BLAKE2b-256 741118e5da06d4823e8020acba2c8ee9c16b1a50e594deb3c31ed2ba3ec38ef1

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