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
Using pip
This code is hosted at PyPI, so you can install using pip
:
$ 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 -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
tiledbsoma-1.2.4.tar.gz
(151.5 kB
view hashes)
Built Distributions
Close
Hashes for tiledbsoma-1.2.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaae6b6d94c53d5230199d19b87db64059bd56b13003327d45ac8860ca3e759c |
|
MD5 | bfdc00cb45ec0fd982a7e3a3cfe479b0 |
|
BLAKE2b-256 | 2a1faadf4aebbd27534bc996e075211cd8ffb35265ba811c81bb87229d8c359f |
Close
Hashes for tiledbsoma-1.2.4-cp311-cp311-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce6b0a6edb76ab0cb6b30d2c75cba07bd1344d2e0392b76511c1b94a9b7fdff2 |
|
MD5 | bf67b23115fb48428d74c9737297b16b |
|
BLAKE2b-256 | c9bc8d7f6762e963e590001eaf9cf428487fc40007e10bcfb315fa1e2445cc60 |
Close
Hashes for tiledbsoma-1.2.4-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac14dc8d46214621fcbaa2cdaa944e1a8fc4ca21c31089899f853b23bb18aa0e |
|
MD5 | 3218509b3962d179158d3248e7eff2b2 |
|
BLAKE2b-256 | de075a20bae1c4a8a665539e12f72c2000bed5eb302e063fbca3f3a0f7530697 |
Close
Hashes for tiledbsoma-1.2.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72302ecebfaaa76a1816e68272f34a4f415b37db7c9af21aa78ba5ae4e5c1a18 |
|
MD5 | 5b39e8ad5defcc06ae5ce3617d1669e6 |
|
BLAKE2b-256 | 6909e2e4900906b38315c953bbbd0997b8784f8418cff9a2fcfec4c641d463a5 |
Close
Hashes for tiledbsoma-1.2.4-cp310-cp310-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d87c79059e9ac77ae6f3387a03085e080ed428082d111951817ce5062eb401d |
|
MD5 | 019c353822b4085b2499f02f62e5129e |
|
BLAKE2b-256 | 4ad5f6ef41ca0dd0d76e8e299e67dd044763cf08b7050be88a62f2ee10c1b876 |
Close
Hashes for tiledbsoma-1.2.4-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9090faf56460b1a23fdbbc1b6ab8cdfcbdccdf5505a69aa2976d6b5136b33861 |
|
MD5 | 1b8dd600f5044ca178992fcbe3e081b2 |
|
BLAKE2b-256 | 19870413e24e6afd86351fcd6c71d9f2cb476fd393e259090270a68aa3f69f49 |
Close
Hashes for tiledbsoma-1.2.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 565c392edd2bcc26567f72f0d15511c68213cc00cf3fd71b359656506f8e8cb4 |
|
MD5 | d726d7bb30b2534875c7645762d675ca |
|
BLAKE2b-256 | b003b1fa17410c64471731bd2cb37f47aa39392d48c4a3b708494632bc1820f4 |
Close
Hashes for tiledbsoma-1.2.4-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd2c3285ef6e55b2457a5b9d534d94bac96af6d323383e1909466a46b9d0024a |
|
MD5 | 19e0e30cafafb938a3c1f74b485bf4a2 |
|
BLAKE2b-256 | b806df39f56823782c93721a59e2ddce6f3ed1b8ee440db2ec2767beba683ace |
Close
Hashes for tiledbsoma-1.2.4-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e1ddf67245530a743aaf6db70e02e4b4151cd4431d17f883b1adeec719cad4c |
|
MD5 | 0c32a23998a1be9c5d35fc6545ab16b3 |
|
BLAKE2b-256 | 1d3a37ce3f439f43f567d3ebaf8ecb9dc45571444baa9b6763ed047e8f7b8f24 |
Close
Hashes for tiledbsoma-1.2.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee53aee03df69dddc2e006e8d08783738821a0a47a6a771d01d9e18fdf974879 |
|
MD5 | 3feae2fc4fbfde2e85f5befd97d55449 |
|
BLAKE2b-256 | 3932bf721c53327e249d8a23d9af428bd6822683a48f39a950b161bdcf7666de |
Close
Hashes for tiledbsoma-1.2.4-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef1ee9fef17c11eb838e2d9439be5accab5f0abda3ea12e7300689b15977959f |
|
MD5 | faf3dd8f77354f87a9685c17cc416c60 |
|
BLAKE2b-256 | 7c9dab1dd8368a19d2dc51a9e0715e310578aca88f9adfb85afbe7c7f0ddc160 |
Close
Hashes for tiledbsoma-1.2.4-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b418d671090b4900be1afd01fe745694224069b82b2142329612eb06aacb64a |
|
MD5 | 57ca359622a23c2a9328d0bc293d73a3 |
|
BLAKE2b-256 | 99d3a29784b648117a7d28a56e3a26e8cabeeeb0f2a508c2c97da75f6b5aabaf |
Close
Hashes for tiledbsoma-1.2.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6ec3e9f681eb2346ff3a44fe13d4eb8f7465a5eed3e39d187b323470f066e08 |
|
MD5 | 45706a127d236ee7815572de9601c22b |
|
BLAKE2b-256 | d1f79a688a9327f160d6d9af72d4e4af1d98f7134a7bb83a5e972a1cf6968d35 |
Close
Hashes for tiledbsoma-1.2.4-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea86bfed2d58c3718f1af00753c57b9ef1a2e3ef5c05239fc751051da94c06cc |
|
MD5 | c2d168949dd137017e4c2bbda37bb592 |
|
BLAKE2b-256 | 96ddac4afc4955a2b1e83e3869a8c007018628331a371319b4c47fe23ebd1fbd |