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.11.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a7b95b875365df23193a8484b5c0648a64dcee986b51daace395bd91e400fd6 |
|
MD5 | 20f987298794fc3fa008d972a114e727 |
|
BLAKE2b-256 | a6246f11cafc11222ea336fd55c032acb39b10ff8f895624e2f6edd9eab4a76f |
Hashes for tiledbsoma-1.11.1-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce77becab755bfd26095e694bbba15e11cfe727dd10040561344fe279c78e931 |
|
MD5 | 30a70689c55997ed1051bd98e4b09d25 |
|
BLAKE2b-256 | 23b5cab163bf8cc0c5f3a37bc8933b05c1a730ebf3b0f4888fe01ebeaf42c4bf |
Hashes for tiledbsoma-1.11.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c39a8af2224b3b618f1935daad132ad94c7494d8a51d68d4896bce038dc70032 |
|
MD5 | b1ba036ebb57c4859935af3329694db4 |
|
BLAKE2b-256 | 61ca4722cfe2f45dc203f0ff46a88a4491f7fcbd02515b7879a8d28a25d561bc |
Hashes for tiledbsoma-1.11.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c77d619d231ab2d64f5a8b5f24824e5c32f2e3d9063a95cea97c6da3914cadf |
|
MD5 | eb8cb45b84fc288118a54d8cc07b8d65 |
|
BLAKE2b-256 | 66c9467870a3aad5090db0fccd301827b18a24acd5c201423a0d43f816f28113 |
Hashes for tiledbsoma-1.11.1-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81515be06c3dc0359547113a8a43caac097dcf7e647251b8fde64b3e73f17174 |
|
MD5 | dec6144367f770e2482788295824a5f7 |
|
BLAKE2b-256 | 1dff778d109ef97386107fde61c8882018e62093d5a1882a91bb77644b90f0fa |
Hashes for tiledbsoma-1.11.1-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 262d3af810737a7bae3a3c2fa376ee57f3d623c9c52571de9c2b11ba58f28b7d |
|
MD5 | 0107720118a692cd7ed62b580c8f3677 |
|
BLAKE2b-256 | 8b1b3fee9ddcf61e0e90a0e9fe8ec270e175cfb034096231d3e7db4b094e18a8 |
Hashes for tiledbsoma-1.11.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43b1944961a590ed8a0f8bd9f7aec1eb9db3002546778d3566c5d7dd7355dc8f |
|
MD5 | 445345b6512a9767cd38765946615d8e |
|
BLAKE2b-256 | a1c4ea3a3d2f56a87561696d75a7205bb2837c0cc932c565d67cfb2c660f43e2 |
Hashes for tiledbsoma-1.11.1-cp39-cp39-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e41a2d4f973bef220a99f2f4211b36d6edbb29da0d47090401b6b7db6dbfa87 |
|
MD5 | a6acfc3d33a78f832979324617c7aa92 |
|
BLAKE2b-256 | 23e1778fb81914b75d3cf18a0796750c4dbf3f94ebefcfd06add56e6de87d718 |
Hashes for tiledbsoma-1.11.1-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a65efed0d4071e8a16eee4539fc87bcc2a69be2bbf98d21bfd53e2ce888af88 |
|
MD5 | 353ad9736315064d1bbeeb384d6ba7d4 |
|
BLAKE2b-256 | bd5b2d87971570995a53a6ec10ecda919486edf7d3c43dce28ed17913567c639 |
Hashes for tiledbsoma-1.11.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea2fed92afdfc1276a05fe424fdbf23139f6ab49ddf9bf7a92645a98cb179309 |
|
MD5 | d83c2ead3577ce3c09a390580cb08560 |
|
BLAKE2b-256 | fb3f98a19dae2986e379274f7c60f530a08acc9f1cfdd30bd70d480bc7b244c9 |
Hashes for tiledbsoma-1.11.1-cp38-cp38-macosx_11_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10ceef95ad27983b8b9f7ff5ba6d4764a045bf40b8370a7938d599fe33d4db0f |
|
MD5 | 013ccb19e2104dcbca7c3a610a54668b |
|
BLAKE2b-256 | 267797a3bc7fc5f49a3fdd8814274e6acb205514d755832cbef5f77609f4f4d2 |
Hashes for tiledbsoma-1.11.1-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7482ab4c4938e1519d6ae9f7e5f3324207d1cfdc3e203411e590c82abdde16a5 |
|
MD5 | 0bba15f6fe24230cadd00b9217e39a3f |
|
BLAKE2b-256 | 3d79e51f7828ba342f21c6bbe83d46d07e9311487c8b7cae07d3a380ae2e7b22 |