Hackathon Project Template

This is a template repo for hackathon projects. Click the (green) "Use this template" button at the top of the page to use it.

There are also some example notebooks. Check our Hackathon Resources page for further guidance, including our participant guide and recommendations for using Git and GitHub in your project team.

This template repo was created for the CMIP6 Data Hackathon by James Thomas and Will Seviour.

Change this README!

When you've used this template, remove the above text and replace with the below:

---

[Project title]

[Short summary of the project]

Contributors

• Contributors list
• With links to GitHub profiles / institution pages, etc.

What was done

How we approached the problem and why

[...]

Data we used and how to obtain this

• [...]
• [...]
• [...]

What we did during the hackathon

• [...]
• [...]
• [...]

Outcomes

• [...]
• [...]
• [...]

About this repo

There are further README files in key directories.

Key files

• [...]
• [...]
• [...]

How to reproduce our outputs

1. [...]
2. [...]
3. [...]

Repo structure

.
├── notebooks
│   ├── [...].ipynb
│   └── [...].ipynb
│           The Jupyter Notebooks that we created
│
├── code
│   ├── [...].py
│   └── [...].py
│           Any code (Python or otherwise) that we created that doesn't
│           sit within a Notebook
│
├── results
│   ├── [...].pdf
│   └── [...].png
│           The key figures that we produced
│
├── data
│   ├── raw_data
│   │       Any data we used that didn't come from JASMIN
│   │
│   └── processed_data
│           Any output data that we produced
│
├── environment.yml
└── environment_frozen.yml
        The libraries and versions that we used

Next steps for our project

• [...]
• [...]
• [...]