Ultrafast electron diffraction data exploration
Project description
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
Starting with iris 5.1.0, Windows standalone installers are now available!. This will install iris as a standalone program, completely independent from other Python installations on your system. This way should be preferred for those who do not need to interact with data outside of iris. Standalone installers are available on the releases page.
To interact with iris datasets from a Python environment, the iris-ued 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.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).
Test Data
Test datasets are made available on the Siwick research group public data server, which can be accessed anonymously here.
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 publications:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.