Install

Prerequisites

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

  2. Clone master branch

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

  1. create and activate virtual env, install dependencies

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

Documentation

  1. run doctest (generates images)

make doctest

  1. compile doc

make doc

  1. read doc with your favorite browser:

firefox docs/build/html/index.html

Tests

for tests with pytest:

make test

for doctests:

make doctest

Examples

Provencia

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:

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:

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

Launch main script with:

python main.py

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

Golf

Just

cd examples/golf
python main.py