iris-ued 5.4.0

Ultrafast electron diffraction data exploration

Iris - Ultrafast Electron Scattering 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.

Contents:

• Installation
• Usage
• Test Data
• Documentation
• Citations
• Support / Report Issues
• License

Installation

To interact with iris datasets from a Python environment, the iris package must be installed. iris is available on PyPI; it can be installed with pip.:

python -m pip install iris-ued

iris is also available on the conda-forge channel:

conda config --add channels conda-forge
conda install iris-ued

To install the latest development version from Github:

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

Each version is tested against Python 3.8+. If you are using a different version, tests can be run using the pytest package.

Windows Installers

For Windows, installers are available on the Releases page. You will still need to install iris via pip or conda to use the scripting functionality.

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). See the documentation for a visual guide.

Documentation

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

Citations

If you find this software useful, please consider citing the following publication:

L. P. René de Cotret, M. R. Otto, M. J. Stern. and B. J. Siwick, An open-source software ecosystem for the interactive exploration of ultrafast electron scattering data, Advanced Structural and Chemical Imaging 4:11 (2018) DOI: 10.1186/s40679-018-0060-y.

If you are using the baseline-removal functionality of iris-ued, please consider citing the following publication:

L. P. René de Cotret and B. J. Siwick, A general method for baseline-removal in ultrafast electron powder diffraction data using the dual-tree complex wavelet transform, Struct. Dyn. 4 (2017) DOI: 10.1063/1.4972518.

Support / Report Issues

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

License

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