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.0rc0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5268f872a00d270277663dfabcf93f051678cb00cfdd7aa42e0b697ca00d374e |
|
MD5 | 80c5fa8e4d0436935c7d6ccd3e8aa4af |
|
BLAKE2b-256 | a558542b63ee15d456e86cd433b5d0ac059c62db3e99432d694900b1fa40c344 |
Hashes for tiledbsoma-1.11.0rc0-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09476a0f7e943e71a13fcbdc4a8d8e2dd195880464d8ddc7e240325aace80615 |
|
MD5 | 2e31347882cddb90059ca3b6ff0f9bcf |
|
BLAKE2b-256 | 98931b3e00197acd1896042937b33ba7a94e7393ceee57e493c9780a426ea212 |
Hashes for tiledbsoma-1.11.0rc0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a293f8a1d4dbd174619e3f0a47af008833696fca8612b950a7389c63e126006 |
|
MD5 | 2e362c3003870fbc016b414d8efd9208 |
|
BLAKE2b-256 | f5bf785ae684d71197b3568c31fa3bf30d8ea4e615ec424dd2a3abe85088a331 |
Hashes for tiledbsoma-1.11.0rc0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cf56d1b096fa5931aa6b493649d3dc324b9b07e5a35ebb10e7bc35c6ff6c559 |
|
MD5 | 42ec0cbfe5da322783438933f9eaf277 |
|
BLAKE2b-256 | fbc2fa5c07f7ff88b93655423202cd33fc0a631c365403c2f9a674b6903420f6 |
Hashes for tiledbsoma-1.11.0rc0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 720c64a4f7b55673ae069f78bb7e2314a499e65a1a6eb2143c4da24f27a5a5e3 |
|
MD5 | 5a2c42702f9460a4f6ffcb42260199db |
|
BLAKE2b-256 | 18a2847f1d0af029fef359c79743b4644639bb54338d800fd1ec244d4c6c01a1 |
Hashes for tiledbsoma-1.11.0rc0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9673c58eaa8f06befab65c53a896cc4a359c1b10f6b742a5950fb22b242a9ea2 |
|
MD5 | c4bf8644e76d54d38fd97b37c9b58c84 |
|
BLAKE2b-256 | 660e129b44227367f562bbbe7e2404dc5c557abdac3a2c5d1efd807c9c856827 |
Hashes for tiledbsoma-1.11.0rc0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f301164002301e24b368e076c2d0cbf5bcd74711682efadd2b245e591903b58b |
|
MD5 | 1091a5c3b470a951f803ea56998a1364 |
|
BLAKE2b-256 | 472bb403ac7997690dfba078295d804727e808709349808c5be8a6d42d48aa24 |
Hashes for tiledbsoma-1.11.0rc0-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2667a7a04bbdb2629f7337b3c435f04d8c41cc32adecb95db1a228c649829c3 |
|
MD5 | 77a039f5fb44188cee05fc42a12309a7 |
|
BLAKE2b-256 | e0ac755af473851a7430d5be8b61449aacf2f1c363aac4cfcf00995d104b7ce0 |
Hashes for tiledbsoma-1.11.0rc0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8596f49e59007b1faacc948a214242e64b9e6ccb0d35111a3976b0b7e8b1573 |
|
MD5 | bdae4edbe28d5b20bab2e3e9304fe027 |
|
BLAKE2b-256 | 03090f7b86d34f0da827a57a6aea65ec5a3f88f1dbf5659f1e550d77997c0735 |
Hashes for tiledbsoma-1.11.0rc0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae0ede1fca55a8a214427334071fb4b0409948d34875fa7365fe79dbdc7640c1 |
|
MD5 | 1dce53c569debbed019ee8f06a062aef |
|
BLAKE2b-256 | 90d9b4599f1641cb5167153ddc59630097b69dca1f3b8784d17c29b693261000 |
Hashes for tiledbsoma-1.11.0rc0-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0186d377b86a6e5121c2fd23ae61198d6bad615a55ec75a175116f7978afa2cf |
|
MD5 | 062b963cfcda3d495ce85117f10e2a0e |
|
BLAKE2b-256 | b0c814b579ed53b0ba4281c1a5eacc42f1d8e24905c759a6ebdffbedea419d28 |
Hashes for tiledbsoma-1.11.0rc0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bd413666c01d3b9ce37eb97b5da01fbc1025e6997addb0a7de3f3255c911f5b |
|
MD5 | c1de55bc1467d1b9adc67370aa917e31 |
|
BLAKE2b-256 | ba3aefd5fe507dfc588fe3119c4692f541c19263e35b6f16caf9831c106d91bb |