Metadata-Version: 2.1
Name: iris-ued
Version: 5.2.4
Summary: Ultrafast electron diffraction data exploration
Home-page: http://iris-ued.readthedocs.io
Author: Laurent P. René de Cotret
Author-email: laurent.renedecotret@mail.mcgill.ca
Maintainer: Laurent P. René de Cotret
Maintainer-email: laurent.renedecotret@mail.mcgill.ca
License: GPLv3
Download-URL: http://github.com/LaurentRDC/iris-ued
Project-URL: Documentation, http://iris-ued.readthedocs.io/en/master/
Project-URL: Source, https://github.com/LaurentRDC/iris-ued
Project-URL: Tracker, https://github.com/LaurentRDC/iris-ued/issues
Project-URL: Home, http://www.physics.mcgill.ca/siwicklab/software.html
Keywords: ultrafast electron diffraction visualization pyqtgraph
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >= 3.6
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.12)
Requires-Dist: scipy (>=1.0.0)
Requires-Dist: h5py (>=2.10.0)
Requires-Dist: PyQt5
Requires-Dist: crystals (<2,>=1.1.2)
Requires-Dist: scikit-ued (<3,>=2.0.3)
Requires-Dist: qdarkstyle (<3,>=2.8)
Requires-Dist: pyqtgraph (>=0.11)
Requires-Dist: npstreams (<2,>=1.6.2)

Iris - Ultrafast Electron Scattering Data Exploration
======================================================

.. image:: https://dev.azure.com/laurentdecotret/iris-ued/_apis/build/status/LaurentRDC.iris-ued?branchName=master
    :target: https://dev.azure.com/laurentdecotret/iris-ued/_build/latest?definitionId=3&branchName=master
    :alt: Azure Pipelines Build Status
.. image:: https://readthedocs.org/projects/iris-ued/badge/?version=master
    :target: http://iris-ued.readthedocs.io/
    :alt: Documentation Build Status
.. image:: https://img.shields.io/pypi/v/iris-ued.svg
    :target: https://pypi.python.org/pypi/iris-ued
    :alt: PyPI Version
.. image:: https://img.shields.io/conda/vn/conda-forge/iris-ued.svg
    :target: https://anaconda.org/conda-forge/iris-ued
    :alt: Conda-forge Version
.. image:: https://img.shields.io/pypi/pyversions/iris-ued.svg
    :alt: Supported Python Versions

.. contents::
   :depth: 2
..

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.

.. figure:: iris_screen.png
    :alt: Data exploration of single-crystals and polycrystals alike.
    :align: center
    :width: 85%

    Two instances of the iris GUI showing data exploration for ultrafast electron diffraction of single crystals and polycrystals.

Installation
------------

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 <https://pip.pypa.io>`_.::

    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 <https://github.com/LaurentRDC/iris-ued>`_::

    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 :code:`iris`. 

The GUI component can be launched from a command line interpreter as :code:`python -m iris`
or :code:`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 <http://www.physics.mcgill.ca/siwicklab/publications.html>`_.

Documentation
-------------

The `Documentation on readthedocs.io <https://iris-ued.readthedocs.io>`_ provides API-level documentation, as 
well as tutorials.

Citations
---------

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

.. [#] 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

.. [#] 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 <https://github.com/LaurentRDC/iris-ued/issues>`_.

License
-------

iris is made available under the GPLv3 License. For more details, see `LICENSE.txt <https://github.com/LaurentRDC/iris-ued/blob/master/LICENSE.txt>`_.


