# Pan3D
<img style="display: inline-block;" src="images/kitware.svg" alt="Kitware Logo" href="https://kitware.com" width="100">
[![Documentation Status][docs-image]][docs-link]
[![Binder][binder-image]][binder-link]
[![Build Status][GHAction-image]][GHAction-link]
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![License][apache-license-image]][license-link]
Pan3D aims to be an utility package for viewing and processing a wide variety of multidimensional datasets. Any dataset that can be interpreted with [xarray][xarray-link] can be explored and rendered with Pan3D.
For an introduction to this project, check out our [blog post][blog-post-link].
## Installation
To install requirements for the DatasetBuilder class only:
pip install pan3d
To install requirements for the DatasetViewer user interface:
pip install pan3d[viewer]
**Optional**: to install requirements for Pangeo and ESGF catalogs, respectively:
pip install pan3d[pangeo]
pip install pan3d[esgf]
**Recommended**: To install all requirements, including optional packages:
pip install pan3d[all]
## Quick Start
`pan3d-viewer` is the main entrypoint for launching Pan3D locally. Below are some example usages.
To launch Pan3D without a target dataset to browse XArray examples:
pan3d-viewer
To launch Pan3D with a local path to a target dataset:
pan3d-viewer --dataset=/path/to/dataset.zarr
To launch Pan3D with a remote URL to a target dataset:
pan3d-viewer --dataset=https://host.org/link/to/dataset.zarr
To launch Pan3D with a compatible configuration file (see [examples][examples-link]):
pan3d-viewer --config_path=/path/to/pan3d_state.json
To launch Pan3D with the option to browse the Pangeo and ESGF Dataset Catalogs:
pan3d-viewer --catalogs pangeo esgf
Or you may specify only one catalog:
pan3d-viewer --catalogs pangeo
pan3d-viewer --catalogs esgf
> The `pan3d-viewer` entrypoint will automatically launch your default browser to open `localhost:8080`.
>
> To launch without opening your browser, add the `--server` argument to your command.
## Tutorials
- [How to use the Pan3D viewer](tutorials/dataset_viewer.md)
- [Pan3D command line](tutorials/local_server.md)
- [How to use Pan3D in a Jupyter notebook](tutorials/jupyter_notebook.md)
## Examples
Pan3D comes with a set of example configuration files and example Jupyter notebooks in the [examples][examples-link] folder. You can checkout the repository to run these locally, or you can use the [Pan3D Binder instance][binder-link] to run these examples.
<!-- Links -->
[docs-image]: https://readthedocs.org/projects/pan3d/badge/?version=latest
[docs-link]: https://pan3d.readthedocs.io/en/latest
[binder-image]: https://mybinder.org/badge_logo.svg
[binder-link]: https://mybinder.org/v2/gh/Kitware/pan3d/main?labpath=examples%2Fjupyter
[GHAction-image]: https://github.com/Kitware/pan3d/workflows/Test/badge.svg
[GHAction-link]: https://github.com/Kitware/pan3d/actions?query=event%3Apush+branch%3Amain
[pypi-v-image]: https://img.shields.io/pypi/v/pan3d.svg
[pypi-v-link]: https://pypi.org/project/pan3d/
[apache-license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg
[license-link]: https://raw.githubusercontent.com/Kitware/pan3d/main/LICENSE
[xarray-link]: https://docs.xarray.dev/en/stable/user-guide/io.html
[blog-post-link]: https://www.kitware.com/kitware-introduces-pan3d-a-collaborative-interoperable-visualization-tool/
[examples-link]: https://github.com/Kitware/pan3d/tree/main/examples
Raw data
{
"_id": null,
"home_page": null,
"name": "pan3d",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Python, Interactive, Web, Application, Framework",
"author": "Kitware Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4d/bc/0b49cfaf965b205feee6b11b82b65dcce8bb7d23db233e7b87d4f99ca496/pan3d-0.6.1.tar.gz",
"platform": null,
"description": "# Pan3D\n\n<img style=\"display: inline-block;\" src=\"images/kitware.svg\" alt=\"Kitware Logo\" href=\"https://kitware.com\" width=\"100\">\n\n[![Documentation Status][docs-image]][docs-link]\n[![Binder][binder-image]][binder-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![License][apache-license-image]][license-link]\n\nPan3D aims to be an utility package for viewing and processing a wide variety of multidimensional datasets. Any dataset that can be interpreted with [xarray][xarray-link] can be explored and rendered with Pan3D.\n\n\n\nFor an introduction to this project, check out our [blog post][blog-post-link].\n\n\n## Installation\n\nTo install requirements for the DatasetBuilder class only:\n\n pip install pan3d\n\nTo install requirements for the DatasetViewer user interface:\n\n pip install pan3d[viewer]\n\n**Optional**: to install requirements for Pangeo and ESGF catalogs, respectively:\n\n pip install pan3d[pangeo]\n\n pip install pan3d[esgf]\n\n**Recommended**: To install all requirements, including optional packages:\n\n pip install pan3d[all]\n\n## Quick Start\n\n`pan3d-viewer` is the main entrypoint for launching Pan3D locally. Below are some example usages.\n\nTo launch Pan3D without a target dataset to browse XArray examples:\n\n pan3d-viewer\n\nTo launch Pan3D with a local path to a target dataset:\n\n pan3d-viewer --dataset=/path/to/dataset.zarr\n\nTo launch Pan3D with a remote URL to a target dataset:\n\n pan3d-viewer --dataset=https://host.org/link/to/dataset.zarr\n\nTo launch Pan3D with a compatible configuration file (see [examples][examples-link]):\n\n pan3d-viewer --config_path=/path/to/pan3d_state.json\n\nTo launch Pan3D with the option to browse the Pangeo and ESGF Dataset Catalogs:\n\n pan3d-viewer --catalogs pangeo esgf\n\nOr you may specify only one catalog:\n\n pan3d-viewer --catalogs pangeo\n\n pan3d-viewer --catalogs esgf\n\n\n> The `pan3d-viewer` entrypoint will automatically launch your default browser to open `localhost:8080`.\n>\n> To launch without opening your browser, add the `--server` argument to your command.\n\n\n## Tutorials\n\n- [How to use the Pan3D viewer](tutorials/dataset_viewer.md)\n- [Pan3D command line](tutorials/local_server.md)\n- [How to use Pan3D in a Jupyter notebook](tutorials/jupyter_notebook.md)\n\n## Examples\n\nPan3D comes with a set of example configuration files and example Jupyter notebooks in the [examples][examples-link] folder. You can checkout the repository to run these locally, or you can use the [Pan3D Binder instance][binder-link] to run these examples.\n\n\n<!-- Links -->\n[docs-image]: https://readthedocs.org/projects/pan3d/badge/?version=latest\n[docs-link]: https://pan3d.readthedocs.io/en/latest\n[binder-image]: https://mybinder.org/badge_logo.svg\n[binder-link]: https://mybinder.org/v2/gh/Kitware/pan3d/main?labpath=examples%2Fjupyter\n[GHAction-image]: https://github.com/Kitware/pan3d/workflows/Test/badge.svg\n[GHAction-link]: https://github.com/Kitware/pan3d/actions?query=event%3Apush+branch%3Amain\n[pypi-v-image]: https://img.shields.io/pypi/v/pan3d.svg\n[pypi-v-link]: https://pypi.org/project/pan3d/\n[apache-license-image]: https://img.shields.io/badge/license-Apache%202-blue.svg\n[license-link]: https://raw.githubusercontent.com/Kitware/pan3d/main/LICENSE\n[xarray-link]: https://docs.xarray.dev/en/stable/user-guide/io.html\n[blog-post-link]: https://www.kitware.com/kitware-introduces-pan3d-a-collaborative-interoperable-visualization-tool/\n[examples-link]: https://github.com/Kitware/pan3d/tree/main/examples\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Utility package for processing and visualizing 3D datasets",
"version": "0.6.1",
"project_urls": null,
"split_keywords": [
"python",
" interactive",
" web",
" application",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0df1fe219e923450f5530ffe171abe695650f60e9ef3cc41b605a324e1c9875",
"md5": "126173f4688bba1ed7d125ce0c431de6",
"sha256": "75e72869823d87e3982bfee5959fb2d308e6d48b76955a8326639a9a08257f53"
},
"downloads": -1,
"filename": "pan3d-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "126173f4688bba1ed7d125ce0c431de6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 29923,
"upload_time": "2024-04-16T18:11:27",
"upload_time_iso_8601": "2024-04-16T18:11:27.150464Z",
"url": "https://files.pythonhosted.org/packages/f0/df/1fe219e923450f5530ffe171abe695650f60e9ef3cc41b605a324e1c9875/pan3d-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4dbc0b49cfaf965b205feee6b11b82b65dcce8bb7d23db233e7b87d4f99ca496",
"md5": "c864da6cf78a3a768ef98d0c56408d30",
"sha256": "8cb7bb26e2e2fffbed92e647678cb3845528b79b218a5c872811cc9dc82ce637"
},
"downloads": -1,
"filename": "pan3d-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "c864da6cf78a3a768ef98d0c56408d30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 28916,
"upload_time": "2024-04-16T18:11:28",
"upload_time_iso_8601": "2024-04-16T18:11:28.996331Z",
"url": "https://files.pythonhosted.org/packages/4d/bc/0b49cfaf965b205feee6b11b82b65dcce8bb7d23db233e7b87d4f99ca496/pan3d-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 18:11:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pan3d"
}
JSON