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.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6afe05a132eca85b3bf06ef138cf2bd72b52f889d159a168034ccf3173279e89 |
|
MD5 | 145ea60c8a902b23ac0d286948f3c346 |
|
BLAKE2b-256 | 7de9abdee08cd5dad49237c168ff275b79c25f7f31e039331e55cdc2aa9e112b |
Hashes for tiledbsoma-1.9.4-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7aa744805f94b9b5ab5ae972654c025ebb3ef08de6bc8d82636e24a006fc2aea |
|
MD5 | 562448ef4637533d395ec67788fb1225 |
|
BLAKE2b-256 | 15e017d0e50696b1843ff1a894abbd4e7e0b6c97b58e2f1dd4b075df73bbc674 |
Hashes for tiledbsoma-1.9.4-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6b19497464b99dba6565f033cfbe3eb6f6894f7237ae4898ba98e25b643e207 |
|
MD5 | f5ea460de8b387bf2e173c5f8f5229c3 |
|
BLAKE2b-256 | c167827138fb1548588868498ce4a1fd2d089c76ccd407a86bd062737f25b2da |
Hashes for tiledbsoma-1.9.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 359af60970d029a315eb1577933c278483eb899e24a297ec38542ae5c48af8bb |
|
MD5 | 02bf2d781408297c60075945fc8025cf |
|
BLAKE2b-256 | f7b9e3a44b4c1d6d1dc5948e8f1f16438bd0bc278cb43e5d22ca3abd246ff033 |
Hashes for tiledbsoma-1.9.4-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df0eed82eb79800fc7d5fa16c718e1189b549f68ed3b141f86b1ed6d5d24a655 |
|
MD5 | 4674b53b40a3f1b5903f03169ea9cad8 |
|
BLAKE2b-256 | d5e2b9f695b205143d568d87c931a69d716ee07e6fbe141984c1722a58993c60 |
Hashes for tiledbsoma-1.9.4-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13510736788d6a35efd77737b92ce71acaf610ac166b4a421aca1bdfdc1df5ff |
|
MD5 | ac640a1aa8f023fb9807c1bb5571a8f1 |
|
BLAKE2b-256 | 259a4e99cf4d62a311183cbf264d35424e37098704f2eaf3a11450f08ec6b472 |
Hashes for tiledbsoma-1.9.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 972ecbb17f29d251a4d0dcfa4c0f592a60bf6b9ccad60542ccec513e16f1876b |
|
MD5 | b3dbc03b0a9aea3f34979f7f1bd459f6 |
|
BLAKE2b-256 | 366ae50e78504fb750577c5a645eef4587a744474e1ddb63ac86ef307ce0e76a |
Hashes for tiledbsoma-1.9.4-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe4cf01bb89868d4cba83a602e5b20ed3a6c5759fb05da4e73950c0335e5d129 |
|
MD5 | f44a1e404f47ab403b0755bb2edce822 |
|
BLAKE2b-256 | 1f90567b5a103fdce9f2ed267f157e6e631c657217d01eadd26a9bf19f36ebce |
Hashes for tiledbsoma-1.9.4-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a21a15446c0a795af13d070d7cb5db762674accf58486aad2b383eeecfacc9c5 |
|
MD5 | 8dabd2a287e15c62ce25f9b8181ceb2b |
|
BLAKE2b-256 | 1e2443fee925d7d63f4b376fae9908027db07952a7d6d92bbd4103745c5a1463 |
Hashes for tiledbsoma-1.9.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3df8040e2f62cdeffa2ce7e1077f367cce2b35d62412b1dbde697e988250506 |
|
MD5 | 0463072418a99a08c0aebfb3a68b0244 |
|
BLAKE2b-256 | 87d3b61ba2c2012be2a50e35fb19e8e7ba65ff0f9a5bd01ee1b11ba41a9432f4 |
Hashes for tiledbsoma-1.9.4-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e24037b8be0e85975d51bb0f6d2b9401ce423a9a35f74655b21c048983baa38 |
|
MD5 | 27c9d42ecf2213db538b15bce2b635f8 |
|
BLAKE2b-256 | 727714e63d073976ab990da5b3439b3bc6421009d1db9b6919c3dfc0a1a6ce21 |
Hashes for tiledbsoma-1.9.4-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53a761a6819aa8e023a27f700908356012d74dab8ace3cde4611a7488b9beff0 |
|
MD5 | c5b62efefebdc33965751a1f2fadabe8 |
|
BLAKE2b-256 | 194fa35eb1f99e9dfe0d473116347f924ce812f34ead43ddc200bae2a56b7a6d |