Metadata-Version: 2.1
Name: scikit-ued
Version: 2.0.2
Summary: Collection of algorithms and functions for ultrafast electron scattering
Home-page: http://scikit-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: MIT
Download-URL: http://github.com/LaurentRDC/scikit-ued
Project-URL: Documentation, https://scikit-ued.readthedocs.io/
Project-URL: Source, https://github.com/LaurentRDC/scikit-ued
Keywords: ultrafast electron scattering
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
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: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.6
Requires-Dist: crystals (<1,>=0.6.6)
Requires-Dist: npstreams (<2,>=1.6.1)
Requires-Dist: numpy (<2,>=1.13)
Requires-Dist: pywavelets (>=1.0.0)
Requires-Dist: scikit-image (>=0.15)
Requires-Dist: scipy (>=1.0.0)
Requires-Dist: tifffile (>=0.13)
Requires-Dist: pyyaml (>=3.1)

scikit-ued
==========

.. image:: https://img.shields.io/appveyor/ci/LaurentRDC/scikit-ued/master.svg
    :target: https://ci.appveyor.com/project/LaurentRDC/scikit-ued
    :alt: Windows Build Status
.. image:: https://readthedocs.org/projects/scikit-ued/badge/?version=master
    :target: http://scikit-ued.readthedocs.io
    :alt: Documentation Build Status
.. image:: https://img.shields.io/pypi/v/scikit-ued.svg
    :target: https://pypi.org/project/scikit-ued/
    :alt: PyPI Version
.. image:: https://img.shields.io/conda/vn/conda-forge/scikit-ued.svg
    :target: https://anaconda.org/conda-forge/scikit-ued
    :alt: Conda-forge Version
.. image:: https://img.shields.io/pypi/pyversions/scikit-ued.svg
    :alt: Supported Python Versions

Collection of algorithms and functions for ultrafast electron diffraction. It aims to be a fully-tested package
taking advantage of Python's most recent features.

For examples, see our `tutorials <https://scikit-ued.readthedocs.io/en/latest/tutorials/index.html>`_.

API Reference
-------------

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

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

scikit-ued is available on PyPI; it can be installed with `pip <https://pip.pypa.io>`_::

    python -m pip install scikit-ued

scikit-ued is also available on the conda-forge channel for the `conda package manager <https://conda.io/docs/>`_::

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

To install the latest development version from `Github <https://github.com/LaurentRDC/scikit-ued>`_::

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

After installing scikit-ued you can use it like any other Python module as ``skued``.

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.

Optional dependencies
---------------------

For displaying diffraction images with interactive contrast using the ``skued.diffshow`` function, PyQtGraph is required.

Related projects
----------------

Streaming operations on NumPy arrays are available in the `npstreams package <https://pypi.org/pypi/npstreams>`_.

Interactive exploration of ultrafast electron diffraction data with the `iris-ued package <https://pypi.org/project/iris-ued/>`_.

Crystal structure manipulation (including symmetry-determination) with the `crystals package <https://pypi.org/project/crystals/>`_. (Included with scikit-ued)

A graphical user interface for the dual-tree complex wavelet transform baseline-removal routine is available as a 
`separate package <https://pypi.org/pypi/dtgui>`_.

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

License
-------

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


