Developer Guide

Setting Up the Development Environment

1. Clone the repository:

   git clone https://github.com/rozyczko/SANS-fitter.git
   cd SANS-fitter
   

2. Install development dependencies:

   pip install -e ".[dev,docs]"
   

   Or using Pixi:

   pixi install
   

Running Tests

We use pytest for testing.

To run all tests:

pytest

Or using the provided script:

python run_tests.py

To run tests with coverage:

pytest --cov=sans_fitter

Building Documentation

The documentation is built using MkDocs.

To serve the documentation locally:

mkdocs serve

To build the static site:

mkdocs build

Code Style

This project follows PEP 8 guidelines. We use ruff for linting and formatting.

To check for linting errors:

ruff check .

To format code:

ruff format .