.. include:: references.txt

.. _scikit-ued:

****************************************************
`scikit-ued`: (ultrafast) electron diffraction tools
****************************************************

Scikit-ued is an open-source Python package for data analysis and
modeling in (ultrafast) electron diffraction. The goal is to provide
tested, efficients algorithms and routines to students and researchers 
in electron diffraction and related fields.

Links
=====

* `Source code <https://github.com/LaurentRDC/scikit-ued>`_
* `Issues <https://github.com/LaurentRDC/scikit-ued/issues>`_
* `Docs <http://scikit-ued.readthedocs.org/>`_

.. _scikit-ued_docs:

General Documentation
=====================

.. toctree::
    :maxdepth: 2

    installation
    tutorials/tutorials
    api
    cmdline
    whatsnew

Related Projects
================

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

Interactive exploration of ultrafast electron diffraction data is possible using the `iris package <https://pypi.python.org/pypi/iris-ued>`_.

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

Authors
=======

* Laurent P. René de Cotret (McGill)