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

Uploaded Source

Built Distributions

tiledbsoma-1.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.2 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.1.1-cp311-cp311-macosx_10_14_x86_64.whl (9.4 MB view details)

Uploaded CPython 3.11 macOS 10.14+ x86-64

tiledbsoma-1.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.2 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.1.1-cp310-cp310-macosx_10_14_x86_64.whl (9.4 MB view details)

Uploaded CPython 3.10 macOS 10.14+ x86-64

tiledbsoma-1.1.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.2 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.1.1-cp39-cp39-macosx_10_14_x86_64.whl (9.4 MB view details)

Uploaded CPython 3.9 macOS 10.14+ x86-64

tiledbsoma-1.1.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.2 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

tiledbsoma-1.1.1-cp38-cp38-macosx_10_14_x86_64.whl (9.4 MB view details)

Uploaded CPython 3.8 macOS 10.14+ x86-64

tiledbsoma-1.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.2 MB view details)

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

tiledbsoma-1.1.1-cp37-cp37m-macosx_10_14_x86_64.whl (9.4 MB view details)

Uploaded CPython 3.7m macOS 10.14+ x86-64

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1.tar.gz
  • Upload date:
  • Size: 142.5 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.1.1.tar.gz
Algorithm Hash digest
SHA256 7472423c16fc0459f0d9fd62f405bbe2985222f80008be6d50d6b5261076f4fd
MD5 ac16ca5869034b9cbe596011c6766038
BLAKE2b-256 b6127233ceb85cfd4bbe801254490971e0596bbfad476bf1e3a0468b1b245ea8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 11.2 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.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 936566a7885e08cbeed6025a26e24e9c7f7eafa936548d7afbcb591c44e9899a
MD5 4d55be76200182b0fb0faeedd467805f
BLAKE2b-256 8d3eb4e61f1f1a69b771710e247a30a9279d950f736a9601288497d4c1ca4fb8

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.1.1-cp311-cp311-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.1.1-cp311-cp311-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: CPython 3.11, macOS 10.14+ 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.1.1-cp311-cp311-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 eb96d939ff4971ba42ee5fae400637fe107e89585c46e8c80fd8c24b6c0c763d
MD5 86858038d1d3ef80051a08c259bed0d7
BLAKE2b-256 f5cc2ca2c27523ba537d53d5e577e871c9941d7e4adf83c4ca0f616986910d07

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 11.2 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.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 906039fb8503603ebd3acca16f9642ca328e928b0d7226e3f2449712cccaf6f8
MD5 2f89fa5f2d1b483977bacfca41e38c4d
BLAKE2b-256 607a7e934004510dad15d2a9bfea5cb8ea371b54dac2c61ca14159658da2cc6f

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.1.1-cp310-cp310-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.1.1-cp310-cp310-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: CPython 3.10, macOS 10.14+ 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.1.1-cp310-cp310-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 cf6bd2b7d85853b927151795eddf1a696f3b3f18edd5faf7a3f65a613cdd4d7b
MD5 86f1d6444720db96fda51f302e3ba85b
BLAKE2b-256 1e747dec572dfc8e88e511008da4a90c0905845335823aafb955d259d7628745

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 11.2 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.1.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e01f291d0c28f05744001aabc15e13cfac9ce61e08d70702e7daa4de6f6c2010
MD5 3195d8478012a4a3eebd1152a3e4f978
BLAKE2b-256 6a3064850230e46af13379f3c9dd8e23cda1e3734c6beea000d43f2debd8238a

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.1.1-cp39-cp39-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.1.1-cp39-cp39-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: CPython 3.9, macOS 10.14+ 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.1.1-cp39-cp39-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 20a0de07cdfce005eeb96445814ac3df36c7ef8d2f654976076d06b543d54b9f
MD5 329f91920338fd4356c7e59b0d64fbfe
BLAKE2b-256 9050a1fdf50f44b3c6c81415590d5ac6136574e65dd8312593341303973a6af8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 11.2 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.1.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 5578b31297d4cac757759bc9cf198ddcf0431472c6e4dd9fcbb822bd79ca67cf
MD5 572740e5dc4b3a59d446d78bb44617b8
BLAKE2b-256 7b97278962b69f86c7383a4aa260f26e453e4f413a735e0bbfda2b23f4b3c9fd

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.1.1-cp38-cp38-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.1.1-cp38-cp38-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: CPython 3.8, macOS 10.14+ 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.1.1-cp38-cp38-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 9dbb47900a65c7d8b34dcb70abd0a658d972edb6d13b060af3f766247263bb3a
MD5 82ac19ed0f14dc2105da3d4099f7b383
BLAKE2b-256 37df8fd6189a753428e513096b32304a1d65f9cae733ac15296d4b9bfefa1d9f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tiledbsoma-1.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 11.2 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.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a6fbd6f5da6ba835c6a0b26982adb14c295b853cade73cf98619b452a7b7fb3c
MD5 805b1b929675d37c86f5dadb75fdecec
BLAKE2b-256 8a26c02b53b02cd0113262459aba1571a8e775b9fad5ef111d0c0246268a5af7

See more details on using hashes here.

File details

Details for the file tiledbsoma-1.1.1-cp37-cp37m-macosx_10_14_x86_64.whl.

File metadata

  • Download URL: tiledbsoma-1.1.1-cp37-cp37m-macosx_10_14_x86_64.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: CPython 3.7m, macOS 10.14+ 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.1.1-cp37-cp37m-macosx_10_14_x86_64.whl
Algorithm Hash digest
SHA256 417b79e8ed24a37604a28813efcc78d1d41c32fb0fecae361ddb9f39d90f84cf
MD5 cac2f433c719f75d09c22239ccaa1b88
BLAKE2b-256 375029317bfc6b951528ff8ff466829d27fb0af892d0c75559531ee828dbc4f6

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