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.6.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8953f9edbbedc699472e775a147ce83141b4432dc149310a005d292c1ffee6ce |
|
MD5 | a03166f9da72805a0faf66b5f2d1817d |
|
BLAKE2b-256 | e60958e8653fb250b3971f4f503ae29511bf367b1a7a7f07c4484a1dc1ca9a14 |
Hashes for tiledbsoma-1.6.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ee43d7717e8317c077fd9041c4961ca36bf51200defc506913e80e84d32e042 |
|
MD5 | 2b6b3f3014cd473c61d3690ae13afc1b |
|
BLAKE2b-256 | 707e189b16a677086c590080fa682599e2767dbe217d34ee80ec8efdd4082693 |
Hashes for tiledbsoma-1.6.0-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea99d7b5c2935f6f17602d1a77a716657cfaeac1075488563bee94a0ce8131de |
|
MD5 | 6971616fbe9fd02fa26debf820e8ec8e |
|
BLAKE2b-256 | ff560daebb40af364a6e7ed3d31e0546985df914812c2359139b682922ef5608 |
Hashes for tiledbsoma-1.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4e8f0084e50af585278019c936160da24f84c6db7acbbb87e60d1375db700f9 |
|
MD5 | dff69b55f4ceb5e9d668aa2b3a5c5619 |
|
BLAKE2b-256 | abcd30b1dd15f432daba1435c48f8d9f0b6dbd45ec0e59dd2fa36193708387f4 |
Hashes for tiledbsoma-1.6.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0d721c3727ea5db07ed0ff3c4946683a48cf1a3165cf715d747b36ff4eaf042 |
|
MD5 | c41d69874f3455b12a50e5a2b3593ce1 |
|
BLAKE2b-256 | 386cd05f53896e74d37527cb9310f19364a98212adc852926203792e85d3fb13 |
Hashes for tiledbsoma-1.6.0-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab5f36d15c701f9a863d2277e086609b6c278748a3acd65251e9dc6d068e98c6 |
|
MD5 | a634d4d408fa72a4280b1291d952f970 |
|
BLAKE2b-256 | 09a0aa0b044e24f2f56b2a187f4ec56f1231a20b0e5e0ca622af818ba3f4bc06 |
Hashes for tiledbsoma-1.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d14b273f40a6d2592203871a01b59c7721244162a82f1edbdf2a7428df94c1fa |
|
MD5 | ad411be29954cfa24953516d5c469238 |
|
BLAKE2b-256 | 5a5a2a5efd3de79322a13e1fa3d77434b04a51ad74d313114e6b46407692f62f |
Hashes for tiledbsoma-1.6.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26782393bc3293397df8db2c274d84c9756ef7d74aaac73b762054934d79d125 |
|
MD5 | 59a735921bf27fb4341d64666e148560 |
|
BLAKE2b-256 | 6984bef1be9f63c73fa463785fd996a06f4596d5f46f9266ec0e49a5f7d78a23 |
Hashes for tiledbsoma-1.6.0-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f0fdf2e56135ddf97769d92d0ee184104b91e2b8aea802b8a130b6d69ee87eb |
|
MD5 | 2b006ee833829fd873b0e05df620588d |
|
BLAKE2b-256 | 9c39d148cb58504d3981bbfa9e4d3c350126461955ff2521f7c9f90b5b8aa470 |
Hashes for tiledbsoma-1.6.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de2516cb03a9fa837e2515e8e5c808778e173c400d84848cb70aa89c288704d4 |
|
MD5 | ebbf33e8887ac31d610a5b932f94ddc5 |
|
BLAKE2b-256 | a0eaee9aa79922f1892e64ad1afc7e83fd51b3dac4c406d54b9ec6784a31a510 |
Hashes for tiledbsoma-1.6.0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b5403a2975f4563e46dd28c4738b22acd624b06a48a72c331727a10b4735d98 |
|
MD5 | e99beb7ce9ff3e47855790a5d80c072d |
|
BLAKE2b-256 | 8cbd62ebd2e4afaf92fd04dc59e4e529c11964f3df9cf61f35f62ff5acce9d93 |
Hashes for tiledbsoma-1.6.0-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48569099307e2d7003d87bc538002964b23cb40cba7203680a45617dc6230aba |
|
MD5 | f0570e32ab00e87e751c99bcb7c4feef |
|
BLAKE2b-256 | af5f89e1251d89a7b7574892ef75bdf51fdf66422a7c72ad7e093e60d8e80c43 |
Hashes for tiledbsoma-1.6.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 094aa5418cf08396dce667ce096e4e50dd4302752b5236917d0d9bf5e89963be |
|
MD5 | 78195ee024541d036d310098ca3e54f8 |
|
BLAKE2b-256 | c5c8342ca9ca360bdff2fe7e52ffa762840d3a446b3d86c74b4255cd80f8da16 |
Hashes for tiledbsoma-1.6.0-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 682fe4a6fe0d9a158abc56962987eb82bdd590d2e9e07b42176c4ba864b70276 |
|
MD5 | 2919b14025988d045da56fb84c66add3 |
|
BLAKE2b-256 | 376fd462e864bc0c3b06bcfbec741b480e1fc48be5ed120546498131b286290e |