.. These are examples of badges you might want to add to your README:
   please update the URLs accordingly

    .. image:: https://api.cirrus-ci.com/github/<USER>/cristallina.svg?branch=main
        :alt: Built Status
        :target: https://cirrus-ci.com/github/<USER>/cristallina
    .. image:: https://readthedocs.org/projects/cristallina/badge/?version=latest
        :alt: ReadTheDocs
        :target: https://cristallina.readthedocs.io/en/stable/
    .. image:: https://img.shields.io/coveralls/github/<USER>/cristallina/main.svg
        :alt: Coveralls
        :target: https://coveralls.io/r/<USER>/cristallina
    .. image:: https://img.shields.io/pypi/v/cristallina.svg
        :alt: PyPI-Server
        :target: https://pypi.org/project/cristallina/
    .. image:: https://img.shields.io/conda/vn/conda-forge/cristallina.svg
        :alt: Conda-Forge
        :target: https://anaconda.org/conda-forge/cristallina
    .. image:: https://pepy.tech/badge/cristallina/month
        :alt: Monthly Downloads
        :target: https://pepy.tech/project/cristallina
    .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
        :alt: Twitter
        :target: https://twitter.com/cristallina

.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
    :alt: Project generated with PyScaffold
    :target: https://pyscaffold.org/

.. image:: https://gitlab.psi.ch/sf_cristallina/cristallina/badges/master/coverage.svg
    :alt: Cristallina coverage report
    :target: https://gitlab.psi.ch/sf_cristallina/cristallina/-/commits/master


===========
Cristallina data analysis modules and plotting utilities.
===========

This is a python package for data analysis, plotting and utility functions for the Cristallina endstation @ SwissFEL.

The data analysis is based on the common SwissFEL data architecture, with convienent access provided by `sf_datafiles <https://github.com/paulscherrerinstitute/sf_datafiles>`_.  Some parts require access to SwissFEL-specific data storage but the aim is to use this package indepedently for data analysis both online and offline operation.