Contributing

Contributions are welcome. This page summarizes the development workflow; see the full CONTRIBUTING and Code of Conduct in the repository root.

Development setup

git clone https://github.com/sccn/pyAMICA.git
cd pyAMICA
uv sync                 # install the project and dependencies
uv run pytest           # run the test suite

Conventions

• Environment: UV only (no pip/conda/virtualenv for project management).
• Lint/format: uv run ruff check --fix . && uv run ruff format .
• Tests: real sample data and the Fortran binary only, never synthetic data (see Testing).
• Correctness: numerical parity with the Fortran reference is the specification (see Validation & Parity).
• Commits: atomic, concise messages, no emojis.

Reporting issues and getting help

Please open an issue on the GitHub issue tracker for bug reports, feature requests, and questions.