iris-ued 5.0.0

Ultrafast electron diffraction data exploration

Iris is both a library for interacting with ultrafast electron diffraction data, as well as a GUI frontend for interactively exploring this data.

Iris also includes a plug-in manager so that you can explore your data.

Installation

To install the latest development version from Github:

python -m pip install git+git://github.com/LaurentRDC/iris-ued.git

Iris is available on PyPI; it can be installed with pip.:

python -m pip install iris-ued

Each version is tested against Python 3.6. If you are using a different version, tests can be run using the standard library’s unittest module.

Usage

Once installed, the package can be imported as iris.

The GUI component can be launched from a command line interpreter as python -m iris or pythonw -m iris (no console window).

Documentation

The Documentation on readthedocs.io provides API-level documentation, as well as tutorials.

Support / Report Issues

All support requests and issue reports should be filed on Github as an issue.

License

iris is made available under the MIT License. For more details, see LICENSE.txt.