Metadata-Version: 2.0
Name: openPMD-viewer
Version: 0.3.2
Summary: Visualization tools for openPMD files
Home-page: https://github.com/openPMD/openPMD-viewer.git
Author: Remi Lehe
Author-email: remi.lehe@lbl.gov
License: BSD-3-Clause-LBNL
Platform: any
Classifier: Programming Language :: Python
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Database :: Front-Ends
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy

openPMD-viewer
==============

|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 <http://www.openpmd.org/#/start>`__ 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 <https://github.com/openPMD/openPMD-viewer/tree/master/tutorials>`__.

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 conda (recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In order to install ``openPMD-viewer`` with ``conda``, please install
the `Anaconda distribution <https://www.continuum.io/downloads>`__, and
then type

::

    conda install -c rlehe openpmd_viewer

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 <http://www.nersc.gov/>`__ 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 <https://github.com/openPMD/openPMD-viewer/blob/master/CONTRIBUTING.md>`__
for guidelines on how to contribute.

.. |Build Status master| image:: https://img.shields.io/travis/openPMD/openPMD-viewer/master.svg?label=master
   :target: https://travis-ci.org/openPMD/openPMD-viewer/branches
.. |Build Status dev| image:: https://img.shields.io/travis/openPMD/openPMD-viewer/dev.svg?label=dev
   :target: https://travis-ci.org/openPMD/openPMD-viewer/branches
.. |pypi version| image:: https://img.shields.io/pypi/v/openPMD-viewer.svg
   :target: https://pypi.python.org/pypi/openPMD-viewer
.. |License| image:: https://img.shields.io/pypi/l/openPMD-viewer.svg
   :target: LICENSE.txt


