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.8.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 579b64b49d0a49d955c93dcd511c9359617d85973e34491a2fa7681f474760d5 |
|
MD5 | 77c83b49b82c0090a06949f0b720a96f |
|
BLAKE2b-256 | e3420b9f494017d52808746d0a137beb3738894773d58485d16406f71e7484be |
Hashes for tiledbsoma-1.8.0-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ebb11020ff697b25c1ce2f39dfc86bcea9fb43eaf9d7dff9dc1bd0b05edef69 |
|
MD5 | b861e5d4d5fdd0ecbbb2fb26392c02b2 |
|
BLAKE2b-256 | 5b50dff482ca1307a8684816881ebe5fc1a797262b6262b1fbf0d83d7027202b |
Hashes for tiledbsoma-1.8.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 352ac2531d030f1ef3cc5b1293d34e6bcd10f6548cba108e20f661b1a71663ec |
|
MD5 | 432a1ba507665d0c9c1387a36b61bdf5 |
|
BLAKE2b-256 | 7bc0ecc405a2bac179bca59641e5d13631d0c3f0aead16dce11af3ccd3e8b68c |
Hashes for tiledbsoma-1.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 870fbd5515806cb4224f1b176e7d2a755ee02f3c929937323f40b1e33fbe4411 |
|
MD5 | 98f6660b122ea4491e77ab3a69e2c5a4 |
|
BLAKE2b-256 | e1a6ebbcd648ac99f3497fe7fdcb378fdb03e8742d2303adef8fd789a07c3780 |
Hashes for tiledbsoma-1.8.0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5584686f534d41152d291b0d56ea3666d2297b0b1b4c50dd506576db27e799b3 |
|
MD5 | b041d6f450fafba722abb3f7cf5cfd14 |
|
BLAKE2b-256 | b6c6b23836199e1e5f5be7539177b45f3bec5d0f4a634288e93e8505c8bb2f38 |
Hashes for tiledbsoma-1.8.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c37ce42bca0e4ea5a751a6853c31f87cc6232e9ba2fd2f51d7ade0534b0a5a4 |
|
MD5 | 1d260e80d67d5261f22ed5fdc131a6da |
|
BLAKE2b-256 | d7b1ab93225f0f4fb0d46a408c00a284def11cc1dad52a606f7ff1288a89ebf1 |
Hashes for tiledbsoma-1.8.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bbed6da44931d1217139941552ce38be41ae7eb6d7675d5280dffdf1dd1e399 |
|
MD5 | f8c1751ae4d12a8f92ae694d2895b70d |
|
BLAKE2b-256 | 925bf14a3c0bb95948a2a2203af5a35099893a982df64ca11116f70a7f47e959 |
Hashes for tiledbsoma-1.8.0-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 425c31cfdea8eca5642406af618c821a3d4b1ff7e70f30176fca86f5ea35423f |
|
MD5 | 15a95699e5aeceab64dd6a0e0aa8d10b |
|
BLAKE2b-256 | 77e023533daa1925a50462f1d9b7dd7424255d27eebfc9040be08491cadaa306 |
Hashes for tiledbsoma-1.8.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9125588570e0b11ed2433b57e57aa926da532ade673dd65ba1a2924b8c11d9c9 |
|
MD5 | 52eb0007c11f78ab8cd1960eb90737a3 |
|
BLAKE2b-256 | 44b968a15f897a07097187a6153529d84b7490c64b8d1d17c52485ccd1d4fcb8 |
Hashes for tiledbsoma-1.8.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff7df9bbcf34e380d67a3cc7ddf4d5fd4ade0c79e61681b36a991fd2a02de5d0 |
|
MD5 | efb875156ab8ae1a5396697082fb4e11 |
|
BLAKE2b-256 | 2deb2fd1a748fef78d58bbc11f3aa843e1b54067d1b11463e56fe7bab3f4401c |
Hashes for tiledbsoma-1.8.0-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2530b3ce5e83b70c12e2b4ccd4dd96f537e351a743064a706785f8f28d2f0ba |
|
MD5 | 7c3ed385343322acbceb828e96e357cd |
|
BLAKE2b-256 | f80819cfdc6b16a963e819e6053f0255d7b671e44a7c45b057021287a802fd20 |
Hashes for tiledbsoma-1.8.0-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae8e05d3c7e02a253593abbb649332d2c2c7753211d883a314336e7b756c2323 |
|
MD5 | 4acdd5779f92e9533269e1ecd204d33a |
|
BLAKE2b-256 | b65c689619a2f69ecf0eca126a04d787f1f692f9bb1d81b916426b7db972098b |