Python API for efficient storage and retrieval of single-cell data using TileDB
Project description
Overview
This is a Python implementation of the SOMA API specification for interacting with the Unified Single-cell Data Model.
Installation
TileDB-SOMA is available on PyPI and Conda, and can be installed via pip
or mamba
as indicated below.
python -m pip install tiledbsoma
mamba install -c conda-forge -c tiledb tiledbsoma-py
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 -m pip install -v -e .
- If the TileDB and TileDB-SOMA libraries are locally installed to a custom directory, such as
/usr/local
, set the path with environment variablesTILEDB_PATH
andTILEDBSOMA_PATH
,TILEDB_PATH=/usr/local python -m pip install -v -e .
- Optionally, if you prefer, you can run that inside
venv
:$ python -m venv venv $ . ./venv/bin/activate $ python -m pip install -v -e .
- 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 };
allows_duplicates?: bool;
offsets_filters?: TDBFilter[];
validity_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-1.10.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25cf9a9b6fd4c5bc729130264e326e61247978976616415fd5ac6801c823d98a |
|
MD5 | 574640165c387488f9f13da1dd88d8df |
|
BLAKE2b-256 | d72866cf3cdcc55f4805b3e56802b7aba1bd61dec6577a29016d07c2808dff9b |
Hashes for tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49698bbf1ffef6ec811606c091213dbc05230c08a1d2823c257c495765cd5f65 |
|
MD5 | 06f907498f6b77267ae2f70f78a1efcd |
|
BLAKE2b-256 | b41be543ba0de5a2532739ea6dd0271f30df4db84a6125feb2335d48b1b3dbbe |
Hashes for tiledbsoma-1.10.2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e53efe8469d98754fbec12d1bdf9ccdcd7c6325d6d76939458deb5e0a243132 |
|
MD5 | 7219bf4fcb3c95d18b78c20b97895f44 |
|
BLAKE2b-256 | c78048db7719797dc9bb2a4abea055860bb54d1fb16476c4c597e0d8dfbed8b5 |
Hashes for tiledbsoma-1.10.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dfe40600f4421893076875223b477756ab21df6f87c929758e0efca02c997e0 |
|
MD5 | 60b88d8a231859150ac5018537237d85 |
|
BLAKE2b-256 | 4a53fefbe8694b5c45cf2245088e6fccd7e5f14eba54144aea37bedcf7ff9b85 |
Hashes for tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52019f3e825d09a30eb329c68a38aa2b7e810b3b99792b358293d82de0e904bd |
|
MD5 | 722972f404b869fe07f1c071ebf2ed16 |
|
BLAKE2b-256 | 0e21f3bde3d218d55eda311437b805295cd42789ce581e997cdc4b3b4196b6f4 |
Hashes for tiledbsoma-1.10.2-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f57b7b180cadce2fa9694a82968532deb7a63ddfa7b33a6bc5ae58f855cb83c6 |
|
MD5 | f8b0bdcfd640bbd09c658792c47c2244 |
|
BLAKE2b-256 | 56ac2a8fbe87d4edcf3236203901111fe3c193ae977a1fb858a513e3b2e5ce95 |
Hashes for tiledbsoma-1.10.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2389b96aac301ed488aa16bc4fcfcc453baffa44f7b55c55648931744ad699ac |
|
MD5 | 84d32dd7b6dfe92b146184673cb25bdb |
|
BLAKE2b-256 | 341eb833201bfb2b737f1b6bdc079f426b3efec8b6afabe918f20226eccdaaaa |
Hashes for tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5edfb27c20ea280d73edcc8e10596ff6fa09f8b9390d2d29f871945972ed9fa5 |
|
MD5 | 301d61b2e15179c36d4db4bd4a58f64b |
|
BLAKE2b-256 | 5e9319a90d814bf6780950aa8f834170333b6074bfa9fd82b6c95c5ee8891b2c |
Hashes for tiledbsoma-1.10.2-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d36d5fc75c69309cceb6182dae72562ac90f4565bf9683921b1b4d4eea55918d |
|
MD5 | 17b00c316dc67890d38e0e8e7cf68b07 |
|
BLAKE2b-256 | 18d42e8e74e00e0f99272d375beed9634eca570f18d2d39f73a67b13aea7ffd7 |
Hashes for tiledbsoma-1.10.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42b0ee36de6bdb24e9a65353d7cfaab0b6d149216b8a40510e0a714e0dc8e456 |
|
MD5 | e1c82f1e9da2ac824febfdfa8b7a7102 |
|
BLAKE2b-256 | 091188ab72a1ed7b910c427e1b4c4d70561c9e9d93169c611bb4cc1a861c0e55 |
Hashes for tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c743a78f5b9ec6eb2f663e77657aa8135a9d6f79d0fbb761f9b9b329e8347160 |
|
MD5 | d4248b9111fc95a9f12b3a465003798b |
|
BLAKE2b-256 | b31d0741b83120a794cca7628ee2a5f08f59bc9ef5d7be2a2383730b9d92ffcb |
Hashes for tiledbsoma-1.10.2-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f7b056712e5b23ccbad9039fe677adecdced544c07052f780b2a281fa64deb8 |
|
MD5 | 41dcac9a756db172be33e9ee72cad7b5 |
|
BLAKE2b-256 | e900299c195990afe4fb61c98b773ed8c9dad812ed636110dc22883b1ffb8e44 |