| Name | shadows JSON |
| Version |
0.1a2
JSON |
| download |
| home_page | None |
| Summary | Low-memory data interfaces for scverse |
| upload_time | 2024-12-06 01:14:50 |
| maintainer | None |
| docs_url | None |
| author | Danila Bredikhin |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2020, Danila Bredikhin All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src="./docs/img/shadows_header.jpg" data-canonical-src="./docs/img/shadows_header.svg" width="100%"/>
# Shadows
Shadows are on-disk interfaces for scverse data standards such as [AnnData](https://github.com/scverse/anndata) and [MuData](https://github.com/scverse/mudata).
It is an experimental project.
[](https://pypi.org/project/shadows)
## Installation
```
pip install shadows
# or
pip install git+https://github.com/scverse/shadows
```
## Features
The shadows library aims to implement the following features:
- [x] **Shadow objects**: Read-only AnnDataShadow and MuDataShadow for HDF5 files.
- [x] AnnDataShadow and MuDataShadow for Zarr files.
- [x] AnnDataShadow and MuDataShadow for Parquet-based serialization ([pqdata](https://github.com/gtca/pqdata)).
- [x] Data shadows for `.pqdata` and `.zarr` files on S3 storage.
### Shadow objects
Briefly, shadow objects simply work like this:
```py
from shadows import *
ash = AnnDataShadow("pbmc3k.h5ad")
msh = MuDataShadow("pbmc5k_citeseq.h5mu")
```
All the various features are showcased in the following tutorials:
- [Getting started with shadow objects](/docs/examples/shadow-objects.ipynb)
- [Advanced features of shadow objects](/docs/examples/shadows-features.ipynb)
Raw data
{
"_id": null,
"home_page": null,
"name": "shadows",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Danila Bredikhin <danila@stanford.edu>",
"keywords": null,
"author": "Danila Bredikhin",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bf/00/ceb5d4e06d34901a5e8fc2d2bc120cb0a37aafbce63be54d9b8b3430ce19/shadows-0.1a2.tar.gz",
"platform": null,
"description": "<img src=\"./docs/img/shadows_header.jpg\" data-canonical-src=\"./docs/img/shadows_header.svg\" width=\"100%\"/>\n\n# Shadows\n\nShadows are on-disk interfaces for scverse data standards such as [AnnData](https://github.com/scverse/anndata) and [MuData](https://github.com/scverse/mudata).\n\nIt is an experimental project.\n\n[](https://pypi.org/project/shadows)\n\n## Installation\n\n```\npip install shadows\n# or\npip install git+https://github.com/scverse/shadows\n```\n\n## Features\n\nThe shadows library aims to implement the following features:\n\n- [x] **Shadow objects**: Read-only AnnDataShadow and MuDataShadow for HDF5 files.\n\n- [x] AnnDataShadow and MuDataShadow for Zarr files.\n\n- [x] AnnDataShadow and MuDataShadow for Parquet-based serialization ([pqdata](https://github.com/gtca/pqdata)).\n\n- [x] Data shadows for `.pqdata` and `.zarr` files on S3 storage.\n\n\n### Shadow objects\n\nBriefly, shadow objects simply work like this:\n\n```py\nfrom shadows import *\nash = AnnDataShadow(\"pbmc3k.h5ad\")\nmsh = MuDataShadow(\"pbmc5k_citeseq.h5mu\")\n```\n\nAll the various features are showcased in the following tutorials:\n\n- [Getting started with shadow objects](/docs/examples/shadow-objects.ipynb)\n\n- [Advanced features of shadow objects](/docs/examples/shadows-features.ipynb)\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2020, Danila Bredikhin All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Low-memory data interfaces for scverse",
"version": "0.1a2",
"project_urls": {
"Documentation": "https://scverse.github.io/shadows",
"Home-page": "https://github.com/scverse/shadows",
"Source": "https://github.com/scverse/shadows"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a4079d1b2fa89affbe31e1af772cc9ca4f054f9b8888f28227c84a2d59025027",
"md5": "e93e54597612c5d1a83e56ffd39348cd",
"sha256": "22a95f690eaa8deec644c96fe6fbe5fb1c7e9ecb2ab15a9142577b1ad326c9fb"
},
"downloads": -1,
"filename": "shadows-0.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e93e54597612c5d1a83e56ffd39348cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19904,
"upload_time": "2024-12-06T01:14:49",
"upload_time_iso_8601": "2024-12-06T01:14:49.468452Z",
"url": "https://files.pythonhosted.org/packages/a4/07/9d1b2fa89affbe31e1af772cc9ca4f054f9b8888f28227c84a2d59025027/shadows-0.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf00ceb5d4e06d34901a5e8fc2d2bc120cb0a37aafbce63be54d9b8b3430ce19",
"md5": "f056ceaa6c106d5797ce9e826ab22376",
"sha256": "25567a3d90d6f3020113125dfc332dcc2a6183d68728dfbe7272cc8651111a77"
},
"downloads": -1,
"filename": "shadows-0.1a2.tar.gz",
"has_sig": false,
"md5_digest": "f056ceaa6c106d5797ce9e826ab22376",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18365,
"upload_time": "2024-12-06T01:14:50",
"upload_time_iso_8601": "2024-12-06T01:14:50.446873Z",
"url": "https://files.pythonhosted.org/packages/bf/00/ceb5d4e06d34901a5e8fc2d2bc120cb0a37aafbce63be54d9b8b3430ce19/shadows-0.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 01:14:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scverse",
"github_project": "shadows",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shadows"
}
