# Overview
This is a Python implementation of the [SOMA API specification](https://github.com/single-cell-data/SOMA/blob/main/abstract_specification.md) for interacting with the [Unified Single-cell Data Model](https://github.com/single-cell-data/SOMA).
# Installation
TileDB-SOMA is available on [PyPI](https://pypi.org/project/tiledbsoma/) and [Conda](https://anaconda.org/tiledb/tiledbsoma-py), and can be installed via `pip` or `mamba` as indicated below.
```bash
python -m pip install tiledbsoma
```
```bash
mamba install -c conda-forge -c tiledb tiledbsoma-py
```
To install a specific version:
```shell
$ 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:
```shell
$ python -m pip install --upgrade tiledbsoma
```
In case of `illegal instruction` errors when running on older architectures --- e.g. Opteron, non-AVX2 --- the issue is that the pre-compiled binaries available at Conda or PyPI aren't targeted for all processor variants over time. You can install from source, as shown below.
To see if this is the issue, on Linux:
```
grep avx2 /proc/cpuinfo
```
If this comes up empty for your system, you'll definitely need to build from source to run TileDB-SOMA on that system.
## From source
* This requires [`tiledb`](https://github.com/TileDB-Inc/TileDB-Py) (see [./setup.cfg](setup.cfg) for version), in addition to other dependencies in [setup.cfg](./setup.cfg).
* Clone [this repo](https://github.com/single-cell-data/TileDB-SOMA)
* `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 .`
* If the TileDB and TileDB-SOMA libraries are locally installed to a custom directory, such as `/usr/local`, set the path with environment variables `TILEDB_PATH` and `TILEDBSOMA_PATH`, `TILEDB_PATH=/usr/local python -m pip install -v -e .`
* Optionally, if you prefer, you can run that inside `venv`:
```shell
$ python -m venv venv
$ . ./venv/bin/activate
$ python -m pip install -v -e .
```
* In either case:
```shell
python -m pytest tests
```
# Status
Please see [https://github.com/single-cell-data/TileDB-SOMA/issues](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`](https://github.com/single-cell-data/SOMA/blob/main/abstract_specification.md#platform-specific-configuration) parameter.
The options accepted by TileDB SOMA are described here, using [TypeScript interface syntax](https://www.typescriptlang.org/docs/handbook/2/objects.html):
```typescript
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](https://github.com/single-cell-data/TileDB-SOMA/wiki).
<!-- temp for readthedocs testing -->
Raw data
{
"_id": null,
"home_page": "https://github.com/single-cell-data/TileDB-SOMA/tree/main/apis/python",
"name": "tiledbsoma",
"maintainer": "TileDB, Inc.",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "help@tiledb.io",
"keywords": null,
"author": "TileDB, Inc.",
"author_email": "help@tiledb.io",
"download_url": "https://files.pythonhosted.org/packages/c8/44/2642b0a8705df6896f63d57f8db72a49457f74721dd072afd5aacc408a0f/tiledbsoma-1.14.5.tar.gz",
"platform": null,
"description": "# Overview\n\nThis is a Python implementation of the [SOMA API specification](https://github.com/single-cell-data/SOMA/blob/main/abstract_specification.md) for interacting with the [Unified Single-cell Data Model](https://github.com/single-cell-data/SOMA).\n\n# Installation\n\nTileDB-SOMA is available on [PyPI](https://pypi.org/project/tiledbsoma/) and [Conda](https://anaconda.org/tiledb/tiledbsoma-py), and can be installed via `pip` or `mamba` as indicated below.\n\n```bash\npython -m pip install tiledbsoma\n```\n\n```bash\nmamba install -c conda-forge -c tiledb tiledbsoma-py\n```\n\nTo install a specific version:\n\n```shell\n$ python -m pip install git+https://github.com/single-cell-data/TileDB-SOMA.git@0.0.6#subdirectory=apis/python\n```\n\nTo update to the latest version:\n\n```shell\n$ python -m pip install --upgrade tiledbsoma\n```\n\nIn case of `illegal instruction` errors when running on older architectures --- e.g. Opteron, non-AVX2 --- the issue is that the pre-compiled binaries available at Conda or PyPI aren't targeted for all processor variants over time. You can install from source, as shown below.\n\nTo see if this is the issue, on Linux:\n\n```\ngrep avx2 /proc/cpuinfo\n```\n\nIf this comes up empty for your system, you'll definitely need to build from source to run TileDB-SOMA on that system.\n\n## From source\n\n* This requires [`tiledb`](https://github.com/TileDB-Inc/TileDB-Py) (see [./setup.cfg](setup.cfg) for version), in addition to other dependencies in [setup.cfg](./setup.cfg).\n* Clone [this repo](https://github.com/single-cell-data/TileDB-SOMA)\n* `cd` into your checkout and then `cd apis/python`\n* `python -m pip install .`\n* Or, if you wish to modify the code and run it, `python -m pip install -v -e .`\n* If the TileDB and TileDB-SOMA libraries are locally installed to a custom directory, such as `/usr/local`, set the path with environment variables `TILEDB_PATH` and `TILEDBSOMA_PATH`, `TILEDB_PATH=/usr/local python -m pip install -v -e .`\n* Optionally, if you prefer, you can run that inside `venv`:\n ```shell\n $ python -m venv venv\n $ . ./venv/bin/activate\n $ python -m pip install -v -e .\n ```\n* In either case:\n ```shell\n python -m pytest tests\n ```\n\n# Status\n\nPlease see [https://github.com/single-cell-data/TileDB-SOMA/issues](https://github.com/single-cell-data/TileDB-SOMA/issues).\n\n# `platform_config` format\n\nWhen accessing SOMA APIs, TileDB-specific settings can be configured with the [`platform_config`](https://github.com/single-cell-data/SOMA/blob/main/abstract_specification.md#platform-specific-configuration) parameter.\nThe options accepted by TileDB SOMA are described here, using [TypeScript interface syntax](https://www.typescriptlang.org/docs/handbook/2/objects.html):\n\n```typescript\ninterface PlatformConfig {\n tiledb?: TDBConfig;\n}\n\ninterface TDBConfig {\n create?: TDBCreateOptions;\n}\n\ninterface TDBCreateOptions {\n dims?: { [dim: string]: TDBDimension };\n attrs?: { [attr: string]: TDBAttr };\n allows_duplicates?: bool;\n\n offsets_filters?: TDBFilter[];\n validity_filters?: TDBFilter[];\n\n capacity?: number;\n cell_order?: string;\n tile_order?: string;\n}\n\ninterface TDBDimension {\n filters?: TDBFilter[];\n tile?: number;\n}\n\ninterface TDBAttr {\n filters?: TDBFilter[];\n}\n\n/**\n * Either the name of a filter (in which case it will use\n * the default arguments) or a specification with filter args.\n */\ntype TDBFilter = string | TDBFilterSpec;\n\ninterface TDBFilterSpec {\n /** The name of the filter. */\n _name: string;\n /** kwargs that are passed when constructing the filter. */\n [kwarg: string]: any;\n}\n```\n\n# Information for developers\n\nPlease see the [TileDB-SOMA wiki](https://github.com/single-cell-data/TileDB-SOMA/wiki).\n\n<!-- temp for readthedocs testing -->\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python API for efficient storage and retrieval of single-cell data using TileDB",
"version": "1.14.5",
"project_urls": {
"Homepage": "https://github.com/single-cell-data/TileDB-SOMA/tree/main/apis/python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09f5b864ac5ac3639d45b926544f1b7dcdf4d69f57bdd930b82ccf17e6dccfbd",
"md5": "079bdf8509421d9d5f0530b664d754fa",
"sha256": "28b73648d5dea11aa9fc99224000d95d791137710e5e3b1b356ae6ba38969e71"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "079bdf8509421d9d5f0530b664d754fa",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 22973242,
"upload_time": "2024-10-23T20:53:34",
"upload_time_iso_8601": "2024-10-23T20:53:34.800165Z",
"url": "https://files.pythonhosted.org/packages/09/f5/b864ac5ac3639d45b926544f1b7dcdf4d69f57bdd930b82ccf17e6dccfbd/tiledbsoma-1.14.5-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0be7a6cdc23c8f5fe561efd1601159515175b44336d0dde51ae788f607c998de",
"md5": "120dcf4a31a82dd51d6fffde476c1029",
"sha256": "de3c4c21dbfd21900d6602cbfaa3f49aa0b6e3a8fcc7e75d1e0b150f9cb18069"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp310-cp310-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "120dcf4a31a82dd51d6fffde476c1029",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 25875261,
"upload_time": "2024-10-23T20:53:37",
"upload_time_iso_8601": "2024-10-23T20:53:37.788759Z",
"url": "https://files.pythonhosted.org/packages/0b/e7/a6cdc23c8f5fe561efd1601159515175b44336d0dde51ae788f607c998de/tiledbsoma-1.14.5-cp310-cp310-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecc6fba3bd05c44543dd5552a2d847cadcfd3bdc72f665cbb424feb69ca04ce9",
"md5": "019a029551d1490370552333bb6a4592",
"sha256": "9a9210c6f953ad22085058d19ad32cf21c393414aa436afcd833c8b6ad2cd957"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "019a029551d1490370552333bb6a4592",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 17505315,
"upload_time": "2024-10-23T20:53:40",
"upload_time_iso_8601": "2024-10-23T20:53:40.702332Z",
"url": "https://files.pythonhosted.org/packages/ec/c6/fba3bd05c44543dd5552a2d847cadcfd3bdc72f665cbb424feb69ca04ce9/tiledbsoma-1.14.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2782eb8887a04096df2c3879b5e5566e7a7acff561e657f2d7b8d39f28df7a2",
"md5": "a0d20e837d12c0de9dda8485725d2d4a",
"sha256": "8942ee6e024db2d9bbf5b8dd9070ea57ee3e66eb1827e7c6b945a7aeada9494b"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "a0d20e837d12c0de9dda8485725d2d4a",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9",
"size": 22975183,
"upload_time": "2024-10-23T20:53:43",
"upload_time_iso_8601": "2024-10-23T20:53:43.419872Z",
"url": "https://files.pythonhosted.org/packages/c2/78/2eb8887a04096df2c3879b5e5566e7a7acff561e657f2d7b8d39f28df7a2/tiledbsoma-1.14.5-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be8659a200b017414935d169cbbdd6a70e2058cb00579a37967edbf24a81ffa4",
"md5": "8de3e1e0ae244a7fa8c3c6049c63d42c",
"sha256": "43e132a320f38aa1620b9189dda98375beffe99a9a5fd9a54b3fb994eef1cca9"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp311-cp311-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "8de3e1e0ae244a7fa8c3c6049c63d42c",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9",
"size": 25876447,
"upload_time": "2024-10-23T20:53:45",
"upload_time_iso_8601": "2024-10-23T20:53:45.880430Z",
"url": "https://files.pythonhosted.org/packages/be/86/59a200b017414935d169cbbdd6a70e2058cb00579a37967edbf24a81ffa4/tiledbsoma-1.14.5-cp311-cp311-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4da43839d2edad6f31a1315f671771bbddccabe7acfcf2556d39cdebbc54e9b",
"md5": "b767e0f6e4f1edbbc2e7a5d732176c43",
"sha256": "87f7afac29ef7d9f284cc1c1ed538b3f39380bee1bf7cf977a4c0c9dbf156c62"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "b767e0f6e4f1edbbc2e7a5d732176c43",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.9",
"size": 17511026,
"upload_time": "2024-10-23T20:53:48",
"upload_time_iso_8601": "2024-10-23T20:53:48.445053Z",
"url": "https://files.pythonhosted.org/packages/c4/da/43839d2edad6f31a1315f671771bbddccabe7acfcf2556d39cdebbc54e9b/tiledbsoma-1.14.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b4f27efa7885b6f88566e45a60923515bcbf073f8ea1782cea45a8e6a07eeab",
"md5": "9b9c3021c7d28fc3d39b056fc5ca6706",
"sha256": "737d1b2699298171101a00879f66c18c0b68fb1746822123d0b8bc541febc3be"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp39-cp39-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "9b9c3021c7d28fc3d39b056fc5ca6706",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 22973498,
"upload_time": "2024-10-23T20:53:51",
"upload_time_iso_8601": "2024-10-23T20:53:51.230916Z",
"url": "https://files.pythonhosted.org/packages/0b/4f/27efa7885b6f88566e45a60923515bcbf073f8ea1782cea45a8e6a07eeab/tiledbsoma-1.14.5-cp39-cp39-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "851e9c3459480561b0279d1d285e1daafbca19ddb61a286ac6744edb0a173c64",
"md5": "6c3b7b675dfc6e80f9cdd983ab0c3067",
"sha256": "9205bf718d561fc5fbee9590ba44e434a9f6c65a50eb037e7e8521f71bb12c05"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp39-cp39-macosx_11_0_x86_64.whl",
"has_sig": false,
"md5_digest": "6c3b7b675dfc6e80f9cdd983ab0c3067",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 25875441,
"upload_time": "2024-10-23T20:53:54",
"upload_time_iso_8601": "2024-10-23T20:53:54.014804Z",
"url": "https://files.pythonhosted.org/packages/85/1e/9c3459480561b0279d1d285e1daafbca19ddb61a286ac6744edb0a173c64/tiledbsoma-1.14.5-cp39-cp39-macosx_11_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c58a121650c183889bfc09d5a4fe3425bb5398fed17aee60b68913f818bf038b",
"md5": "ead2f1fa2b7bfddcf1622e48ec699d44",
"sha256": "dd4d319cf4fac814854e747bdcd8f9ea0869183b80fd3c1d49bdf31e16a64f1f"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "ead2f1fa2b7bfddcf1622e48ec699d44",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.9",
"size": 17506064,
"upload_time": "2024-10-23T20:53:57",
"upload_time_iso_8601": "2024-10-23T20:53:57.017972Z",
"url": "https://files.pythonhosted.org/packages/c5/8a/121650c183889bfc09d5a4fe3425bb5398fed17aee60b68913f818bf038b/tiledbsoma-1.14.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c8442642b0a8705df6896f63d57f8db72a49457f74721dd072afd5aacc408a0f",
"md5": "c705a783523ff7127549c23f92dbaa90",
"sha256": "77a54647d2c8329b84a88303e915229dff81a62ecb46bd6d84cb931ca45d94ff"
},
"downloads": -1,
"filename": "tiledbsoma-1.14.5.tar.gz",
"has_sig": false,
"md5_digest": "c705a783523ff7127549c23f92dbaa90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 454586,
"upload_time": "2024-10-23T20:53:59",
"upload_time_iso_8601": "2024-10-23T20:53:59.529039Z",
"url": "https://files.pythonhosted.org/packages/c8/44/2642b0a8705df6896f63d57f8db72a49457f74721dd072afd5aacc408a0f/tiledbsoma-1.14.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 20:53:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "single-cell-data",
"github_project": "TileDB-SOMA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tiledbsoma"
}
JSON
