{"id":19226049,"url":"https://github.com/openpmd/openpmd-viewer","last_synced_at":"2025-05-16T13:07:21.742Z","repository":{"id":2198366,"uuid":"43901924","full_name":"openPMD/openPMD-viewer","owner":"openPMD","description":":snake: Python visualization tools for openPMD files","archived":false,"fork":false,"pushed_at":"2025-04-13T13:53:33.000Z","size":3641,"stargazers_count":68,"open_issues_count":74,"forks_count":50,"subscribers_count":10,"default_branch":"dev","last_synced_at":"2025-05-16T13:07:17.697Z","etag":null,"topics":["community","jupyter-notebook","openpmd","openscience","research","visualization"],"latest_commit_sha":null,"homepage":"https://openpmd-viewer.readthedocs.io/","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/openPMD.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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,"zenodo":null}},"created_at":"2015-10-08T16:22:47.000Z","updated_at":"2024-12-17T02:20:00.000Z","dependencies_parsed_at":"2023-07-05T19:33:30.848Z","dependency_job_id":"d9eda164-b821-49cc-8b6d-335bbfc8365c","html_url":"https://github.com/openPMD/openPMD-viewer","commit_stats":{"total_commits":681,"total_committers":24,"mean_commits":28.375,"dds":0.42143906020558,"last_synced_commit":"dc4e54433d756377f371874bd971c61c3cb7b2b6"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openPMD","download_url":"https://codeload.github.com/openPMD/openPMD-viewer/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254535829,"owners_count":22087399,"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":["community","jupyter-notebook","openpmd","openscience","research","visualization"],"created_at":"2024-11-09T15:17:10.328Z","updated_at":"2025-05-16T13:07:21.722Z","avatar_url":"https://github.com/openPMD.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openPMD-viewer\r\n\r\n[![pypi version](https://img.shields.io/pypi/v/openPMD-viewer.svg)](https://pypi.python.org/pypi/openPMD-viewer)\r\n[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/dev?filepath=docs/source/tutorials%2F)\r\n[![License](https://img.shields.io/pypi/l/openPMD-viewer.svg)](LICENSE.txt)\r\n\r\n## Overview\r\n\r\nThis package contains a set of tools to load and visualize the\r\ncontents of a set of [openPMD](http://www.openpmd.org/#/start) files\r\n(typically, a timeseries).\r\n\r\nThe routines of `openPMD-viewer` can be used in two ways :\r\n\r\n- Use the **Python API**, in order to write a script that loads the\r\n  data and produces a set of pre-defined plots.\r\n\r\n- Use the **interactive GUI inside the Jupyter Notebook**, in order to interactively\r\nvisualize the data.\r\n\r\n## Usage\r\n\r\n### Tutorials\r\n\r\nThe notebooks in the folder `tutorials/` demonstrate how to use both\r\nthe API and the interactive GUI. You can view these notebooks online\r\n[here](https://github.com/openPMD/openPMD-viewer/tree/dev/docs/source/tutorials).\r\n\r\nAlternatively, you can even\r\n[*run* our tutorials online](https://mybinder.org/v2/gh/openPMD/openPMD-viewer/dev?filepath=docs/source/tutorials%2F)!\r\n\r\nYou can also download and run these notebooks on your local computer\r\n(when viewing the notebooks with the above link, click on `Raw` to be able to\r\nsave them to your local computer). In order to run the notebook on\r\nyour local computer, please install `openPMD-viewer` first (see\r\nbelow), as well as `wget` (`pip install wget`).\r\n\r\n### Notebook quick-starter\r\n\r\nIf you wish to use the **interactive GUI**, the installation of\r\n`openPMD-viewer` provides a convenient executable which automatically\r\n**creates a new pre-filled notebook** and **opens it in a\r\nbrowser**. To use this executable, simply type in a regular terminal:\r\n\r\n`openPMD_notebook`\r\n\r\n(This executable is installed by default, when installing `openPMD-viewer`.)\r\n\r\n## Installation\r\n\r\n### Installation on a local computer\r\n\r\n#### Installation with conda\r\n\r\nIn order to install `openPMD-viewer` with `conda`, please install the [Anaconda\r\ndistribution](https://docs.anaconda.com/anaconda/install/), and then type\r\n```\r\nconda install -c conda-forge openpmd-viewer\r\n```\r\nIf you are using JupyterLab, please also install the `jupyter-matplotlib`\r\nextension (See installation instructions\r\n[here](https://github.com/matplotlib/jupyter-matplotlib)).\r\n\r\n#### Installation with pip\r\n\r\nYou can also install `openPMD-viewer` using `pip`\r\n```\r\npip install openpmd-viewer\r\n```\r\nIn addition, if you wish to use the interactive GUI, please type\r\n```\r\npip install jupyter\r\n```\r\n\r\n### Installation on a remote scientific cluster\r\n\r\nIf you wish to install the `openPMD-viewer` on a remote scientific\r\ncluster, please make sure that the packages `numpy`, `scipy` and `h5py`\r\nare available in your environment. This is typically done by a set of\r\n`module load` commands (e.g. `module load h5py`) -- please refer to\r\nthe documentation of your scientific cluster.\r\n\r\nThen type\r\n```\r\npip install openPMD-viewer --user\r\n```\r\n\r\nNote: The package `jupyter` is only required for the **interactive\r\nGUI** and thus it does not need to be installed if you are only using\r\nthe **Python API**.  For [NERSC](http://www.nersc.gov/) users, access to Jupyter\r\nnotebooks is provided when logging to\r\n[https://ipython.nersc.gov](https://ipython.nersc.gov).\r\n\r\n## Contributing to the openPMD-viewer\r\n\r\nWe welcome contributions to the code! Please read [this page](https://github.com/openPMD/openPMD-viewer/blob/dev/CONTRIBUTING.md) for\r\nguidelines on how to contribute.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpmd%2Fopenpmd-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpmd%2Fopenpmd-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpmd%2Fopenpmd-viewer/lists"}