Python API for efficient storage and retrieval of single-cell data using TileDB
Project description
Overview
This is a Python implementation of the Unified Single-cell Data Model.
This branch, main
, implements the updated specfication. Please also see the main-old
branch which implements the original specification.
Installation
Using pip
This code is hosted at PyPI, so you can do
$ 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 setup.py develop
- Optionally, if you prefer, you can run that inside
venv
:$ python -m venv venv $ . ./venv/bin/activate $ python -m pip install .
- 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 };
offsets_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-0.5.0a5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cc2cc5df3ea4072d331eea852fcebcdc484606b1322f6a8043fd61891e1e6fe |
|
MD5 | 824214d82620c25a378e5c3132cd5e0c |
|
BLAKE2b-256 | fcce36ebd320f0fce07d84467327b806ceb8ed7105198bb3266ef4ab8140d287 |
Hashes for tiledbsoma-0.5.0a5-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45e02bfeaabcd7475813c5336de8071c14d032a06cbeb0b686130b1bb81185e0 |
|
MD5 | 30dba10f6f2c7120585bac39953561df |
|
BLAKE2b-256 | a6bbc48504eb0c18795f76cb8d0528108ab8371a1820d3ef043b0ed43155b731 |
Hashes for tiledbsoma-0.5.0a5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb0488229e21a104cf70e5e7b9390ab3e29b707a355ce9f28cbc5e1786a5d624 |
|
MD5 | 6a9ad69926a87b86e48033c97988bb68 |
|
BLAKE2b-256 | d16a2a9056dd17f1954fc11a840c12b3e7a4264758b83bddd09727961b681949 |
Hashes for tiledbsoma-0.5.0a5-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a23ca00553949a156e51bdd6be1bb460ddde63faf5127eedeb8c24a5f806a180 |
|
MD5 | be014051966037226d53ffb074af5240 |
|
BLAKE2b-256 | 55102a8c57bf901aca730759c76f370c9b8028774e9bd857b9fb9ac588c0be5d |
Hashes for tiledbsoma-0.5.0a5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fa8aaa32867e2bb813c8537af8b0968cd23a925d21f57e5498112ff54ab0989 |
|
MD5 | 9d15891d2c94857dbddde132922b37dd |
|
BLAKE2b-256 | 8a1ac8392762e60dd39eb7d23a5c06545b41f058bd26f091148b559f8ff86ce9 |
Hashes for tiledbsoma-0.5.0a5-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06ee65063934e4a0f187f9d44ec45fa289872ca4042079ee6571aa3430e32f80 |
|
MD5 | 0f8bf0ef74ed9a36a67641c68dea27e5 |
|
BLAKE2b-256 | 9e029d1dea18a75c7f5486604e72774427985b7dad838a96f635ce8ef6b3fed7 |
Hashes for tiledbsoma-0.5.0a5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c1c0ca9425e323b83542d2efab1eeba4d240ace95dfdeb42f3ceab98ff42225 |
|
MD5 | 960ff3169335b4e930b087e474c76c38 |
|
BLAKE2b-256 | 3a67abf5988f25032e6376efeca01af6aa18660afb5cb9339e280889cf803f77 |
Hashes for tiledbsoma-0.5.0a5-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e0bc82609d76abffe8e7f339cf6d3cfe7e537695870df86d58665fffefeaf3d |
|
MD5 | 99f0e91a057ecc69ba7d7cd1e31fd0cd |
|
BLAKE2b-256 | 606f437952b29baa02844a1f0dfdc5347ce17948e7e8c3f78fe468a92fed2ae1 |
Hashes for tiledbsoma-0.5.0a5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1232434e8cd29a7bff9239fd83dbf6fddbbfb1fb065ba587e0c71af364cb9b3d |
|
MD5 | 05972543e52049dce23a8aae576de854 |
|
BLAKE2b-256 | 339009c6bfb432d332fe0d65e77de3339b210eca885f5267cf6253b8b784bf52 |
Hashes for tiledbsoma-0.5.0a5-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54eaa58e5c84b6f9cbffe0e0a1105930ac3e6f0e465a464c57f93c28341ad109 |
|
MD5 | 60e1cfdc81963fec8f9d57aa6f916adc |
|
BLAKE2b-256 | de098eb16f8f3ffb4a3a0243ac0882bf57ca56a750d9765693da3802099c1afa |