.. pyMACS documentation master file, created by
   sphinx-quickstart on Fri May 10 17:02:58 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyMACS's documentation!
==================================

**pyMACS** is a python interface to a mcStas simulation of the MACS instrument. 
There are a few steps to get the package running, but most importantly this must be run on a *unix machine with a bash shell*. See :doc:`installation` for further information.

.. note::
   
   This project is not under active development and is experimental.



Installation
-----------------

.. toctree::
   installation


.. raw:: html

   <hr>

Notebook Tutorials
-------------------

.. toctree::
   notebooks/introduction_notebook
   notebooks/emulate_MACS_data
   notebooks/resolution_example
   notebooks/tio2_111
   notebooks/sqw4_simulation
   notebooks/cri3_plotting_example
   notebooks/MACS_User_notebook

Classes and Methods
-------------------

.. toctree::
   virtualMACS
   sample
   kidney
   monochromator
   macsdata
   scripting