The files in this repository build a documentation website for the 5GIR users on how to export the farm data from the data warehouse.
Add some description
Visit the page at https://newcastlerse.github.io/5gir-docs.
| Name | Role | Affiliation | |
|---|---|---|---|
| James Standen | james.standen@newcastle.ac.uk | PI | Newcastle University |
| Dr Robin Wardle | robin.wardle@newcastle.ac.uk | RSE | Newcastle Universtiy |
| Dr Carmelo Calafiore | carmelo.calafiore@newcastle.ac.uk | RSE | Newcastle Universtiy |
The documentation website was built with:
Any tools or versions of languages needed to run code. For example, specific Python or Node versions. Minimum hardware requirements also go here.
How to build or install the application.
How to run the application on your local system. Examples of this would include venv, anaconda, node, Docker or minikube.
How to run tests on your local system.
Instructions on how to deploy to the staging or production systems. Examples of this would include cloud, HPC or virtual machine. Deployment should be done via GitHub Workflows but information on how these work and the different triggers should go here.
Protected and can only be pushed to via pull requests. It should be considered stable and a representation of production code.
Should be considered fragile; code should compile and run, but features may be prone to errors.
A branch per feature that is being worked on.
https://nvie.com/posts/a-successful-git-branching-model/
This work was funded by a grant from the UK Research Councils, EPSRC grant ref. EP/L012345/1, “Example project title, please update”.