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

1.8.1

1.7.3

1.6.2

1.5.3

This version

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

Uploaded Source

Built Distributions

tiledbsoma-1.4.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.4.4-cp311-cp311-macosx_11_0_arm64.whl (8.7 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

tiledbsoma-1.4.4-cp311-cp311-macosx_10_14_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.11 macOS 10.14+ x86-64

tiledbsoma-1.4.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.4.4-cp310-cp310-macosx_11_0_arm64.whl (8.7 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

tiledbsoma-1.4.4-cp310-cp310-macosx_10_14_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.10 macOS 10.14+ x86-64

tiledbsoma-1.4.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.4.4-cp39-cp39-macosx_11_0_arm64.whl (8.7 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

tiledbsoma-1.4.4-cp39-cp39-macosx_10_14_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.9 macOS 10.14+ x86-64

tiledbsoma-1.4.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.1 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.4.4-cp38-cp38-macosx_11_0_arm64.whl (8.7 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

tiledbsoma-1.4.4-cp38-cp38-macosx_10_14_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.8 macOS 10.14+ x86-64

tiledbsoma-1.4.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.1 MB view details)

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

tiledbsoma-1.4.4-cp37-cp37m-macosx_10_14_x86_64.whl (11.1 MB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

File details

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

File metadata

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

File hashes

Hashes for tiledbsoma-1.4.4.tar.gz
Algorithm Hash digest
SHA256 6a22d17b4769b00c5a3431307488c92fd81aa693c20a998938d57326dae8fa01
MD5 3a6fbdb2ec23435d06f9a5db4dd67b4d
BLAKE2b-256 14efb21f0c7477c22a8a66e35a7d750f0bf0876073f40349bcb8e148daff2afc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b77c5ed465c01b08e8205ee4d5007791d4dee736f14ecc83f63084612baba03a
MD5 f5f38d3595e89ed69464f5304e7d4ca5
BLAKE2b-256 688ebc159104e412e2d229fde775f93b5c201c7f06f8f61879657c61ea7ad6e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9ee13aa177dd479bfb714c64abcae203cdea342fff771dacebdd9bd2ba942211
MD5 9e3878140d853801108b63666c168c1b
BLAKE2b-256 9978a39600466bb396efe268daf1baed57c78ea0782d56b11d3549cfbbf7db5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 569d338db276635303d70d6dda9d264017ce3f95470cf2d471015d70c0e06fd7
MD5 7e62fdf8ce7c20c5833d760e082fcaab
BLAKE2b-256 88d7ac5eafa37a14f388dd8b10e214f06b824d446bdee7343b6880108fe08042

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 48f4eca5b0b161112aae880f1f5d8dde3eebb141b0ed8ee5b78b8f074407428d
MD5 f3596cc4c789accb1248233f0ebd3571
BLAKE2b-256 68b94547fc083d8bb6192299b3b7491f4e1c14e530c8a1fb8d7d49a603e446dd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4e41f4036583d9ae3ffcea249f5a195cb5b9d42d343d089a8e35ac69af3e2227
MD5 137fb5450dbc45a6cc114231e9e43f0f
BLAKE2b-256 3722fbbb9cfd8a77e43de93b7c7df94e2cc0ebfcf44ecc7570bc3661479293b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 31b938ba3da4a4bbcdfe18e34352e846bbc10db386c52aac16ce586eb7721067
MD5 fd8e44f047fb1ec603c584bfb4b689f6
BLAKE2b-256 682c2b86ffdd0a3229c624735f483a6cdd9a8f09dc0f77053353169c4dfcd08a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e922423907009fb4d0c376982b2ff97a0ae5d419ac3b951210a4de26274224a4
MD5 0a095b0a0ec4577c0b5724aec22eac58
BLAKE2b-256 157ed7380cd81055593b542b215a022bce58fe138df15a8db74ea897a13e5d17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 61b7dc58053ada9f6c7dc9b8992eef9d6ad666f0375c7079f9f2ac6c11c9ea33
MD5 f58e067850814be7e23aef0b8a736dcc
BLAKE2b-256 a3b5640009279e1a373e154002f5778bc3fd37d25b131b2e3731599b14064046

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 f5de00909ff8d950aab645b1886be83ba2fb5c21d0d774bbdf47b9d37e9563cb
MD5 e714cdb43a4612b60582623d356b4387
BLAKE2b-256 2f53b0264a0c7a6261f93f2ac2c766912422aad8905e4a8fa82c67fed3b8022b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cdc2cf55e63ad892d59c280cf39847d18b51de92c7e3cd378a19483cf7ff13e7
MD5 8d4095613457632534b1a687c2d6614c
BLAKE2b-256 d3f2c62b9f13337c25e715f403abc2e8d0f3d50756a3f9e6b7034594d779b013

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 360c02b76d8bf085b3f6484f0ba0a956a80756e085fc2ab82dd44f984cb482cf
MD5 5dfe6b9f87fa1602e75674e0b283b6ee
BLAKE2b-256 02d38a12cc25a4cb8989f2f963b384167063c7ef0262636d08a2909ba5376ad5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 f7042791c27f37e14483f33af10a81ba0de421c4b5c4c3b15bb7949ebc75fdb5
MD5 ac218ce84155ba891dfae4776f8b3502
BLAKE2b-256 7104f25d86c0b7defda3921a90f51fef1cc1cc3d98ebd7ea340a6629bcaa3079

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5e87abd4af98cfa94e7cdf6676aff286ed7c6a0e7db8e7a0298e1eae64060e1f
MD5 abedbb8ead5a5454541ad9f350a33899
BLAKE2b-256 5116d3bb558d6066a7a643c52d2b98f15ed920d29a068061738f23465867c2b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.4.4-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 e012fdd3a7890e75cda0658b2f2129e5afe69e38a61aecd72c63a59407cb739b
MD5 9f499e330b2bf2f5d60688520b033ef8
BLAKE2b-256 95ad03788438b86cf8adecd45e72b0b7f6dcd41c1a38f1407c543c5267a9e119

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