Install
=======

Prerequisites
-------------

1. Install [uv](https://docs.astral.sh/uv/) it's great.

2. Clone master branch

.. code:: shell

   git clone git@bitbucket.org:neosuite/sara.git
   cd sara

3. create and activate virtual env, install dependencies

.. code:: shell

   uv venv
   source .venv/bin/activate
   uv pip install -e

Documentation
-------------

1. run doctest (generates images)

.. code:: shell

   make doctest


2. compile doc

.. code:: shell

   make doc

3. read doc with your favorite browser:

.. code:: shell

   firefox docs/build/html/index.html

Tests
-----

for tests with pytest:

.. code:: shell

   make test

for doctests:

.. code:: shell

   make doctest

Examples
--------

Provencia
^^^^^^^^^

.. code:: shell

   cd examples/provencia
   cp provencia/config.ini.template provencia/config.ini

then put your database credentials into `provencia/config.ini`.

Launch the main script with:

.. code:: shell

   python main.py

I let you check `provencia/main.py` for more command line arguments

Sintrom
^^^^^^^

Ask Anthony for the dataset and move it to `sintrom` directory:

.. code:: shell

   cd examples/sintrom
   mv <some path on your machine>/sintrom_transformed.pkl .

Launch main script with:

.. code:: shell

   python main.py

I let you check `sintrom/main.py` for more command line arguments

Golf
^^^^

Just

.. code:: shell

   cd examples/golf
   python main.py