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.0a6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af6d6feeb0a83a5876a5de453d2faa2cb34e3c15cb4a687da780da4cfa68af57 |
|
MD5 | 7bf942abd9bc7d57e0721fe9acc6b5cc |
|
BLAKE2b-256 | c7f0f6596967eadc2350631bffa5b50fa77e23163c6db17a66a86b39c9895ed3 |
Hashes for tiledbsoma-0.5.0a6-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bca5ed435525b2561b2ae450cdcade5f307d01d192d3724e2e32d8516bf00aa3 |
|
MD5 | 7f2c4c67f4bf9d31f7194ef76ea69ffa |
|
BLAKE2b-256 | 0e39d4938d346015ed98ef66b53be47057e6e77f3eab5febd2e2cbe084586dab |
Hashes for tiledbsoma-0.5.0a6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d43ec53e6e71c97dca517826e35feb1ade6d62e492c8b0255afa0055a6dccce5 |
|
MD5 | d63ffebb69133df1ba6268cc23e1b479 |
|
BLAKE2b-256 | 0e31a14427ead975c491c4f447ae95dc2ff5eb4783d84419ed751804f5a8ad85 |
Hashes for tiledbsoma-0.5.0a6-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd5cb96c02aff8dc763c8c24135b201eec03a82a0fe7f8fce6aff614b8d4b01a |
|
MD5 | 72bb7f52685f6df72a9b7c0a54b270ba |
|
BLAKE2b-256 | 94d8cf70896b63799b640d5ac3dfb519f3723c89994ff99120d486c5733737c6 |
Hashes for tiledbsoma-0.5.0a6-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7763f99ca43a81552643513de0c743fc1aff68efb5ece8cd981492b4bbccaa6e |
|
MD5 | aa73a75e28c22d9865366d60ab16169a |
|
BLAKE2b-256 | 89aa2561ade57576f00b56c49b6fb78d051685006c0b048e1af0833546dd2a2a |
Hashes for tiledbsoma-0.5.0a6-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96c04b36dc493481fa038456a44a668c8373babf83bedc4ae8f707e48eeeb0cb |
|
MD5 | 242581075e067db975b1e9a2fa5fbd6c |
|
BLAKE2b-256 | 8bacc4995056223be2de24a84f87c84d80bdde256a92293342c395fa52f611d3 |
Hashes for tiledbsoma-0.5.0a6-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97f3e35afcca3be591495bedf77bd4a5ed52a6c7f31d0ae6d0767238885683b9 |
|
MD5 | 8a42ad2619938d5b2710ed840e963fc2 |
|
BLAKE2b-256 | 0aeb7a5e96b747482bdef8e934cb850ac86cb40bfb04e050b1eb3ae6f5a8a2f9 |
Hashes for tiledbsoma-0.5.0a6-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8f254dfda2a124c17efc15d2848c20443ebbbfb23eba888ff511a0206da3c31 |
|
MD5 | d0d14e86a9756982ddab6ac47f054772 |
|
BLAKE2b-256 | cc61bae456b1d5681f2ef7644694ceb54348fd44d7c5c7a768969b84daed079d |
Hashes for tiledbsoma-0.5.0a6-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2c575ace1d00c10f2210c0b143133feb85796ae784a53b8463b34721994b61c |
|
MD5 | 444b29c8f13d8a587df770db3ca50683 |
|
BLAKE2b-256 | 47a776066a66abb0b8bbaf7b6f4cd5cb4ce1332bd44fd444a8e2e3f7220884ca |
Hashes for tiledbsoma-0.5.0a6-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b27b2317c661212926e1637b7cef00a799f29f6fe2b994f13eeac1ba3f2a5a6 |
|
MD5 | 92a3edcd97dad5dcc21df6c5f63199dc |
|
BLAKE2b-256 | a6097521f399148f38c9cd2a105bf13d4764ea8be174006d7000d9988cf4aacb |