Contributing

We welcome contributions

Set up

This project uses uv to manage dependencies. See uv installation instructions.

To set up an environment for development:

git clone https://github.com/tlambert03/microsim.git
cd microsim
uv sync --all-extras

If you want to avoid using uv run for all of the remaining commands, you can activate the environment:

On macos/linux:

source .venv/bin/activate

On windows:

.venv\Scripts\activate

Run tests with:

uv run pytest

Linting and formatting is managed using pre-commit.

uv run pre-commit run --all-files

You can have this run on every commit by installing the git hook:

uv run pre-commit install

Documentation is built using mkdocs.

To serve the documentation locally:

uv run --group docs mkdocs serve