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 thencd 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 variablesTILEDB_PATH
andTILEDBSOMA_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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for tiledbsoma-1.9.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62f485f85b05a1aa2ce150ca2f009b72f4d20b437a53d60f16772cd25530c2e3 |
|
MD5 | 284b23f115c2402dc122c3d7905b9ae3 |
|
BLAKE2b-256 | 66689b27e9d7903f1515188af59d65b290b3f41768adc9f44ceba740a5f04f86 |
Hashes for tiledbsoma-1.9.3-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bb07881ece7b05d12df50b34c044bd803f138fe0f09a65d4692663320b4f1eb |
|
MD5 | 83e5dc09a97253c222456393ee1a1d6f |
|
BLAKE2b-256 | b4f64c914b01c8e5dbcaf68a78937ecf8e62de01a4243939650569c9f35697cf |
Hashes for tiledbsoma-1.9.3-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aab7d4db7a6df951c25724070451043597562a08696b0fe0b83f224e84eedaf5 |
|
MD5 | c151629d06f2c6fd11ee535ff2499092 |
|
BLAKE2b-256 | 27c4696dc15051cf993888532170074a43e3fb2276c6effa24e8272b75319821 |
Hashes for tiledbsoma-1.9.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eeb656aa949f7ed564c75f2c4e1dd007b9e22fd6cdb2b6b6b58fa1bab81a9f8b |
|
MD5 | 6360409a9c0a842d92953e40153c8d2b |
|
BLAKE2b-256 | 0c76356cf72536d4c50ea24d4462ed87eaf79904cf70fc2082fe445beea0b8e4 |
Hashes for tiledbsoma-1.9.3-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa1b67ed0ad2152d383fff69f5bebcb218dd4842ca45e170b0725679d76b33b1 |
|
MD5 | 6cd93e9844dc848f69ed27faa843e283 |
|
BLAKE2b-256 | ba674b7cb97c64d4459489f21854c3402e6ba84351307e35240a83c9767c71e5 |
Hashes for tiledbsoma-1.9.3-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfbe25cff26e4363eda398a118df9c59a2b9d1e74b598551525aac3e4b599da2 |
|
MD5 | d15055aca6693fa536acd42fbab74a54 |
|
BLAKE2b-256 | e64169900982fe0e9c14d4bcfacf7a112dbf34401b27caf1984c384130ad08e7 |
Hashes for tiledbsoma-1.9.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7251bdfac54bdfbffbabf363da47e0866cb24b266ef6a30f2170e3af99903ff4 |
|
MD5 | 055c2059b0ba2603302ee72299da087e |
|
BLAKE2b-256 | 3cfa35168a65566fd97c5ca6d9b58f3f4f405b1ff30a0ed8c9223253762996ac |
Hashes for tiledbsoma-1.9.3-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 230ba2c5b2dce451cf0e2fc8e33604a8514faefb075f33079b36189ad025efe8 |
|
MD5 | 39def3c0073b4b9ef01ec60392741b89 |
|
BLAKE2b-256 | 304ae3bb8505d2ea388f16704e8e330392651d1d807d0df1c3198a0e4a125910 |
Hashes for tiledbsoma-1.9.3-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 953ac7600eb020e7553aa60238ce47a27a8344b5afd24afa0f80cd254bf537c2 |
|
MD5 | 52eb3b858fa82ffe7302d42bce81b9d2 |
|
BLAKE2b-256 | 0c79c32b75d256a9a94e36519b7dcb5ed0c2c31d2da52aff92c2750f82b9e806 |
Hashes for tiledbsoma-1.9.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b757ff10a8e9d7d6ac026268cd6b9a545313af436b607f0bccae0efe10c8d37 |
|
MD5 | dfb2c24e228f368cbf3e555eeac45a69 |
|
BLAKE2b-256 | 129ddf08c2fe80599b6dd7f3633ec1bc59422055a45012ea9ec0998c054733d3 |
Hashes for tiledbsoma-1.9.3-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f99f007eff6da7e2ddbf52b7631694bd9d7c264261542b125e9fd7b1f76f9fa5 |
|
MD5 | e70a417e9a03ed45212391a5dfefd18a |
|
BLAKE2b-256 | 1792141c341c0a42f81a2ddc0ea14d28bb864778b817b2e4f44eef07390cd768 |
Hashes for tiledbsoma-1.9.3-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c84f81eb356889d364ed748f3c33585fdc95d5a87a0b7d83730dc016b07889fd |
|
MD5 | e3993a4dc65da1abbb9be19be696995d |
|
BLAKE2b-256 | 31ac2cda5af9247ef35aaa9d537f0701262dd771db97e1cffdddacd05dacb5d0 |