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
# or
$ python -m pip install --pre tiledbsoma
Without --pre
you will get version 0.1.* (the main-old
branch); with --pre
, you will get 0.5.0a* (the main
branch).
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.0a7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c16e1d0834601056a992e0788b3fb5ab036faf1b21bcc89963b9952b68b44c7 |
|
MD5 | 5568fb9bf06a95c82c1c38dd34c0fcb0 |
|
BLAKE2b-256 | 368467ef8fe46f8c2fbc46f50133c63b74d0aad346e5177d362a7a7300f270b6 |
Hashes for tiledbsoma-0.5.0a7-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da75c6a47468101989403e9ceb4cf86ea434c2fb0eb7e0d9e0f642758c42ae20 |
|
MD5 | d3d679f802885a9928104ec43fd15537 |
|
BLAKE2b-256 | df0b3a37f9d263027b230b98ec8457e00718753bbebd41d946e31301ff983fd3 |
Hashes for tiledbsoma-0.5.0a7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f01a764e9af6c0a56815093c1a553cf77c91e90bfea9776ef679395aebb7d9b |
|
MD5 | a3d6b8f043f8327fde7a4d96cf42d87d |
|
BLAKE2b-256 | 1c2f6f07cbc16434e022f6cd3dcd9d763db1b0d30a7c96bd8e9faecf58237331 |
Hashes for tiledbsoma-0.5.0a7-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 707b9ea9346e475764036d4f29a6d86d3f9994dd98c159ec935aa25ed1f5f805 |
|
MD5 | b5034e4a3db2cde13cc09c693755b3b4 |
|
BLAKE2b-256 | 5b99823dbc3dab95cf5ffd0206308a9bc68b5edaa269bdb558d7e89dbf7d8187 |
Hashes for tiledbsoma-0.5.0a7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38feca81d77a0ce2a557c6c02d4c1bf91f67ed899e5a631cf5e4cf9ecf77380e |
|
MD5 | 67d010c0bebe99e769c5de11d40bb175 |
|
BLAKE2b-256 | 645f63a17b3a19cc3d3cb57176f601d225a83715c92f602ee849ddd3b849b62e |
Hashes for tiledbsoma-0.5.0a7-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 982aad3f4ace8bc9939d4cb81f157cb9b28f78f0e157790e19467eceb02847f5 |
|
MD5 | 84a4c3de8dcaef8fd156f7ef1b481aa9 |
|
BLAKE2b-256 | 04471f898bac4f27370358d36a06d6b027f71f897fc592a3ac23395a7ddd7cf4 |
Hashes for tiledbsoma-0.5.0a7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaaa2d74d7c604d97e0add375171740eee19d19011be97f4401c8e54148db9b4 |
|
MD5 | 43b24f1252685baf34498dfbb4c24142 |
|
BLAKE2b-256 | abcc37f3ee3c099b9bb136c29fc0019f56a3fa406dd24c55d572203a9bbb289c |
Hashes for tiledbsoma-0.5.0a7-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec95ed804ff43ae70698e0bf3b09e0ed18788b59e7d2d89d4013b74aa9901dcd |
|
MD5 | 1b0b4ca3015cd73555b5a35ee627ebc8 |
|
BLAKE2b-256 | 78a27089fb8aa0705149b5ff7ee6dfaff775f6601343d7213db12a5afab50a86 |
Hashes for tiledbsoma-0.5.0a7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d514d086946bc7254363594f6d008a078240ee01d9c4188f477df1b45564c32b |
|
MD5 | 18adcf10a81ceca7192ddb5996c2adae |
|
BLAKE2b-256 | 8eaaae397455e2837fcad6a39b78a7bd0d27d80e504c488b6520b95d04c66637 |
Hashes for tiledbsoma-0.5.0a7-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fa230b60f98ede22ae522cb5a26af090f776e1d6a622bfced30a49b532e9991 |
|
MD5 | a21d8629759eea3221624c771f6bdc1f |
|
BLAKE2b-256 | e76266b5f92a144b14cf3145b9dc75b40a2a447fe80294e16e9ee9a19ced2b97 |