This template repository is a tool for creating Python projects quickly by providing much of the necessary boilerplate code. The code examples in this template repository are written in accordance with pylint style checks, and the sample prototype_template module has an associated unit test module. We have also included examples of coverage testing, notebook tests, and notebook lint checks and wrapped all of these using tox automated testing software. Check out the file glossary for more information on each tool used in this repository.
We encourage you to use this template repository to begin your own research projects!
- About the Project
- Beginner's Guide
- Installation
- Quickstart Guide
- Tutorials
- How-Tos
- Prototype Template File Glossary
- How to Give Feedback
- Contribution Guidelines
- References and Acknowledgements
- License
We encourage your feedback! You can share your thoughts with us by:
- Opening an issue in the repository
For information on how to contribute to this project, please take a look at our contribution guidelines.
[1] Diátaxis Technical Documentation Framework
https://diataxis.fr/