developer.md

install dev requirements

Install dev requirements with pip install -r requirements-dev.txt

linting and formatting

To reformat your code, use this command line: ruff check src/ tests/ --fix && ruff format src/ tests/

typechecking

To typecheck your code, use this command line: mypy

integration testing

To launch integration tests you'll need an AntaresWebDesktop instance on your local env (at least the v.2.17.3, currently running in 2.17.5).
To install it, download it from the last Antares Web release (inside the assets list).
Then, unzip it at the root of this repository and rename the folder AntaresWebDesktop.
NB: The expected folder structure is the following: antares_craft/AntaresWebDesktop/config.yaml

tox

To use tox to run unit tests in multiple python versions at the same time as linting and formatting with ruff and typing with mypy:

1. As the dev requirements include uv and tox-uv there is no need to install python versions, uv will do this for you.
2. Use tox -p to run the environments in parallel to save time, this will create virtual environment with the necessary python versions the first time you run tox.

mkdocs

Smallest beginning of mkdocs included more as proof of concept than anything, theme and logo copied from Antares Simulator.

1. To preview the docs on your local machine run mkdocs serve.
2. To build the static site for publishing for example on Read the Docs use mkdocs build.
3. To flesh out the documentation see mkdoc guides.