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

1.9.5

This version

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

Uploaded Source

Built Distributions

tiledbsoma-1.8.1-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.8.1-cp311-cp311-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.11 macOS 11.0+ x86-64

tiledbsoma-1.8.1-cp311-cp311-macosx_11_0_arm64.whl (21.4 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

tiledbsoma-1.8.1-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.8.1-cp310-cp310-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

tiledbsoma-1.8.1-cp310-cp310-macosx_11_0_arm64.whl (21.4 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

tiledbsoma-1.8.1-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.8.1-cp39-cp39-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

tiledbsoma-1.8.1-cp39-cp39-macosx_11_0_arm64.whl (21.4 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

tiledbsoma-1.8.1-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.8.1-cp38-cp38-macosx_11_0_x86_64.whl (24.1 MB view details)

Uploaded CPython 3.8 macOS 11.0+ x86-64

tiledbsoma-1.8.1-cp38-cp38-macosx_11_0_arm64.whl (21.4 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

File details

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

File metadata

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

File hashes

Hashes for tiledbsoma-1.8.1.tar.gz
Algorithm Hash digest
SHA256 6088c589c769cdb3a97002744f71239c28c26c1507d74efbef76403d370a1d42
MD5 e270514e7c953204ccda5398cb270694
BLAKE2b-256 bacb4cc7be0ce447261a3b8e3da823d79605bfe4f30ac1e8581a6d3f9d73dd7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0c48cf42385d8ee391402806b1572ba679d9dd4331dee2301d09b50960e344e6
MD5 5a811ca2637b04a7a3b860abfae313fe
BLAKE2b-256 33de980fa01421e0906cd7f7694ab104a51bb6f71e7f838c1fdac9e62f7a5208

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 14630b34b0b69b870bfde76f72a5c695182794a848524ce3ef6cf5e8d2c3c9d2
MD5 5901fea8fe5667fec3ce12adc420ea04
BLAKE2b-256 fad366f878ed8a5541dea9530a79207b2e1a7e1aa26de1bafea963ab68d95125

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f3518cdfd1568bce1fe1e5c934e8000eeb93e7bffc9129e39aa64ba1138490c4
MD5 0a5ab63ab7f1f1c000e66fe5712427ef
BLAKE2b-256 a1ce272707282e618b74708c59f29955c80f504aef49a3f26005153fe6a14419

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5bb0f9041510bc1f97948c70017f4f5d1fcf62706eccf3ffce3ac256a87a4349
MD5 f284a3c2eacce596b0b0024adf87d285
BLAKE2b-256 3b3bb1a9c4291e15389b483dc33ba4167da6877c68d7e8450b5d8bc832a48cb7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 6579960e202502de997794342127c4919fd934ca39e7dbc2ff38fe9e95743e28
MD5 3e422b087109dbf5e17eb3efb7845a28
BLAKE2b-256 69d2b1a390e404fb4889043b65bacdfbe3c893ea975e5b1c609a61e08f6c8940

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a1f9ef7312343d49a79be13fe3c421275bf8f5b1a7a14ed11f16f1e6ac723ff9
MD5 43abfe9dae8ebfd887479d8f5e443c07
BLAKE2b-256 570764a23f50e151371c4f95596ac8c006c758f0b78d0cf921072dc428425537

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8e66d2c84c27a999f7398157ff29e5ac13cc90dd6eb2f836ac2956065215fede
MD5 7c3d5a671d229cf3ad30bffa0008fc70
BLAKE2b-256 ad199ad18dee5c706f3f94b35099175023284e0b9beabc645b5682e512ecf387

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 d248c5864a3022bbbc66b5de6d0d0b86d62f95ff7a765b0163e26362b329ca61
MD5 7dd466e99d732dd7975c1486c5fa3778
BLAKE2b-256 3b495ded59c0f1951c11d16634e0596abfa51b4a099bf1c934713c27f3126ba1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0fe3190d3da23ca055481b9ef6d575ddb47ddb0044353371265800952e004e5d
MD5 a8ffe68afef686c92afc67230378f8d0
BLAKE2b-256 383d434a376b34188153ad1ba8fd3d62f3b7f1276556a074c989610e381e0e7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 f6197ef2a5cf21b5a8732d242ed96b3f8c70a538c6af2c5cdb62e1adb6da4841
MD5 4a1fe5f667f69f8a42ca9be9fc0f86ea
BLAKE2b-256 7db218fae358be2e31d9bbd023369fbad2afbd5f1da4f951220eac7c3b7d12b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 fd363391e7c97d877d5be86b5370abda2cadf5a75f214392bbe81f54c1d580ff
MD5 94515ad3dcead26e835d283ffbd5352c
BLAKE2b-256 146bd254acc8c5ae93fc5077076322f897de5a486d8c052416ab9d27cd8e4e2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.8.1-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7bf23a245d6618394874ba8dc4dcdb6ab605f58a051a2da19a55232bc8205f06
MD5 39605d3d808f3d9e6ff776e3bbbb281f
BLAKE2b-256 500a9eb270ad860dd79f794fe6db4ca393e4449b930c9821335b5091dcf08570

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