Skip to main content

Visualization tools for openPMD files

Project description

Build Status master Build Status dev pypi version License

Overview

This package contains a set of tools to load and visualize the contents of a set of openPMD files (typically, a timeseries).

The routines of openPMD-viewer can be used in two ways :

  • Use the Python API, in order to write a script that loads the data and produces a set of pre-defined plots.

  • Use the interactive GUI inside the Jupyter Notebook, in order to interactively visualize the data.

Usage

Tutorials

The notebooks in the folder tutorials/ demonstrate how to use both the API and the interactive GUI. You can view these notebooks online here.

You can also download and run these notebooks on your local computer (when viewing the notebooks with the above link, click on Raw to be able to save them to your local computer). In order to run the notebook on your local computer, please install openPMD-viewer first (see below), as well as wget (pip install wget).

Notebook quick-starter

If you wish to use the interactive GUI, the installation of openPMD-viewer provides a convenient executable which automatically creates a new pre-filled notebook and opens it in a browser. To use this executable, simply type in a regular terminal:

openPMD_notebook

(This executable is installed by default, when installing openPMD-viewer.)

Installation

Installation on a local computer

Installation with pip

If you cannot install openPMD-viewer with conda, the alternative is to use pip. However, you need to first make sure that h5py is installed on your local computer. This can be done for instance by typing pip install h5py, though this may require you to install hdf5 separately.

Once h5py is installed, simply type

pip install openPMD-viewer

In addition, if you wish to use the interactive GUI, please type

pip install jupyter

Installation on a remote scientific cluster

If you wish to install the openPMD-viewer on a remote scientific cluster, please make sure that the packages numpy, scipy and h5py are available in your environment. This is typically done by a set of module load commands (e.g. module load h5py) – please refer to the documentation of your scientific cluster.

Then type

pip install openPMD-viewer --user

Note: The package jupyter is only required for the interactive GUI and thus it does not need to be installed if you are only using the Python API. For NERSC users, access to Jupyter notebooks is provided when logging to https://ipython.nersc.gov.

Contributing to the openPMD-viewer

We welcome contributions to the code! Please read this page for guidelines on how to contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openPMD-viewer-0.5.0.tar.gz (75.4 kB view details)

Uploaded Source

Built Distribution

openPMD_viewer-0.5.0-cp27-cp27m-macosx_10_6_x86_64.whl (68.9 kB view details)

Uploaded CPython 2.7m macOS 10.6+ x86-64

File details

Details for the file openPMD-viewer-0.5.0.tar.gz.

File metadata

File hashes

Hashes for openPMD-viewer-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c31a3414d3135f35b6f7bd24a3bfb27442a1ade137770d4a43910b80516987ee
MD5 82374a829280ce261fc8c5030f2be9af
BLAKE2b-256 b91634a030ff65650292b4179fba01d738be554ecdbbebbb81b4d15025160cc1

See more details on using hashes here.

File details

Details for the file openPMD_viewer-0.5.0-cp27-cp27m-macosx_10_6_x86_64.whl.

File metadata

File hashes

Hashes for openPMD_viewer-0.5.0-cp27-cp27m-macosx_10_6_x86_64.whl
Algorithm Hash digest
SHA256 c022a25a155ace24104906867085b6f8186df42027c341abdef329ff1abe4f57
MD5 312517d02d13812716ac300b37255d81
BLAKE2b-256 a6cea41ec494b777b0b8ae8bbff0bd7e0b45f02ae0aea226f8fbb551d4aecbf1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page