Metadata-Version: 2.0
Name: scikit-ued
Version: 0.5.6
Summary: Collection of algorithms and functions for ultrafast electron diffraction
Home-page: http://scikit-ued.readthedocs.io
Author: Laurent P. René de Cotret
Author-email: laurent.renedecotret@mail.mcgill.ca
License: MIT
Download-URL: http://github.com/LaurentRDC/scikit-ued
Project-URL: Documentation, http://scikit-ued.readthedocs.io/en/master/
Project-URL: Source, https://github.com/LaurentRDC/scikit-ued
Description-Content-Type: UNKNOWN
Keywords: ultrafast electron diffraction
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
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.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.5
Requires-Dist: numpy (>=1.12)
Requires-Dist: scipy (>=0.17)
Requires-Dist: scikit-image (>=0.13)
Requires-Dist: tifffile (>=0.13)
Requires-Dist: pywavelets (>=0.5.2)
Requires-Dist: npstreams (>=1.3.0)
Requires-Dist: spglib (>=1.10)
Requires-Dist: pycifrw (>=4)

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.python.org/pypi/scikit-ued
    :alt: PyPI Version

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

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

Each version is tested against Python 3.5 and 3.6. If you are using a different version, tests can be run
using the standard library's `unittest` module.

Dependencies for scikit-ued (e.g. ``spglib``) require compilation. Windows users should 
minimally have the `Visual Studio Build Tools <https://www.visualstudio.com/downloads/>`_ installed.

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

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

While it is not strictly required, the fourier transform routines from ``pyfftw`` will be preferred If
``pyfftw`` is installed.

For displaying diffraction images using the ``skued.diffshow`` function, PyQtGraph and PyQt5 are both required.

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

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

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

Citations
---------

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>`_.


