.. _examples:

Examples
========

``reciprocalspaceship`` facilitates working with reflection data in Python. It provides
IO methods for reading/writing MTZ files, and a ``pandas``-style interface for inspecting
data and prototyping new analysis methods.

Here are a few examples to help you get started with ``reciprocalspaceship`` and highlight
some use cases. 

.. note::
   Each of these examples is contained within a Jupyter notebook. Feel free to view the
   examples in the browser by following the links below. These notebooks can also be viewed
   interactively on `binder <https://mybinder.org/v2/gh/Hekstra-Lab/reciprocalspaceship/master?filepath=docs%2Fexamples>`_
   or by downloading the notebook files from the 
   `Examples Directory <https://github.com/Hekstra-Lab/reciprocalspaceship/tree/master/docs/examples>`_ 
   and starting a notebook server. 

.. toctree::
   :maxdepth: 1

   1_basics.ipynb
   2_mergingstats.ipynb
   3_anomalousdifference.ipynb
   4_timeresolvedPYP.ipynb