Contributing

This section is for people who want to work on the Pymetropolis codebase itself — adding a new Step, MetroFile, or Parameter, or fixing a bug — as opposed to using Pymetropolis to run simulations. It assumes you are already familiar with the Pipeline (Steps, MetroFiles, Parameters) as a user.

• Development environment: setting up uv, code style, tests, regenerating the reference documentation, and submitting changes.
• Creating MetroFiles: how to add a new MetroFile to the codebase.
• Creating Steps with Parameters: how to add a new Step, with its Parameters, to the codebase.

Contributions are welcome — see the contributing guidelines on GitHub to get started.