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.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d4762028473182a0d0c826f0b4e84b41501e50ea0e3d33f1bd9dbfc0948370d |
|
MD5 | 80323a0a0ac615cb964c4ae96c48630f |
|
BLAKE2b-256 | 4dd20fcd4ca8b1c1a06cbd96882f390a852b8032ede7b9b2e4dddef5e159e864 |
Hashes for tiledbsoma-1.10.0-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4880bceeddbe356b0d2572d58fc59de9a5004c2f4dea0d64c3afbdb251be3de6 |
|
MD5 | 74955da8ea1fa8c044e3e0d3d1d79ea2 |
|
BLAKE2b-256 | 661900e5b3c2208fb423584ec1c3d66ce43f9278fc2f8b41d3625774f37a506b |
Hashes for tiledbsoma-1.10.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c3931bfaa86754461cf32459ea8e21860653ad66a1c5b7c509a7d956a528f8b |
|
MD5 | 47dd9a363ca4483aa86c5ec5bf253ea5 |
|
BLAKE2b-256 | 53b61c91e7d3bedd38444281d62969fa905333cb570cec8b82a1de257ca74f80 |
Hashes for tiledbsoma-1.10.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab8d4059d5b75be65459da73b9d7e4587c2433a06378ffaf805c43adbcef5a06 |
|
MD5 | d14dc7fab0fb59c96503390c4c12ee5f |
|
BLAKE2b-256 | d99b41897200ee152777103722567c3a7e43d51e0421c7fbeeabe13e4d99b40c |
Hashes for tiledbsoma-1.10.0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6655e10b61c044a4b487d00d7b18c2bd1227ce8367e3771be521a32280c3befa |
|
MD5 | cb5b6735c3bbfeab64741c50a143bb28 |
|
BLAKE2b-256 | a162ef8d057769c860ec2f8568d41065f1ec1bb4640b79e17a65d027b4b3c876 |
Hashes for tiledbsoma-1.10.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fab03fdb4aeca5032258b97115f24086c993d3ed3efdc1833777ee2b18cec8ea |
|
MD5 | 2259c9eed453ac7d571e3f48465db02f |
|
BLAKE2b-256 | e634e596838d8de30a07a2791bad6846fd4d895cfe6f4244394721d7b33f4539 |
Hashes for tiledbsoma-1.10.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a87d55b77d2a813c1f5ba41419d70bcf5a193eb074bf26ff687ede8e289b693c |
|
MD5 | b572d45248ba05954db532ac1ed4a3a8 |
|
BLAKE2b-256 | de20560ca58c939e2c105a5ccab03fb8790a9d93e4e9cfd60287e3bf275d6eb0 |
Hashes for tiledbsoma-1.10.0-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 826b6042fd9e5232ac24729f39cb10a4251d5f0e2fa4ec5aa55a3ee15ec619c3 |
|
MD5 | 40f304dd61a8c4f0390061ac22813e16 |
|
BLAKE2b-256 | 418a6c16bf481106cb9a353519e7e3092d0ef471bc04a70e542c0461f7c8ca0a |
Hashes for tiledbsoma-1.10.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ba959562653a653a5931d2c9a8553c8282d49ffea100dee70c40f2a354edaf2 |
|
MD5 | 4e29ab50c83ceabe43a23bc9ef7139e5 |
|
BLAKE2b-256 | e5e46d077196fa64c9b129f72c92a8c865d50e9f7dd0f38c4cebe1ebdafa52f7 |
Hashes for tiledbsoma-1.10.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e464d2697c2f2adc63d50410ddfb8e7fb7ed7b3cefe40d52df169538407f0c8 |
|
MD5 | 1207898f997d139342a294964a3fc010 |
|
BLAKE2b-256 | 65ebb642b619790830346e1898f3da4893a1fa0ebc55d1b1ebfdba4573a1c4a9 |
Hashes for tiledbsoma-1.10.0-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fe5436e3107395737f6d884b6acb1441dcaeeeb2f9377da9aef8f9ca843c38a |
|
MD5 | 902625f948d0d7ca96594e9f850c7b0f |
|
BLAKE2b-256 | 254cb8a707e711efb38fd8ef8218ecdbb8b3198ff5b0d67095fe85df00e303cd |
Hashes for tiledbsoma-1.10.0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6519e3e8d4efdd9653360c1592036a50145c8a44bcc6b2f2465ec4979204ffe |
|
MD5 | 605be0ec333237ea9b25ca7318b8de61 |
|
BLAKE2b-256 | e67ab360db0599938f0639f2db819f42234db7d9d81c419c7f90f1c8256ab222 |