| Name | spatialdata-plot JSON |
| Version |
0.2.12
JSON |
| download |
| home_page | None |
| Summary | Static plotting for spatial data. |
| upload_time | 2025-09-10 16:29:41 |
| maintainer | None |
| docs_url | None |
| author | scverse |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2023, scverse®
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.
|
# spatialdata-plot: rich static plotting from SpatialData objects
[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]
[![Codecov][badge-codecov]][link-codecov]
[![Documentation][badge-pypi]][link-pypi]
[](https://anaconda.org/conda-forge/spatialdata-plot)
[](https://zenodo.org/badge/latestdoi/588223127)
[badge-tests]: https://img.shields.io/github/actions/workflow/status/scverse/spatialdata-plot/test.yaml?branch=main
[link-tests]: https://github.com/scverse/spatialdata-plot/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/spatialdata-plot
[badge-codecov]: https://codecov.io/gh/scverse/spatialdata-plot/branch/main/graph/badge.svg?token=C45F3ATSVI
[link-codecov]: https://app.codecov.io/gh/scverse/spatialdata-plot
[badge-pypi]: https://badge.fury.io/py/spatialdata_plot.svg
[link-pypi]: https://pypi.org/project/spatialdata-plot/
The `spatialdata-plot` package extends `spatialdata` with a declarative plotting API that enables to quickly visualize `spatialdata` objects and their respective elements (i.e. `images`, `labels`, `points` and `shapes`).
SpatialData’s plotting capabilities allow to quickly visualise all contained modalities.
The user can specify which elements should be rendered (images, labels, points, shapes) and specify certain parameters for each layer, such as for example the intent to color shapes by a gene’s expression profile or which color to use for which image channel.
When the plot is then eventually displayed, all transformations, alignments and coordinate systems are internally processed to form the final visualisation.
In concordance with the general SpatialData philosophy, all modalities of the major spatial technologies are supported out of the box.
<img src='https://raw.githubusercontent.com/scverse/spatialdata-plot/main/docs/spatialdata-plot.png'/>
## Getting started
For more information on the `spatialdata-plot` library, please refer to the [documentation](https://spatialdata.scverse.org/projects/plot/en/latest/index.html). In particular, the
- [API documentation][link-api].
- [Example notebooks][link-notebooks] (section "Visiualizations")
## Installation
You need to have Python 3.10 or newer installed on your system. If you don't have
Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
There are several alternative options to install spatialdata-plot:
1. Install the latest release of `spatialdata-plot` from `PyPI <https://pypi.org/project/spatialdata-plot/>`\_:
```bash
pip install spatialdata-plot
```
2. Install the latest development version:
```bash
pip install git+https://github.com/scverse/spatialdata-plot.git@main
```
## Contact
For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
If you found a bug, please use the [issue tracker][issue-tracker].
## Citation
Marconato, L., Palla, G., Yamauchi, K.A. et al. SpatialData: an open and universal data framework for spatial omics. Nat Methods (2024). https://doi.org/10.1038/s41592-024-02212-x
[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/scverse/spatialdata-plot/issues
[link-docs]: https://spatialdata-plot.readthedocs.io
[link-api]: https://spatialdata.scverse.org/projects/plot/en/stable/api.html
[link-design-doc]: https://spatialdata.scverse.org/en/stable/design_doc.html
[link-notebooks]: https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks.html
[//]: # "numfocus-fiscal-sponsor-attribution"
spatialdata-plot is part of the scverse® project ([website](https://scverse.org), [governance](https://scverse.org/about/roles)) and is fiscally sponsored by [NumFOCUS](https://numfocus.org/).
If you like scverse® and want to support our mission, please consider making a tax-deductible [donation](https://numfocus.org/donate-to-scverse) to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.
<div align="center">
<a href="https://numfocus.org/project/scverse">
<img
src="https://raw.githubusercontent.com/numfocus/templates/master/images/numfocus-logo.png"
width="200"
>
</a>
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "spatialdata-plot",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "scverse <tim.treis@helmholtz-munich.de>",
"keywords": null,
"author": "scverse",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c2/af/b0536d2f7c3f44acedacac09de98c93cc165fc082a042b011b6e5a96961f/spatialdata_plot-0.2.12.tar.gz",
"platform": null,
"description": "\n\n# spatialdata-plot: rich static plotting from SpatialData objects\n\n[![Tests][badge-tests]][link-tests]\n[![Documentation][badge-docs]][link-docs]\n[![Codecov][badge-codecov]][link-codecov]\n[![Documentation][badge-pypi]][link-pypi]\n[](https://anaconda.org/conda-forge/spatialdata-plot)\n[](https://zenodo.org/badge/latestdoi/588223127)\n\n[badge-tests]: https://img.shields.io/github/actions/workflow/status/scverse/spatialdata-plot/test.yaml?branch=main\n[link-tests]: https://github.com/scverse/spatialdata-plot/actions/workflows/test.yml\n[badge-docs]: https://img.shields.io/readthedocs/spatialdata-plot\n[badge-codecov]: https://codecov.io/gh/scverse/spatialdata-plot/branch/main/graph/badge.svg?token=C45F3ATSVI\n[link-codecov]: https://app.codecov.io/gh/scverse/spatialdata-plot\n[badge-pypi]: https://badge.fury.io/py/spatialdata_plot.svg\n[link-pypi]: https://pypi.org/project/spatialdata-plot/\n\nThe `spatialdata-plot` package extends `spatialdata` with a declarative plotting API that enables to quickly visualize `spatialdata` objects and their respective elements (i.e. `images`, `labels`, `points` and `shapes`).\n\nSpatialData\u2019s plotting capabilities allow to quickly visualise all contained modalities.\nThe user can specify which elements should be rendered (images, labels, points, shapes) and specify certain parameters for each layer, such as for example the intent to color shapes by a gene\u2019s expression profile or which color to use for which image channel.\nWhen the plot is then eventually displayed, all transformations, alignments and coordinate systems are internally processed to form the final visualisation.\nIn concordance with the general SpatialData philosophy, all modalities of the major spatial technologies are supported out of the box.\n\n<img src='https://raw.githubusercontent.com/scverse/spatialdata-plot/main/docs/spatialdata-plot.png'/>\n\n## Getting started\n\nFor more information on the `spatialdata-plot` library, please refer to the [documentation](https://spatialdata.scverse.org/projects/plot/en/latest/index.html). In particular, the\n\n- [API documentation][link-api].\n- [Example notebooks][link-notebooks] (section \"Visiualizations\")\n\n## Installation\n\nYou need to have Python 3.10 or newer installed on your system. If you don't have\nPython installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).\n\nThere are several alternative options to install spatialdata-plot:\n\n1. Install the latest release of `spatialdata-plot` from `PyPI <https://pypi.org/project/spatialdata-plot/>`\\_:\n\n```bash\npip install spatialdata-plot\n```\n\n2. Install the latest development version:\n\n```bash\npip install git+https://github.com/scverse/spatialdata-plot.git@main\n```\n\n## Contact\n\nFor questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].\nIf you found a bug, please use the [issue tracker][issue-tracker].\n\n## Citation\n\nMarconato, L., Palla, G., Yamauchi, K.A. et al. SpatialData: an open and universal data framework for spatial omics. Nat Methods (2024). https://doi.org/10.1038/s41592-024-02212-x\n\n[scverse-discourse]: https://discourse.scverse.org/\n[issue-tracker]: https://github.com/scverse/spatialdata-plot/issues\n[link-docs]: https://spatialdata-plot.readthedocs.io\n[link-api]: https://spatialdata.scverse.org/projects/plot/en/stable/api.html\n[link-design-doc]: https://spatialdata.scverse.org/en/stable/design_doc.html\n[link-notebooks]: https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks.html\n[//]: # \"numfocus-fiscal-sponsor-attribution\"\n\nspatialdata-plot is part of the scverse\u00ae project ([website](https://scverse.org), [governance](https://scverse.org/about/roles)) and is fiscally sponsored by [NumFOCUS](https://numfocus.org/).\nIf you like scverse\u00ae and want to support our mission, please consider making a tax-deductible [donation](https://numfocus.org/donate-to-scverse) to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.\n\n<div align=\"center\">\n<a href=\"https://numfocus.org/project/scverse\">\n <img\n src=\"https://raw.githubusercontent.com/numfocus/templates/master/images/numfocus-logo.png\"\n width=\"200\"\n >\n</a>\n</div>\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2023, scverse\u00ae\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Static plotting for spatial data.",
"version": "0.2.12",
"project_urls": {
"Documentation": "https://spatialdata.scverse.org/projects/plot/en/latest/index.html",
"Home-page": "https://github.com/scverse/spatialdata-plot.git",
"Source": "https://github.com/scverse/spatialdata-plot.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d585af535648e89b3084a0fd8f9f765e07eedcb2a5b96e7dedd0b8e541109de9",
"md5": "4cdd773ac0b733df8d322b8f2753a188",
"sha256": "a49868b860fd065d255da2ebdce5e42eaf0a3af5d29fb768fed8c37483729bc4"
},
"downloads": -1,
"filename": "spatialdata_plot-0.2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cdd773ac0b733df8d322b8f2753a188",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 48691,
"upload_time": "2025-09-10T16:29:38",
"upload_time_iso_8601": "2025-09-10T16:29:38.360339Z",
"url": "https://files.pythonhosted.org/packages/d5/85/af535648e89b3084a0fd8f9f765e07eedcb2a5b96e7dedd0b8e541109de9/spatialdata_plot-0.2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c2afb0536d2f7c3f44acedacac09de98c93cc165fc082a042b011b6e5a96961f",
"md5": "69bab8c97e87d10bd1749782934c74a9",
"sha256": "76bade5a7d4906b2fb75d70a071370883d821914c1202fa20b88447bea22bbfd"
},
"downloads": -1,
"filename": "spatialdata_plot-0.2.12.tar.gz",
"has_sig": false,
"md5_digest": "69bab8c97e87d10bd1749782934c74a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 8790182,
"upload_time": "2025-09-10T16:29:41",
"upload_time_iso_8601": "2025-09-10T16:29:41.157139Z",
"url": "https://files.pythonhosted.org/packages/c2/af/b0536d2f7c3f44acedacac09de98c93cc165fc082a042b011b6e5a96961f/spatialdata_plot-0.2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-10 16:29:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scverse",
"github_project": "spatialdata-plot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spatialdata-plot"
}
