Skip to content

Commit

Permalink
DOC: updated some intro
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Jul 28, 2017
1 parent 9f07ca4 commit 72b65ff
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 17 deletions.
46 changes: 36 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,41 @@ scikit-ued
:target: https://pypi.python.org/pypi/scikit-ued
:alt: PyPI Version

Collection of algorithms and functions for ultrafast electron diffraction.
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.

Getting Started with scikit-ued
-------------------------------
Examples
--------

First and foremost, ``skued`` is concerned with the diffraction of crystals. Hence, building a ``Crystal`` object
from various sources is easy::

from skued import Crystal

tise2 = Crystal.from_cif('tise2.cif')
graphite = Crystal.from_database('C') # Internal database
hemoglobin = Crystal.from_pdb('1gzx') # Protein Data Bank
vo2 = Crystal.from_cod(1521124) # Crystallography Open Database

The ``Crystal`` object encodes multiple attributes and methods related to space-group, symmetry, and scattering.

Another important part of ultrafast electron diffraction is image processing. Image-alignment,
streaming image operations, exploitation of symmetry and more are included.

Baseline-determination in polycrystalline data is a cornerstone of this package. Using the dual-tree complex
wavelet transform, time-varying baselines can be extracted with high accuracy, even in cases where diffraction
peaks overlap over the entire dataset.

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

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

The `API Reference on readthedocs.io <http://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>`_.::

Expand All @@ -27,21 +58,16 @@ To install the latest development version from `Github <https://github.com/Laure
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.

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

Citations
---------

If you are using the :code:`skued.baseline` subpackage, consider citing the following publication:
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.
API Reference
-------------

The `API Reference on readthedocs.io <http://scikit-ued.readthedocs.io>`_ provides API-level documentation.

Support / Report Issues
-----------------------

Expand Down
6 changes: 3 additions & 3 deletions docs/source/tutorials/image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _image_analysis_tutorial:

***********************
Image Analysis Tutorial
***********************
**********************************
Image Analysis/Processing Tutorial
**********************************

Diffraction patterns analysis is essentially specialized image processing. This tutorial
will show some of the image processing and analysis techniques that are part of the :mod:`skued.image` module.
Expand Down
6 changes: 2 additions & 4 deletions docs/source/tutorials/structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

.. _structure_tutorial:

******************
Structure Tutorial
******************

**************************
Modeling atomic structures
**************************

Contents
========
Expand Down

0 comments on commit 72b65ff

Please sign in to comment.