# Iris - Ultrafast Electron Scattering Data Exploration
[](http://iris-ued.readthedocs.io/) [](https://pypi.python.org/pypi/iris-ued) [](https://anaconda.org/conda-forge/iris-ued) [](https://doi.org/10.1186/s40679-018-0060-y)
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](#installation)
- [Usage](#usage)
- [Test Data](#test-data)
- [Documentation](#documentation)
- [Citations](#citations)
- [Support / Report Issues](#support--report-issues)
- [License](#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](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.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](https://github.com/LaurentRDC/iris-ued/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](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
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.](https://ascimaging.springeropen.com/articles/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](https://doi.org/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).
Raw data
{
"_id": null,
"home_page": "http://iris-ued.readthedocs.io",
"name": "iris-ued",
"maintainer": "Laurent P. Ren\u00e9 de Cotret",
"docs_url": null,
"requires_python": ">= 3.8",
"maintainer_email": "laurent.renedecotret@mail.mcgill.ca",
"keywords": "ultrafast electron diffraction visualization pyqtgraph",
"author": "Laurent P. Ren\u00e9 de Cotret",
"author_email": "laurent.renedecotret@mail.mcgill.ca",
"download_url": "https://files.pythonhosted.org/packages/b5/a2/590187cef4faf7c8447baa4c45c67e1a8b8df2994ebd1fb2cd355bed89de/iris-ued-5.3.5.tar.gz",
"platform": null,
"description": "# Iris - Ultrafast Electron Scattering Data Exploration\n\n[](http://iris-ued.readthedocs.io/) [](https://pypi.python.org/pypi/iris-ued) [](https://anaconda.org/conda-forge/iris-ued) [](https://doi.org/10.1186/s40679-018-0060-y)\n\n\nIris is both a library for interacting with ultrafast electron\ndiffraction data, as well as a GUI frontend for interactively exploring\nthis data.\n\nIris also includes a plug-in manager so that you can explore your data.\n\n\n\n## Contents:\n - [Installation](#installation)\n - [Usage](#usage)\n - [Test Data](#test-data)\n - [Documentation](#documentation)\n - [Citations](#citations)\n - [Support / Report Issues](#support--report-issues)\n - [License](#license)\n\n## Installation\n\nTo 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](https://pip.pypa.io).:\n\n python -m pip install iris-ued\n\n`iris` is also available on the conda-forge channel:\n\n conda config --add channels conda-forge\n conda install iris-ued\n\nTo install the latest development version from\n[Github](https://github.com/LaurentRDC/iris-ued):\n\n python -m pip install git+git://github.com/LaurentRDC/iris-ued.git\n\nEach version is tested against Python 3.8+. If you are using a different\nversion, tests can be run using the `pytest` package.\n\n### Windows Installers\n\nFor Windows, installers are available on the [Releases](https://github.com/LaurentRDC/iris-ued/releases) page. You will still need to install `iris` via `pip` or `conda` to use the scripting functionality.\n\n## Usage\n\nOnce installed, the package can be imported as `iris`.\n\nThe GUI component can be launched from a command line interpreter as\n`python -m iris` or `pythonw -m iris` (no console window). See the documentation\nfor a visual guide.\n\n## Documentation\n\nThe [Documentation on readthedocs.io](https://iris-ued.readthedocs.io)\nprovides API-level documentation, as well as tutorials.\n\n## Citations\n\nIf you find this software useful, please consider citing the following\npublication:\n\n> L. P. Ren\u00e9 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.](https://ascimaging.springeropen.com/articles/10.1186/s40679-018-0060-y)\n\nIf you are using the baseline-removal functionality of iris-ued,\nplease consider citing the following publication:\n\n> L. P. Ren\u00e9 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](https://doi.org/10.1063/1.4972518).\n\n## Support / Report Issues\n\nAll support requests and issue reports should be [filed on Github as an\nissue](https://github.com/LaurentRDC/iris-ued/issues).\n\n## License\n\niris is made available under the GPLv3 License. For more details, see\n[LICENSE.txt](https://github.com/LaurentRDC/iris-ued/blob/master/LICENSE.txt).\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Ultrafast electron diffraction data exploration",
"version": "5.3.5",
"project_urls": {
"Documentation": "http://iris-ued.readthedocs.io/en/master/",
"Download": "http://github.com/LaurentRDC/iris-ued",
"Home": "http://www.physics.mcgill.ca/siwicklab/software.html",
"Homepage": "http://iris-ued.readthedocs.io",
"Source": "https://github.com/LaurentRDC/iris-ued",
"Tracker": "https://github.com/LaurentRDC/iris-ued/issues"
},
"split_keywords": [
"ultrafast",
"electron",
"diffraction",
"visualization",
"pyqtgraph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45bcfbfa348de0b767417725e87018558453bbbc02f97d5068127043d797f625",
"md5": "78ae984cc942e48ff65140bd3201a3dd",
"sha256": "07ef7c50ba1ea0e6249f40409ae877452f0dc900608378225422709b29a200f7"
},
"downloads": -1,
"filename": "iris_ued-5.3.5-py3.10.egg",
"has_sig": false,
"md5_digest": "78ae984cc942e48ff65140bd3201a3dd",
"packagetype": "bdist_egg",
"python_version": "5.3.5",
"requires_python": ">= 3.8",
"size": 179647,
"upload_time": "2023-05-25T10:53:38",
"upload_time_iso_8601": "2023-05-25T10:53:38.590750Z",
"url": "https://files.pythonhosted.org/packages/45/bc/fbfa348de0b767417725e87018558453bbbc02f97d5068127043d797f625/iris_ued-5.3.5-py3.10.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72b4944d645ccad8d1dda610af2b6d4d5a3c2df44c7f95f57d3b32f11c57336e",
"md5": "9ec91898366cc17f9ee1d85c5b9be892",
"sha256": "cd62ad601911482fc70bc53edb59a90af400a26d6b8bfd47eb152b61593ab89b"
},
"downloads": -1,
"filename": "iris_ued-5.3.5-py3.11.egg",
"has_sig": false,
"md5_digest": "9ec91898366cc17f9ee1d85c5b9be892",
"packagetype": "bdist_egg",
"python_version": "5.3.5",
"requires_python": ">= 3.8",
"size": 237292,
"upload_time": "2023-05-25T10:53:40",
"upload_time_iso_8601": "2023-05-25T10:53:40.303726Z",
"url": "https://files.pythonhosted.org/packages/72/b4/944d645ccad8d1dda610af2b6d4d5a3c2df44c7f95f57d3b32f11c57336e/iris_ued-5.3.5-py3.11.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9e063650a898e7456f4809a642a091a3a5de6a273f45a56bd246011f366d429",
"md5": "a4644a29e3b421af49dab7973d3714ca",
"sha256": "2e7a019f72c77c0c29e11d5d5f68798e8423a702bdb0b70ecb33dec3a1771822"
},
"downloads": -1,
"filename": "iris_ued-5.3.5-py3.8.egg",
"has_sig": false,
"md5_digest": "a4644a29e3b421af49dab7973d3714ca",
"packagetype": "bdist_egg",
"python_version": "5.3.5",
"requires_python": ">= 3.8",
"size": 178639,
"upload_time": "2023-05-25T10:53:42",
"upload_time_iso_8601": "2023-05-25T10:53:42.284646Z",
"url": "https://files.pythonhosted.org/packages/c9/e0/63650a898e7456f4809a642a091a3a5de6a273f45a56bd246011f366d429/iris_ued-5.3.5-py3.8.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9b4dd787c1e678e6716f93efb4026430065edeeda526f36c5a433a427b426c3",
"md5": "a07c8efe5cb6b1dc163bb6f328eb4e67",
"sha256": "6ed88f672f9d23a909ed4d3b0c5503b376e833ec18f4c0c490a528ea084819b1"
},
"downloads": -1,
"filename": "iris_ued-5.3.5-py3.9.egg",
"has_sig": false,
"md5_digest": "a07c8efe5cb6b1dc163bb6f328eb4e67",
"packagetype": "bdist_egg",
"python_version": "5.3.5",
"requires_python": ">= 3.8",
"size": 178676,
"upload_time": "2023-05-25T10:53:43",
"upload_time_iso_8601": "2023-05-25T10:53:43.670769Z",
"url": "https://files.pythonhosted.org/packages/f9/b4/dd787c1e678e6716f93efb4026430065edeeda526f36c5a433a427b426c3/iris_ued-5.3.5-py3.9.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "922ed6ffffe40f76a6798b4c20da7f8a0ef7d54b5be46b6fecf565eabd091e93",
"md5": "251f5c63ec1171f21e054985975bc5e9",
"sha256": "ed81377d481001f16c56de8b27434f3ff9ba3a7804da4111d04f025ed1861ce9"
},
"downloads": -1,
"filename": "iris_ued-5.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "251f5c63ec1171f21e054985975bc5e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">= 3.8",
"size": 89118,
"upload_time": "2023-05-25T10:53:28",
"upload_time_iso_8601": "2023-05-25T10:53:28.371245Z",
"url": "https://files.pythonhosted.org/packages/92/2e/d6ffffe40f76a6798b4c20da7f8a0ef7d54b5be46b6fecf565eabd091e93/iris_ued-5.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5a2590187cef4faf7c8447baa4c45c67e1a8b8df2994ebd1fb2cd355bed89de",
"md5": "6e80f619e1ca5686a613b70a7a9c140d",
"sha256": "04cd82cae96f99f2cf52c5b92903b9f1780ba44253817271e302ca2f112fed29"
},
"downloads": -1,
"filename": "iris-ued-5.3.5.tar.gz",
"has_sig": false,
"md5_digest": "6e80f619e1ca5686a613b70a7a9c140d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3.8",
"size": 414093,
"upload_time": "2023-05-25T10:53:30",
"upload_time_iso_8601": "2023-05-25T10:53:30.181672Z",
"url": "https://files.pythonhosted.org/packages/b5/a2/590187cef4faf7c8447baa4c45c67e1a8b8df2994ebd1fb2cd355bed89de/iris-ued-5.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 10:53:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LaurentRDC",
"github_project": "iris-ued",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "iris-ued"
}
JSON
