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.0a4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d32f46f7ce3378db74b0ffe94fddc12d6adbec0683bc99af4623fd5c17b0c5f |
|
MD5 | 553fdaf97d5129d0448d5dff65f61100 |
|
BLAKE2b-256 | 52515f57a424e0949f41fbc42006b6c3a341e75e0cfdec4394f9d9ee9f0dce7a |
Hashes for tiledbsoma-0.5.0a4-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71315ff5352e9f2c856b1c5e115e45a4f256e277be2b6f3a2030c396f692294a |
|
MD5 | 53a2c6e3bf466af15d55b852f80d2716 |
|
BLAKE2b-256 | 43252c92a9f31cc55884d669dc4417b3d546935a01404f8c0d79507dd5c0a28b |
Hashes for tiledbsoma-0.5.0a4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60250ca4115b8ae812851c2c1dc9b206c1859f9bbd0801cc53f3356c6bf605b5 |
|
MD5 | 0eb9e4fec0a49173e240e55803a2a8ef |
|
BLAKE2b-256 | 24f0cf02d179c7976488927b4991ab9ac30299a5d5b697d6dfb511c992e79af0 |
Hashes for tiledbsoma-0.5.0a4-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ac7004c6f93433924e7042110e6d2380ff08d38146fede9eaa8070580e7d489 |
|
MD5 | 7ba2a3c0a1ecda1a080f92dfffa39ca2 |
|
BLAKE2b-256 | 007e16b4df9ab8617fa3e252355c811d61b4ce162ea3fccc929121f80d4d49d2 |
Hashes for tiledbsoma-0.5.0a4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76c72aa92e365d7a2a4d5714f452020f2dc9a833e496b41c25bbd327ebd4a0a8 |
|
MD5 | 3ab43eddee31b8a778c0789cc66f67c9 |
|
BLAKE2b-256 | e0fcdfc2961778663f32402742ac8369487c5a8f61ce295ba54bbf0ef9085aa8 |
Hashes for tiledbsoma-0.5.0a4-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da8a5c473006ff98c4e695ed151243ca792c271342e52d85d7645d9800f1df83 |
|
MD5 | 5e8d40bb9c259545b0cdafd8f43cce33 |
|
BLAKE2b-256 | 7675128fccaca55cbeae8259075a776d03146610e8ca1738f0906ee25991ac36 |
Hashes for tiledbsoma-0.5.0a4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee8088bc5506763182f569bb978549084db6a1a68023a13b0e112d741dcfad74 |
|
MD5 | c509fec04d98eca6873ab56460ea6f94 |
|
BLAKE2b-256 | a06f89848ba0e49283f6db0eabf18e197fc4f5590a47d7fb2ec08f712eb1adca |
Hashes for tiledbsoma-0.5.0a4-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e79069bd90529e2f97527fc74e57bf0f6d7c9f97cd8920c898de7e27ee33892d |
|
MD5 | a241f269b453e9205b9d12cb123de54b |
|
BLAKE2b-256 | 84b5ff36aea9a07b32c77b8b3d71d54be012d6f7f828d8caafd9b58a1a425aa3 |
Hashes for tiledbsoma-0.5.0a4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3435c97674425c3cf5341cbc9e3c4e64fef698d3215fb91302e40aeffc5ad92f |
|
MD5 | 647765fba9eb8650d312b4d8dccda88a |
|
BLAKE2b-256 | 9040d73f81ec849f5d896808eb38740ca65a67aebf375f74a0929a0eb451d437 |
Hashes for tiledbsoma-0.5.0a4-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c04aee486bc435765ebdcfbeb29705a345e6c05cdbd867cc4103c06e98ca4173 |
|
MD5 | 13fe14a2f5adb4f29767b90f44f387dd |
|
BLAKE2b-256 | 6998b3ab9c6747bf475da2a9d4c9d0abe674fa4b39c8cd8e04a89674e70fb5b8 |