Skip to content

Latest commit

 

History

History
124 lines (78 loc) · 5.79 KB

CHANGELOG.md

File metadata and controls

124 lines (78 loc) · 5.79 KB
Raw

Change Log / Release Log for openPMD-viewer

0.8

This version introduces several improvements to the viewer:

  • The ability to read files that contain fields in different geometries (e.g. 3D fields and 2D slices).
  • Better support for files that do not contain mesh (or do not contain particles), including support for the openPMD 1.1.0 standard.
  • Cloud-In-Cell deposition in histograms.
  • Better handling of %matplotlib notebook for newer version of jupyter.

0.7.1

This version adds better support, when the local installation of matplotlib has issues:

  • The LpaDiagnostics can now work without matplotlib if needed.
  • The MacOSX matplotlib backend is now avoided, since there can be issues when using it in the latest version of Jupyter.

0.7.0

This version improves support for ipywidgets version 7, especially in the layout of the slider.

In addition, with this version of openPMD-viewer, matplotlib is not a strict requirement anymore. This allows lighter installation for users that need openPMD-viewer only as a data reader.

Finally, the calculation of the laser envelope in 2D has been improved (see PR 170). Note that the function wstd (which is not documented in the tutorial, but which some users might still use) has been renamed to w_std.

0.6.0

This version improves the layout of the Jupyter GUI and allows the user to select a particular region of the plots through this GUI.

In addition, support for massless particle (e.g. photons) was added. In this case, the momenta are returned in kg.m.s^-1, instead of using the dimensionless momenta.

0.5.4

This is version 0.5.4 of openPMD-viewer.

It adds support for Python 3.4 (which erroneously dropped in the past).

0.5.3

This is version 0.5.3 of openPMD-viewer.

It corrects some of the issues with the size of boxes and widgets in the interactive slider. In addition, the iteration number is now read from the hdf5 metadata, and not the name of the file.

0.5.2

This is version 0.5.2 of openPMD-viewer.

It fixes some of the installation issues associated with Cython.

0.5.1

This is version 0.5.1 of openPMD-viewer.

It corrects a minor bug in the dependencies of the package.

0.5.0

This is version 0.5.0 of openPMD-viewer.

This new version includes the ParticleTracker object, which allows user to track individual particles across different iterations, provided that their id is stored in the openPMD file. Also, starting with this version, openPMD-viewer now depends on Cython.

For more information on how to use the ParticleTracker, see the tutorial notebook.

0.4.0

This is version 0.4.0 of openPMD-viewer.

This new version includes:

  • support for 1D data
  • an additional option use_field_mesh when plotting the particle. When set to True, this option uses information from the field mesh to choose the parameters of the particle histograms (esp. the bins). This is useful in order to avoid plotting/binning artifacts (aliasing) when the particles are evenly spaced.

In addition, the package opmd_viewer now has an attribute __version__.

0.3.3

This is version 0.3.3 of openPMD-viewer.

This version fixed a bug with the executable openPMD_notebook. More precisely, the executable was not installed, when using pip or conda. In addition, it was failing with Python 3.

0.3.2

This is version 0.3.2 of openPMD-viewer. The following changes were introduced:

  • The conda recipe in conda_recipe/ was simplified and streamlined.
  • The documentation now explains how to install openPMD-viewer with conda, the instructions to release the package was put into a document RELEASING.md.
  • A file MANIFEST.in was added, to avoid issues with pip and Python 3.

0.3.1

This is version 0.3.1 of openPMD-viewer. This version introduces minor changes in the way the tests are run in setup.py. The aim of these changes are to prepare a conda release.

0.3.0

This is version 0.3.0 of openPMD-viewer. This version mainly adapts the interactive GUI so that it can be used with the newer version of ipwidgets (ipywidgets 5.0), while still being compatible with previous versions of ipwidgets. A number of other minor changes have been introduced:

  • In the method get_particle, the argument species is now optional in the case where there is only one species.
  • A number of methods in the LPA addons (LpaDiagnostics class) now have an optional argument plot, which allows to directly plot the data.

0.2.0

This is version 0.2.0 of openPMD-viewer. A number of minor changes and fixes have been made in order to make the package more general and to prepare it for a PyPI release. Here are the main changes:

  • Support for the deprecated widget package IPython.html has been dropped. From now on, users need to install the widget package ipywidgets, for the GUI to work.
  • The initialization of an OpenPMDTimeSeries object can now be made faster by setting the optional argument check_all_files to False.
  • The data reader can now support macroWeighted quantities. As consequence, output files from PIConGPU can now be correctly read.
  • The package does not assume anymore that all species contain the same particle quantities. For instance, the package will support a file that contains the positions of ions, and the positions, momenta and weighting of electrons. As part of this, the attribute OpenPMDTimeSeries.avail_ptcl_quantities has been replaced by a dictionary OpenPMDTimeSeries.avail_record_components.
  • This release introduces automatic PEP8 verification as part of the automatic tests that are run on Travis CI (see CONTRIBUTING.md).
  • The evaluation of the waist and duration of the laser is now based on Gaussian fit of the transverse and longtudinal profile respectively.