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.10.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd0f192d75954bd4fcb4eb752c54c8ec6ef82b759ab449335f679ddd508af102 |
|
MD5 | 3004d2a33d8846af02d7b44ce07b6cca |
|
BLAKE2b-256 | a4a3bd9c33b2be800d3a00eb2e5e96bb94d975f60f2a7432adfd112d19005fcb |
Hashes for tiledbsoma-1.10.1-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac764d88df8077bfbb58c58f6faa9f88ab7fbf9cfbff812758884843aa696713 |
|
MD5 | 6b743c6380531998b4ea09720881f48c |
|
BLAKE2b-256 | 8a0cc433dd9796a9599aade472c30b089cf6059a4f55620592a0504dcc8d84c8 |
Hashes for tiledbsoma-1.10.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f52b2c43c234c254e92fd8853733c73c8021a563173217adfd8357c8b035b0d |
|
MD5 | 1c70b1347f8e7d6e33cd7ce36fc870a3 |
|
BLAKE2b-256 | 2f98a5714b5b88aeef0734c268cb741edc1fbf88c1b156d662729da644f44971 |
Hashes for tiledbsoma-1.10.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2f5b5c3f2586eff9e5455e391d578fbe0ece413df47fc1489c6d74bd165f795 |
|
MD5 | 20f0c32fbb133a5e7a5c97d1583030ed |
|
BLAKE2b-256 | ffd207a3a32760bc44116cec72dbdd91b18767a6b355b56194f737fc2fec2b2c |
Hashes for tiledbsoma-1.10.1-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | caa8f2de883909e8e5eeb0736cab7513652d25de675b25585b0c04b0e95ec7cc |
|
MD5 | ec81c220867a1bc9dbe0dc10b3f3d1b6 |
|
BLAKE2b-256 | a338471d1e8a9554245e4504850c281a9e4b41b510de191ee3abc18debde1c9a |
Hashes for tiledbsoma-1.10.1-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 133f6f5e957282f1f56ba6b8f230a24eb93157cea38d40ec6afa31c504a47081 |
|
MD5 | 5e146ce468e085938bbbedf6f3590f03 |
|
BLAKE2b-256 | c1ca7637c76b3786af5db6f0abe4834dac785f7cefd6e86f7a21b6d2101cc03b |
Hashes for tiledbsoma-1.10.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eefcf2a20f7647a3a30d1eb96490f1af2791ccaeb1fed5a93c0bf05f35008751 |
|
MD5 | d3a82ab1380748220076ff7b25be6f8a |
|
BLAKE2b-256 | cddfee49b3470118fe2640cfb837290ce529947e7aa9e5867b7f6b1ada4857a2 |
Hashes for tiledbsoma-1.10.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54fdce62cf9c3dc08722f3e1145cd003af204bada8562f748980cae80d33b31b |
|
MD5 | 2081d17592cc7d8e6bd783ca3ba43d8c |
|
BLAKE2b-256 | cb1bdaceef1aede89fccc501a04ffccfb4fd3e375d313fc58edebb63f74f2e4e |
Hashes for tiledbsoma-1.10.1-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 733be0a5116ab8a46bac0e561c74f058d8ca2055e5c35bb1065a4c9e7fa40af4 |
|
MD5 | 0770225dae5bfaffdec09c5f95891d1a |
|
BLAKE2b-256 | 10e4b5abe505009a478c5ce82711bd6bb01053863b3a5696be54141669e2722f |
Hashes for tiledbsoma-1.10.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce2b1bfe483e43055aba7351a92376e9c57e08e9e9da2cf1c1af640eb68e715e |
|
MD5 | 9775b38555827dd2cce9a52891406647 |
|
BLAKE2b-256 | 3123434104bb75fe8a987b4330ec3f3766a0a7c8f93a01f1aee8450dd5921c6d |
Hashes for tiledbsoma-1.10.1-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 327df52f9ce6b8488eaf8ad2bac266b71eb8a857f7127bacc3db51ae750a322c |
|
MD5 | ddee3581247889091f4eb6fa24d5202d |
|
BLAKE2b-256 | 1a59a6e39709695c4abfceebe092cfa2d5f6cd46c74618ee3e793462de6df5f2 |
Hashes for tiledbsoma-1.10.1-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | deec26aad626e4379c0d00db5b70b80846d4661e293e6fdfe9f85fa5b13cefbb |
|
MD5 | b73e6e3a23f3a0051e9a3a73eb43ac8f |
|
BLAKE2b-256 | 697b1f6e04e1fbef2c273382edc2c0234df09608d778752656f28215f09d2a88 |