Getting Started
===============

Installation
------------
To install the package, run the following command:

..  code-block:: bash

    pip install artof

Example
-------
Import the :doc:`artof_loader` class

..  code-block:: python

    from artof import ARTOFLoader

Load run and transformed to desired format. The path should lead to a directory with all datafiles and metadata files (``aquisition.cfg``)

..  code-block:: python

    artofLoader = ARTOFLoader('./Run_042/', 'spherical')
    artofLoader.transform_data()

Bin data (this step can be re-executed indepently of load_run)

..  code-block:: python

    artofLoader.bin_data()


Plot data as projection onto one or two axes and custom ranges for each axis

..  code-block:: python

    artofLoader.plot([2])
    artofLoader.plot([0,1], ranges=[None, None, [80, 120]])

Export data to a file in the same manner as plotting it.

..  code-block:: python

    artofLoader.export_to_csv('./export/Run_18_t.csv', [2])
    artofLoader.export_to_csv('./export/Run_18_t.csv', [0,1], ranges=[None, None, [80, 120]])

An example notebook can be found |notebook_link|.

.. |notebook_link| raw:: html

   <a href="https://gitlab.com/cmtron/artof/-/blob/main/example-notebook.ipynb?ref_type=heads" target="_blank">here</a>