{YOUR-PROJECT-NAME}

{SHORT PROJECT DESCRIPTION}

HOW TO USE THIS TEMPLATE

Please read ABOUT_THIS_TEMPLATE, and delete this section.

Table of contents

• About
• Getting started
• Contributing
• Reporting issues
• Contributors
• Acknowledgements

About

Getting started

Pre-requisites

• Python >= 3.12

Installing via pip

pip install {PACKAGE_NAME}

Installing from source

git clone https://github.com/{GITHUB_ACCOUNT}/{REPO_NAME}.git
cd {REPO_NAME}
pip install -e ".[dev]"

Contributing

See Contributing

Reporting issues

To report an issue or suggest a new feature, please use the issues page. Please check existing issues before submitting a new one.

Contributors

Acknowledgements