Developer Guide¶

This page details how to contribute to ASTRA.

Setting up the Development Environment¶

It is recommended to use a virtual environment for development.

Install the project in editable mode with development dependencies:
```
pip install -e ".[dev]"
```
Set up pre-commit hooks to automatically check code style on commit:
```
pre-commit install
```

Tests are located in the tests/ directory and can be run using pytest:

pytest

This project uses ruff for linting and formatting. You can run it with:

ruff check .
ruff format .

The documentation is built using Sphinx.

Install documentation dependencies:
```
pip install -r docs/requirements.txt
```
From the docs/ directory, run:
```
make html
```

The built documentation will be in docs/_build/html/.