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.0a8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a326280c24a0abe84798b7072586fab110ff1eaf10c4bc30cdfc56bf2bef74d |
|
MD5 | 152de4da103053e2e17fb82c4a700dde |
|
BLAKE2b-256 | 4fa310f689e3dcd545b50ea81e06bbd85942201b0fa15894a40daa5cbc19724d |
Hashes for tiledbsoma-0.5.0a8-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a879943a496d1fa4bf2268645b58c3faf5419c4adce148d5374ebc85fcf04c65 |
|
MD5 | bcb6c2ceabe44bbb8be8e65628661038 |
|
BLAKE2b-256 | 485bc4b0b7ed9322b8c38872e13a305ebe73e7483c51d78e2a533515ecb46e96 |
Hashes for tiledbsoma-0.5.0a8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec390750ce6b1e0c4296236678cf45eca339d819b0aff643d20d38061400e349 |
|
MD5 | a97c9bbade6ed12ea22ff617741020b8 |
|
BLAKE2b-256 | 916f7e6e9810f995641941b12f5aa5bba3319c0b256748313c734d82563a564d |
Hashes for tiledbsoma-0.5.0a8-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ba1bead96435038248807ebc92f029de7e0be0d667d56655c7826afda996453 |
|
MD5 | d4b9633ad38929d4fa788bf703c55857 |
|
BLAKE2b-256 | 07d2a532f7c0ed592466da95faa9e5d39114ea223d1486faa56648822102b575 |
Hashes for tiledbsoma-0.5.0a8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cf07bb601ec56dddfa4c57fff88638560802a70aef8ac4c90c337157057bd07 |
|
MD5 | cbac277f175211bd7040899eaebb9b54 |
|
BLAKE2b-256 | f918abbd6ab1afb2d202d1060d614baf5dad66c9ccef63382ceb97125bc4a652 |
Hashes for tiledbsoma-0.5.0a8-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92b6f8e4e7dc07324c035d9099ca82b2f66a06a4cd1ec79441fabf204fe3c19c |
|
MD5 | 64dc76f08a5cdb169d7d1217bb5c393c |
|
BLAKE2b-256 | d5083e19594d0eeb53938f713642934f4b2c9bff39e671295182b7fff4e68d0b |
Hashes for tiledbsoma-0.5.0a8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cf6ff6ab937fb286887f000e685a02321257ed6952fc10ca08ad643c9ed1e02 |
|
MD5 | c3b49be07f15f4dc2dd37e7c39173317 |
|
BLAKE2b-256 | 7eeba0a67638b142600db361ba06d3825eb76a623d7fc3a9dfd017cf09db9af1 |
Hashes for tiledbsoma-0.5.0a8-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b27513580b6cdccb5cda016fe965477e70456e1aed22b5455da41ff4f4a286b |
|
MD5 | 3128c2479b0e1eb56e28401f56351312 |
|
BLAKE2b-256 | 3c0fa6db342ca00881cd3573ccf110137aab0ca1f69c77ce0f9959fdac3de697 |
Hashes for tiledbsoma-0.5.0a8-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b76c53a92110a64545e8d9d5848018f556c39d6192e8be69de9869f38febddb |
|
MD5 | d4896dca46a553a12ef93524571358e1 |
|
BLAKE2b-256 | 119ec6f1727ec4f776407181ae61ceddd79469ff935e0f2ad1b37169223716d7 |
Hashes for tiledbsoma-0.5.0a8-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93a2a227da1c12dc4a8e2839a8796a69dcc51a792877143ea9c8d4a7cf0a9eb3 |
|
MD5 | 45d51321e6bf350324e43e5ccef88263 |
|
BLAKE2b-256 | ef5cdde5004a1f8f5075f219d453afe1b123e3903f5ab7ce1de18b643d05e172 |