Documentation: scene-collaboration.github.io/CodeAndDocsTemplate
This repository holds SCENE's code and data guidelines, and scene-repo-template, which creates new projects with packaging, formatting, tests, continuous integration and documentation already set up.
SCENE's shared code lives in the SCENE-Collaboration GitHub organisation. Generated projects may live there or elsewhere in the consortium.
Starting a new project? Follow Using this template, step by step.
- Project standards: project layout, formatting and linting, CI, lockfiles, containers and DataJoint.
- Collaborating on code: Git workflow, code style, issues, pull requests and code review.
- Documentation with Jupyter Book, built from
docs/and published to GitHub Pages. - Contributed examples from SCENE labs.
Suggestions and contributions are welcome: please open an issue or a pull request!
This template is based on the original started by Mackenzie Weygandt Mathis. The current version is prepared and maintained by the SCENE Data Science Core Team.
Some items in this repo are adapted from DeepLabCut, CEBRA, and the M-Lab of Adaptive Intelligence. It is under an Apache 2.0 License.