Quick start

A Quick start guide to help you create your own underworld-community repository with the provided template:

---

1. Use the template repository to make your own GitHub repository.

Look for the green button "Use this template".

2. Remove the existing model files.

Keep the existing Dockerfile and README.md but remove all other files.

git rm RayTay.ipynb VrmsCaseA.txt *.png

3. Add your model files to the top level of your repository.

For example .ipynb or .py script. Be mindful of adding large data files, git isn't designed for that. Perhaps add links to data stores if required.

4. Fill out all sections of the README.md.

This will assist others in the underworld-community to understand the model.

5. If applicable add a MyBinderHub link and share with collaborators.

See https://mybinder.org/ to generate a link or badge