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
Using pip
This code is hosted at PyPI, so you can install using pip
:
$ python -m pip install tiledbsoma
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
tiledbsoma-1.2.3.tar.gz
(148.4 kB
view hashes)
Built Distributions
Close
Hashes for tiledbsoma-1.2.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53f018824a60a5677d76530ead595d09b1dfba8c9b0a4aed8f94c610ccaf972a |
|
MD5 | 197a0a4724cad16670bd7b18c6c027b6 |
|
BLAKE2b-256 | 97dae09b12b3b96f082db6cb2cdf428891261b56663cedc8d951b42baadbdd1b |
Close
Hashes for tiledbsoma-1.2.3-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52232d2561eb68987279ef03bad93a82c96de0c4bcec607851ea490b39c300cc |
|
MD5 | 94a535c3ab68bf03d73668036929868f |
|
BLAKE2b-256 | d5a85179cbd810045b1d2bf987cdf6062a82f3df2ccaff24cd171150dea52914 |
Close
Hashes for tiledbsoma-1.2.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3624df72fcdb71efd2ba07798f92f07c5409acc2ba97e5c5e8bf90d26391da2e |
|
MD5 | 6f98f70e64219dc515ffff810b2e551c |
|
BLAKE2b-256 | f51bca924593d93d350d87321f961287778c820c5a9b6829992b7b6e2d5433b6 |
Close
Hashes for tiledbsoma-1.2.3-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ccc001abdebf67cce5a6d9c8e9038fac3df1b3749f0ecd134b083a78b42b8f0 |
|
MD5 | 62c754527dc057f3444e753cba7c5b3c |
|
BLAKE2b-256 | 4a0594d464258e21d9176f5488b34a3e212ab42e51c26242f3b095f0955b6da4 |
Close
Hashes for tiledbsoma-1.2.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2d51fc12037785ecbd5f503a5465c8a2fa91170dfc2df4b4078c5b548a8ce54 |
|
MD5 | cf4e2986ae6bf653d2978c54300e04fc |
|
BLAKE2b-256 | f82d220345c55b21e7dd57ba9c840174a9f6d702d368358c941b0903b8739b40 |
Close
Hashes for tiledbsoma-1.2.3-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8da85d345d44e4c1db0fd15a845378d399f263bf53cff8a9f2a38947e14be4a |
|
MD5 | 8823a1470d969f11eb64c495aa8777c6 |
|
BLAKE2b-256 | 787025544117546e0e8579817735c27c0118794ce791e24af84bb7aa8eb39b37 |
Close
Hashes for tiledbsoma-1.2.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdbd33e2ed5021ee051712a88891a1df107bd8f70abcaa501d14830ee50f41e9 |
|
MD5 | e2cb428c257cdc02ec84bfe588dc5a87 |
|
BLAKE2b-256 | 126911921d2e4e908ba32a6b79294a29393d53019ec877be25bf5c8a37799c2a |
Close
Hashes for tiledbsoma-1.2.3-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23973af7ee2fda43d98ca19d63cbc90020be5bf924ec537dfb3e51a5857ad8a8 |
|
MD5 | 4af309d347d5479e5377332906dae0cc |
|
BLAKE2b-256 | bbde627058d74a31a0a500216487b0e6a21d4e38ec29eb2ecaf8fbc8830fca6b |
Close
Hashes for tiledbsoma-1.2.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4ae07a3ada89f49b4a2d1cc94820a71e3ced84ebe27eb3eefaa5955aee96e67 |
|
MD5 | 457a364b73c4595603c2597d84b0f02f |
|
BLAKE2b-256 | 13e3477b8ef9a6422efb26acff33e731f44058e05a5e768e9221c2d07c9235ef |
Close
Hashes for tiledbsoma-1.2.3-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04655e4b89f81ee61bc576dccb09af5d19e32428f53d300589ba04ec764cec54 |
|
MD5 | 5c680cb8a95880047108732008756720 |
|
BLAKE2b-256 | a1ac91d7107cbcbd650de57cf1e4044b25bd9fc4bdbe464cdd017eeb60cf57c5 |