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

This version

1.10.2

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

Uploaded Source

Built Distributions

tiledbsoma-1.10.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.7 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_x86_64.whl (24.4 MB view details)

Uploaded CPython 3.11 macOS 11.0+ x86-64

tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_arm64.whl (21.6 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

tiledbsoma-1.10.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.7 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_x86_64.whl (24.4 MB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_arm64.whl (21.6 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

tiledbsoma-1.10.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.7 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_x86_64.whl (24.4 MB view details)

Uploaded CPython 3.9 macOS 11.0+ x86-64

tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_arm64.whl (21.6 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

tiledbsoma-1.10.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.7 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_x86_64.whl (24.4 MB view details)

Uploaded CPython 3.8 macOS 11.0+ x86-64

tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_arm64.whl (21.6 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: tiledbsoma-1.10.2.tar.gz
  • Upload date:
  • Size: 280.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.10.2.tar.gz
Algorithm Hash digest
SHA256 1aa1285df7b2dc3bcac3bd57ae1cf8cd9f3740fe2daa69661ddc9d169d143534
MD5 59fbc9b5d6650ad0dfcb00a6912b8c52
BLAKE2b-256 3daeaef91ec28f4c887ddd2e68c893e72969518675cdca254846d19f285b92a9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 25cf9a9b6fd4c5bc729130264e326e61247978976616415fd5ac6801c823d98a
MD5 574640165c387488f9f13da1dd88d8df
BLAKE2b-256 d72866cf3cdcc55f4805b3e56802b7aba1bd61dec6577a29016d07c2808dff9b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 49698bbf1ffef6ec811606c091213dbc05230c08a1d2823c257c495765cd5f65
MD5 06f907498f6b77267ae2f70f78a1efcd
BLAKE2b-256 b41be543ba0de5a2532739ea6dd0271f30df4db84a6125feb2335d48b1b3dbbe

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3e53efe8469d98754fbec12d1bdf9ccdcd7c6325d6d76939458deb5e0a243132
MD5 7219bf4fcb3c95d18b78c20b97895f44
BLAKE2b-256 c78048db7719797dc9bb2a4abea055860bb54d1fb16476c4c597e0d8dfbed8b5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3dfe40600f4421893076875223b477756ab21df6f87c929758e0efca02c997e0
MD5 60b88d8a231859150ac5018537237d85
BLAKE2b-256 4a53fefbe8694b5c45cf2245088e6fccd7e5f14eba54144aea37bedcf7ff9b85

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 52019f3e825d09a30eb329c68a38aa2b7e810b3b99792b358293d82de0e904bd
MD5 722972f404b869fe07f1c071ebf2ed16
BLAKE2b-256 0e21f3bde3d218d55eda311437b805295cd42789ce581e997cdc4b3b4196b6f4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f57b7b180cadce2fa9694a82968532deb7a63ddfa7b33a6bc5ae58f855cb83c6
MD5 f8b0bdcfd640bbd09c658792c47c2244
BLAKE2b-256 56ac2a8fbe87d4edcf3236203901111fe3c193ae977a1fb858a513e3b2e5ce95

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2389b96aac301ed488aa16bc4fcfcc453baffa44f7b55c55648931744ad699ac
MD5 84d32dd7b6dfe92b146184673cb25bdb
BLAKE2b-256 341eb833201bfb2b737f1b6bdc079f426b3efec8b6afabe918f20226eccdaaaa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 5edfb27c20ea280d73edcc8e10596ff6fa09f8b9390d2d29f871945972ed9fa5
MD5 301d61b2e15179c36d4db4bd4a58f64b
BLAKE2b-256 5e9319a90d814bf6780950aa8f834170333b6074bfa9fd82b6c95c5ee8891b2c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d36d5fc75c69309cceb6182dae72562ac90f4565bf9683921b1b4d4eea55918d
MD5 17b00c316dc67890d38e0e8e7cf68b07
BLAKE2b-256 18d42e8e74e00e0f99272d375beed9634eca570f18d2d39f73a67b13aea7ffd7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 42b0ee36de6bdb24e9a65353d7cfaab0b6d149216b8a40510e0a714e0dc8e456
MD5 e1c82f1e9da2ac824febfdfa8b7a7102
BLAKE2b-256 091188ab72a1ed7b910c427e1b4c4d70561c9e9d93169c611bb4cc1a861c0e55

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 c743a78f5b9ec6eb2f663e77657aa8135a9d6f79d0fbb761f9b9b329e8347160
MD5 d4248b9111fc95a9f12b3a465003798b
BLAKE2b-256 b31d0741b83120a794cca7628ee2a5f08f59bc9ef5d7be2a2383730b9d92ffcb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9f7b056712e5b23ccbad9039fe677adecdced544c07052f780b2a281fa64deb8
MD5 41dcac9a756db172be33e9ee72cad7b5
BLAKE2b-256 e900299c195990afe4fb61c98b773ed8c9dad812ed636110dc22883b1ffb8e44

See more details on using hashes here.

Provenance

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