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 Distributions
Built Distributions
Hashes for tiledbsoma-1.11.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45339054b137c940621a4d4fad337680d6a0d9f562a5de3067d147d6e46b413a |
|
MD5 | ab463fca5104c11dbe4900a3266ae5fa |
|
BLAKE2b-256 | 95d677cf1ecaaea133c63fd73be5b62acac08bde6679f05d8eaa9c1e7bd3d388 |
Hashes for tiledbsoma-1.11.2-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e44b442a03a1d15430b4bce7a06a67afae794016e93dddda55c16fc6f5efe4a |
|
MD5 | 2152a05f0829384d4a419e4b1b7b2a00 |
|
BLAKE2b-256 | 2d7b23f04a76577a4d91bf8cc4f4b57f0df9daf9376d34f59fb7432d9f63c4d7 |
Hashes for tiledbsoma-1.11.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce153dcae7b92300580219ab4212491096d6153fdec71d5caa8c99e696f9c0d9 |
|
MD5 | 6f1f39199b114778e751771734ce8f36 |
|
BLAKE2b-256 | de725cd4b407af6c1dfd05bbe9abe0d4499ae32d5090c19a3e573b41a5ff50a5 |
Hashes for tiledbsoma-1.11.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc5172173ce259bf7c41dc92a08efd32a88e0e5dce41247233cf8c374a2bea4e |
|
MD5 | f3eb5cd3f296d87fb102643512dece10 |
|
BLAKE2b-256 | bbf999b4cb85afdfd47d651092a2e459630212ef36b74ac540224606d832fddc |
Hashes for tiledbsoma-1.11.2-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09c3ca842b522668607f1d562710dad966ba5a6dd0dc9c85ed6b9453350281a2 |
|
MD5 | 67e07e22bbbe166a7f57802f12fd1370 |
|
BLAKE2b-256 | db9a965045d397ca4ea0ac74e5084d8fe63c6e929aabffa9d4bc65507b563ec8 |
Hashes for tiledbsoma-1.11.2-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e2eb21512f6ae2c757ef85754813c0db7e92bbc921844850136dcd6d5118d97 |
|
MD5 | a5826727210bcdc5b3867bce84a8d860 |
|
BLAKE2b-256 | fc8b86c80a1a8b11ae5588b8fc80034ea42edaa8327060efe577f897ba726fd6 |
Hashes for tiledbsoma-1.11.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b65129b6c3fee09f4a5f9c93cd0bdbd6321dca5d0024a8588e4b7a6d815fd78f |
|
MD5 | 6a57b1f57a78370133f4f5c07589e32b |
|
BLAKE2b-256 | 810845e07362046ebbc8498c8efbd780ec54ad2025e7d3e628646a2f656e6359 |
Hashes for tiledbsoma-1.11.2-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b885dcae068e9590a2e91be9bb783881607f647f1485c2ed42fc1f888c62edd |
|
MD5 | 18eed91550385174db2da47f1d9b20e3 |
|
BLAKE2b-256 | 46bae07268d028525927b65969bf227811ebe810b6fdf6fb9bfcdf83e8ef083b |
Hashes for tiledbsoma-1.11.2-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c0f1cdeacb9395886c468e37a11dbe38041e1912f0ecf77549f878852bb4847 |
|
MD5 | d8e58e70e6ad4f828180081b71e43042 |
|
BLAKE2b-256 | df7f6893a63cc0552f001754053672a33c2302ef1a8ca14ae6720ee1e159fa7c |
Hashes for tiledbsoma-1.11.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fdcac8476518b63237c50cdf6d0fdb724990bec6383a3ade68789f92bf8dfe14 |
|
MD5 | 809871c2a02686954b9c0e2a38ab6122 |
|
BLAKE2b-256 | 1e678645e38b8a8735c9d221aaf4c1be7a7fe1a9a2430f96e6d9cd2d3051b024 |
Hashes for tiledbsoma-1.11.2-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54ae2f8741acdeeb05c89df60c5b0f956864c7f2d0e6fa64c267827803286a88 |
|
MD5 | 06c04ba085679792444bc585e09e8e20 |
|
BLAKE2b-256 | fd6a4c583674404ed58fece2d800e453e507452109b9969f6080513b51f27fb8 |
Hashes for tiledbsoma-1.11.2-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 678e75ecee147ec542651cbfc72e92bc0e66c2dec4daeddd4d69979ff5194f53 |
|
MD5 | 8cac44dc1aba1e63b98b416173231ef9 |
|
BLAKE2b-256 | ce59be6dc8b232b02da7a168b95b0e36c1efb035ae4dd08344cfb2188049bca5 |