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.11.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95911fff5125acb88119664145e715acf04305f6eeddab005f961b15d1bfc21a |
|
MD5 | da8d69de55117710dc98d668defe6b26 |
|
BLAKE2b-256 | 8c8336f21a8b18e8a15a4d0b80c5404edc280c0743eb359b96c49bb9003ee77c |
Hashes for tiledbsoma-1.11.3-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9a66aa1dd046e7891f9f17af7ed0b667e067d16a68ea13dfd33a841c2b7da2c |
|
MD5 | 128d976a18cb344e8e73e269322c7b66 |
|
BLAKE2b-256 | d2691e2def4d9f70435a1a2fba7707d5bf7235d6253297b0da24aeb597b40129 |
Hashes for tiledbsoma-1.11.3-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b72acc6b9ecc18713160093eeb613fab7fe439a36e5410f59fe03320a9cd7c5 |
|
MD5 | 2a252531935ad142b73d71df691e23a3 |
|
BLAKE2b-256 | 14537f648df72ce1a4161cde44e9fa18b5f0da1af581ed080109db0e018739a0 |
Hashes for tiledbsoma-1.11.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc4017a1f5a50f602e733f7b4cbfbfa8c30c8cf0ab47de45cd4b11d87beb6f1d |
|
MD5 | 6100579e10652c7f1710367c50051041 |
|
BLAKE2b-256 | e12dfcba6edf727fa23748d9bc0f2d4b4bdc3b8e48622114461788d7aab12e0d |
Hashes for tiledbsoma-1.11.3-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 589d980fe76b4351bd24343f4a833d0dbd06cc30fe77e0f1342d985c0abca1f3 |
|
MD5 | e76f8bf30a80c84c974115da485606aa |
|
BLAKE2b-256 | 0f2fb878ff688973b6a1311e2453d145c256c6c6d985cd4950bf1073aac2da84 |
Hashes for tiledbsoma-1.11.3-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2f77c307b0a04612e0d0f2ef1b1b61d7b24451de73af133e3de710e7a9955d0 |
|
MD5 | 6576f08fd049f072106b6cb4d5271b89 |
|
BLAKE2b-256 | e8bf8b4fb8d7c02744a8eb8d36969ca9e84fb57756ab3459832ccb2750e1d91d |
Hashes for tiledbsoma-1.11.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bdd891bc291a6fccf99a353a4620e3bd3ba493418134fd9e465c0aa72fd5393 |
|
MD5 | b95d81d0db0769fccb5a70acb86e6bdd |
|
BLAKE2b-256 | 702200ecc0d70f2dd7396c539d26066bfd98abd9079daa8ea01f0cf4705a9b3f |
Hashes for tiledbsoma-1.11.3-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 682bba6257aceb814c2f48f732060878ebb95bc2ccb12b9d928714946f9e260d |
|
MD5 | fcf884e91f613a2b14f78b3b919b931e |
|
BLAKE2b-256 | be882bc9e90a7dcb8bb3677cb6a9a0600c2acd6d9cad38a85655d3e8b15ffc63 |
Hashes for tiledbsoma-1.11.3-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a981f13048f9be86b23001c1cca57c2597a2aeb28214969cfa6f80e864c1702e |
|
MD5 | 9e9b520c8e5aee93295a4f4fab65423c |
|
BLAKE2b-256 | 04978ce94074cf6d5e819368b76ea0d7f834f6c462f0ce412bcfa2fcfdea5ee0 |
Hashes for tiledbsoma-1.11.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4546b14a99e42096489a83ddb580304d3616d08e5c36757cc1405133839d2537 |
|
MD5 | 5af2aea1f73e3ca2a85dd4a3cb605748 |
|
BLAKE2b-256 | 8e886f8bb8b541ccf057dccf2a09cc779a034de5eedd68e9e0185ef5cf5634d5 |
Hashes for tiledbsoma-1.11.3-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 785fa1781b70b4b78fa503c8a941b4188f95c8a39e65df38b4f5f46f41b81226 |
|
MD5 | 24c190a7b45c75ca3e9f9be6d16a69b3 |
|
BLAKE2b-256 | 2e3df30022ed5fc42fe71329d49ed5a0d761408effdbe1bf4c07a417c78e4237 |
Hashes for tiledbsoma-1.11.3-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e705d6271fb2d0bc36b6433a80397cf97a444e981efaa94423a14ba6a35a661e |
|
MD5 | ce511a1a7c999011fc2410dd02b9370e |
|
BLAKE2b-256 | 115eba6b402d8fe6689216974686c9a714aebfecaf51d61f6d731813177932a6 |