index.rst

.. BOZ calculator documentation master file, created by
   sphinx-quickstart on Thu Sep 23 13:18:21 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BOZ calculator's documentation!
===========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:


Installation free
=================

You can directly use the calculator on a live environment:

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/git/https%3A%2F%2Fgit.xfel.eu%2FSCS%2Fbozcalc.git/master?filepath=%2Fdoc%2Fsource%2FInteractive%20BOZ%20calculator.ipynb

Installation
============

The installation steps are

1. Clone the git repository

   .. code:: bash

      git clone https://git.xfel.eu/SCS/bozcalc.git


#. Install the package

   .. code:: bash

      cd bozcalc
      pip3 install -U -e .

Usage
=====

The following notebook demonstrate how to use the calculator:
:doc:`BOZ calculator <Interactive BOZ calculator>`


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`