.. _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/rs-station/reciprocalspaceship/main?filepath=docs%2Fexamples>`_
   or by downloading the notebook files from the
   `Examples Directory <https://github.com/rs-station/reciprocalspaceship/tree/main/docs/examples>`_
   and starting a notebook server.

.. toctree::
   :maxdepth: 1

   ../examples/1_basics.ipynb
   ../examples/2_mergingstats.ipynb
   ../examples/3_mergingerrormodel.ipynb
   ../examples/4_anomalousmap.ipynb
   ../examples/5_anomaloussites.ipynb
   ../examples/6_timeresolvedPYP.ipynb