Python API for efficient storage and retrieval of single-cell data using TileDB
Reason this release was yanked:
This was tagged on the wrong branch. Do not use.
Project description
Overview
This is a POC Python implementation of the proposed 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
cdinto your checkout and thencd apis/pythonpython -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.
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
File details
Details for the file tiledbsoma-0.1.20.tar.gz.
File metadata
- Download URL: tiledbsoma-0.1.20.tar.gz
- Upload date:
- Size: 28.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.64.0 urllib3/1.26.5 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2b635ae5f65a428a4e66f9e5c24629009beef92d6181dd2b8e551c833f05e1b2 |
|
| MD5 | 9d9a22264beaedaffc091dc159cdb79b |
|
| BLAKE2b-256 | dd103e5508d90c7c2534013effc73b255a6231db0dac2acf704e82fc928086fa |
