Skip to main content

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 then cd apis/python
  • python -m pip install .
  • Or, if you wish to modify the code and run it, 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


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.0.0.tar.gz (139.7 kB view details)

Uploaded Source

Built Distributions

tiledbsoma-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.0.0-cp311-cp311-macosx_10_9_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.11 macOS 10.9+ x86-64

tiledbsoma-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.0.0-cp310-cp310-macosx_10_9_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.10 macOS 10.9+ x86-64

tiledbsoma-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.0.0-cp39-cp39-macosx_10_9_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

tiledbsoma-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.0.0-cp38-cp38-macosx_10_9_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

tiledbsoma-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

tiledbsoma-1.0.0-cp37-cp37m-macosx_10_9_x86_64.whl (9.2 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

File details

Details for the file tiledbsoma-1.0.0.tar.gz.

File metadata

  • Download URL: tiledbsoma-1.0.0.tar.gz
  • Upload date:
  • Size: 139.7 kB
  • 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

Hashes for tiledbsoma-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6f7fe81765b2376ca88142f5b7c1b316ae11b319959b3d0e8067fcc94338a0ce
MD5 4a1023785b0aa1bac5543bc0a37fde29
BLAKE2b-256 f240159796ce6d710f8175924e79f42ae7e02f2d02107653114b4e8ee7d7ff38

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: CPython 3.11, manylinux: glibc 2.17+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e2b89b5d14d260ec5e4792151a8dd9aaf33d0c8ebaeb0e7770c41d97dc081d00
MD5 1dd81fcac344733975d1604e6205de6a
BLAKE2b-256 823774815caad143bf61f8b9af2c2da80a3e41c1b774cfd6cf5b75a3846d3365

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp311-cp311-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 9.2 MB
  • Tags: CPython 3.11, macOS 10.9+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 758650c572777ba804f66b484bd247f6d3fc41e043ae6b03396df2d72d4f8bcd
MD5 bd5c83bbb82e2a94d6cebe833e405b48
BLAKE2b-256 691874ef6af9015246440408ff05e884d2363e51a277edc9a88ddbbf3c431146

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: CPython 3.10, manylinux: glibc 2.17+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 494afe03328a0ac507472484081f56ab170820378f51861f7970adc524da2e9d
MD5 40dbbdb155eac5d84425513fd822d7e3
BLAKE2b-256 7119c33f10128db8bdeff62cc320de8fadb6889c7aebd74f4442148d54c4b62b

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp310-cp310-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 9.2 MB
  • Tags: CPython 3.10, macOS 10.9+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e340ffa3d3ffe31a638f0f0f6c900aea509c238f621ed5e795bab6ee337923de
MD5 8a1713347fd6f100409f4638bc9bb8be
BLAKE2b-256 d6c3f6111c037cb1f489dc77f258b46cac3db21a4358d3097d9881c22bb59c67

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: CPython 3.9, manylinux: glibc 2.17+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0c4f47bb88ba7f803209737244cae4fc9c91ae35622bb294fb10ab541514e62a
MD5 e1ec07c61b9b11158c02d2c3e60442d3
BLAKE2b-256 8c636d7de683c2237ff6d914cc629fdfcd207714acc30a685467c1463c9b6002

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp39-cp39-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 9.2 MB
  • Tags: CPython 3.9, macOS 10.9+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 90cc06fa9bf368e4dff1a62634f0176ea0de11d4a5c433c0f2944c3b3d27a00e
MD5 9f9045ee75d0b699ddb1639561b692dc
BLAKE2b-256 40236553cd78c59edcd23ad6f45ae844eb62107f7c1561402e28b5813b92ad96

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: CPython 3.8, manylinux: glibc 2.17+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b5f35923f3fd9339c3c025ea48961caf001176ca0e97dc996ad274446dcd1120
MD5 ce2bef8aff1658d3456aaa2b37bfe12c
BLAKE2b-256 33b97fc96c62ee3596617a1455e658585594bd2ef80224d9f4ed132e02ab1709

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 9.2 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 fbef22b93341373a51b505ab366d2aa4689ff7d0a6f8577a09182b0aed0b4394
MD5 ab1768d5f5010ef155b81f46fa585a67
BLAKE2b-256 25d8d7eaff8210aaacbbcd8663ee64f82ec407b9b3b23de34f1c314e7297bf58

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: CPython 3.7m, manylinux: glibc 2.17+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8c0c69642f0a574366c8a9fcc0b28e23d0fb40f2da2d237728374e7f6fe785f5
MD5 61dae711fd020f8ebe61b03e4934fc56
BLAKE2b-256 cb38b9538c3c799dcf05167e03f1cebc936825d1676a751865976394c149e57f

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.0.0-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.0.0-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 9.2 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • 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

Hashes for tiledbsoma-1.0.0-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 3c261530d618f01c6072cf395f09265224587ca7d4ec0e0b75b9f0f8259571de
MD5 cb232de7708dda24f457ed71a923efcc
BLAKE2b-256 d2302adbcf994d9f36abeda9d81a212bc8331846659d6457b18794b9e596d209

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page