{"id":20399821,"url":"https://github.com/kitware/pan3d","last_synced_at":"2025-04-12T13:41:55.015Z","repository":{"id":39885726,"uuid":"487981863","full_name":"Kitware/pan3d","owner":"Kitware","description":"Python library for easily loading, interacting and visualizing XArray dataset using VTK and trame.","archived":false,"fork":false,"pushed_at":"2025-04-07T23:17:29.000Z","size":101704,"stargazers_count":19,"open_issues_count":33,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-07T23:35:41.616Z","etag":null,"topics":["3d","trame","visualization","vtk","xarray","xarray-accessor"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kitware.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-02T20:29:51.000Z","updated_at":"2025-04-07T23:17:31.000Z","dependencies_parsed_at":"2023-09-26T18:53:35.524Z","dependency_job_id":"3ae0b497-cebd-4553-a5e3-9b03b0490f6c","html_url":"https://github.com/Kitware/pan3d","commit_stats":null,"previous_names":["kitware/geo-trame","kitware/pan3d"],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fpan3d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fpan3d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fpan3d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kitware%2Fpan3d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kitware","download_url":"https://codeload.github.com/Kitware/pan3d/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248574519,"owners_count":21127031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","trame","visualization","vtk","xarray","xarray-accessor"],"created_at":"2024-11-15T04:34:00.852Z","updated_at":"2025-04-12T13:41:55.010Z","avatar_url":"https://github.com/Kitware.png","language":"Python","readme":"# Pan3D\n\n\u003cimg style=\"display: inline-block;\" src=\"https://media.githubusercontent.com/media/Kitware/pan3d/main/docs/images/kitware.svg\" alt=\"Kitware Logo\" href=\"https://kitware.com\" width=\"100\"\u003e\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. [Read The Doc][docs-link] is available for additional information.\n\nXArray Viewer is a Pan3D application focused on geospatial rendering use cases. This is a graphical user interface leveraging the Pan3D infrastructure to help geospatial scientists explore data.\n\n![](images/xr-viewer-esgf-00.jpg)\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 Pan3D VTK mesh builder class only:\n\n    pip install pan3d\n\nTo install requirements for the graphical user interface (viewers + explorers):\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`xr-viewer` is the main entrypoint for launching XArray Viewer locally. Below are some example usages.\n\nTo launch XArray Viewer without a target dataset to browse XArray examples:\n\n    xr-viewer\n\nTo launch XArray Viewer with a local path to a target dataset:\n\n    xr-viewer --xarray-file ./examples/example_dataset.nc\n\nTo launch XArray Viewer with a remote URL to a target dataset:\n\n    xr-viewer --xarray-url https://host.org/link/to/dataset.zarr\n\nTo launch XArray Viewer with a compatible configuration file (see [examples][examples-link]):\n\n    xr-viewer --import-state ./examples/example_config_xarray.json\n\nTo launch the Catalog browser will allow you to query the Pangeo and ESGF Dataset Catalogs (see [Catalogs Tutorial](tutorials/catalogs.md)) depending on the available dependencies:\n\n    xr-catalog\n\nYou may have to install the required dependencies:\n\n    pip install \"pan3d[pangeo]\"\n    pip install \"pan3d[esgf]\"\n\n\n\u003e The `xr-viewer` entrypoint will automatically launch your default browser to open `localhost:8080`.\n\u003e\n\u003e To launch without opening your browser, add the `--server` argument to your command.\n\n\n## Tutorials\n\n- [How to use XArray Viewer](tutorials/dataset_viewer.md)\n- [XArray Viewer command line](tutorials/command_line.md)\n- [Catalogs Tutorial](tutorials/catalogs.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\u003c!-- Links --\u003e\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Fpan3d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitware%2Fpan3d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitware%2Fpan3d/lists"}