- Overview
- Documentation
- System Requirements
- Installation Guide
- Quick Start
- Attribution
- For Developers
Add a concise overview
Describe the place where your documentation lives
Describe on which systems this installation was tested
Dependencies including exact versions are specified in the pyproject.toml file.
Describe the preferred way to install this package.
Describe how to run the code
Specify under which license this repository is released and where to find it.
Describe how to cite this software, e.g. by pointing to the CITATION.cff file.
Acknowledge funding agencies etc.
Describe developer details, e.g. how to install. Consider cross-referencing the CODE_OF_CONDUCT and CONTRIBUTING files.