Repository description.
| Branch | Description | Reviews Required | Comments |
|---|---|---|---|
master |
Official software release | 1 | |
dev-* |
All software development branches | 0 | Software changes, reviews, quality, etc. |
See Branch Naming Convention for guidelines on naming development branches.
Note: * represents the branch name.
| Item | Description |
|---|---|
docs/ |
API Reference documentation |
notebooks/ |
Python notebooks |
output/ |
Software code tests & output |
src/ |
Software source code |
tests/ |
Unit tests for each function or method within the source code |
.gitignore |
List of files or dirs to exclude in the repository |
README.md |
This document |
See the best practices wiki for a full guide on our software best practices.
See the contribution wiki for a full guide on how to contribute as a developer.