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.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a2b16a7bd8c919da6c46fac368fd58ce9be2e284605d83a85b438466bca7efa |
|
MD5 | 808cbb5d58d37bc824fdccbf4a571389 |
|
BLAKE2b-256 | a9d0847cdcec14ce5bf720937833599881a8ab32fd7d1be3a4f27d8fe72eee7d |
Hashes for tiledbsoma-1.9.2-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfa62a592139bf5a9cd12ad645fc71048a0226bde52180fed58622ee0c1b19ff |
|
MD5 | 093ef5e30188a2439c1c2801d8478697 |
|
BLAKE2b-256 | 63bbd805f3db4cf947c7f0cc4d627ce2e73c59f7dab5faa6b95e0c9b74269837 |
Hashes for tiledbsoma-1.9.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 067fbabd52a92b4dee402a8c9afbb5fb5170f5c548866804f7eb8f9fa575d377 |
|
MD5 | 05e9daa4db020fe28d4c9aa673ac6047 |
|
BLAKE2b-256 | 94d4f1321153064650c775c455aebe209298eb918b25c50d18b929869703155a |
Hashes for tiledbsoma-1.9.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 205285325aeea6182b6c462f8db6ff8ed9abf6ea08ae7c921a4d24da3eda2f4a |
|
MD5 | c28f7e3330cf76bc9dd40c99036da069 |
|
BLAKE2b-256 | f9eb5f1620bee1ff7cd9c79be620f1bc83b1032dcc5f946c49693b36ec3fb6b2 |
Hashes for tiledbsoma-1.9.2-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afb1c4479d08574ee88a501f7d52142c61ddcdeb03ee2d9e6daa5a1100267817 |
|
MD5 | 14733419c5a6731e5a7d6f531878ef9d |
|
BLAKE2b-256 | 1e7ae55cf87eb9841f1b25fd719dec5aa0fc6069dc8574d9bddbf93947a9a8a7 |
Hashes for tiledbsoma-1.9.2-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0c0e678a96c092755a30a5fb7a47711bbba1fd68776d887881da482cbc3efbe |
|
MD5 | 7f0f97dd1a544700f1e5b5a86b6a7456 |
|
BLAKE2b-256 | e17bb448bddb7b029bcfde47c1ae44686dea5af14f420464a4bacd2952946bd7 |
Hashes for tiledbsoma-1.9.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47d51605b29455e77caed2507310d276cb62113800db42af9701d07f6343c2bd |
|
MD5 | b4cded1a88dca47aa9405169e537c66e |
|
BLAKE2b-256 | 37bb2800bb11710a14bb2682b4cdd9a4f6612ad11cd3dd4e0a4dd89b27ef0d68 |
Hashes for tiledbsoma-1.9.2-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1438dd13dd3d5eb3e2223fbeae0cc913c40da305e02ad0fb07d30076fb01c3af |
|
MD5 | f3378b58cb8a0bacbb4c8f07d4821400 |
|
BLAKE2b-256 | 68abacdbd02e57b78de9d934fc2e2f0ebdbcaae5f19c883652980a5d3bdf85a7 |
Hashes for tiledbsoma-1.9.2-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09ea1522a9d5876c346ea15646669d76ce4348c4686a63d7bde270e0fe864c5d |
|
MD5 | 39a9f002fb76af7066d453635c256eb1 |
|
BLAKE2b-256 | 98dee05c2d0d130e5cbface2626fe64e1576c0b99edbc7925d601b42e8257df9 |
Hashes for tiledbsoma-1.9.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4055f0520db38fb457fec039fd762dc4da6749facedfd83ace7a1efe8ea8c56e |
|
MD5 | 3eb1868430ea6607c10a81278687e088 |
|
BLAKE2b-256 | d24de9e31c7295aded842001f2cc4298fe0a48099da66e3c510892738890b455 |
Hashes for tiledbsoma-1.9.2-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22f1d1819e7642212ed7ae6d5fffd40dfc0b2bfea028373892c742eeb586fd8d |
|
MD5 | d6033997a58793edbcc01d24064a5940 |
|
BLAKE2b-256 | deb5bb6827005f186336cffe922680015dba8a3f7bcd0248c3c6f269e73a11dd |
Hashes for tiledbsoma-1.9.2-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60db55e3e8522d7064c690ec876be67442bc8f54eeb2fea18cb24c1e24ed46a2 |
|
MD5 | 833444acb5773208fbf72cce4f4ce51c |
|
BLAKE2b-256 | 3946fb048e2ebaa3205983d18fdc35c014da7229e94a2390b4db3e4b566eb04f |