Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.64 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.64 KB
Raw

CMIP6 Hackathon Project Template

This template provides a starting point for CMIP6 Hackathon projects.

What's included?

  1. catalogs: data catalogs that can be used by Intake-ESM.
  2. environments: Conda environment files for the NCAR/Google Cloud deployments.
  3. notebooks: a place for storing Jupyter Notebooks.
  4. README.md: this document - consider modifying to make it a description of your project on GitHub.
  5. LICENSE: a default (MIT) license file for your project. You can change this if you feel the need.

How to use this Template

Project leads should follow the next four steps. This only needs to be done once.

  1. Navigate to https://github.com/cmip6hack/project-template
  2. Click the "Use this template" button
  3. Name your project (consider prepending with "cmip6hack", so something like cmip6hack-myproject)
  4. Provide a brief description
  5. Tell your teammates where to find your repository and tell them to "Fork" the project.

Once the initial setup is done, everyone will want to clone the repository onto the compute system they plan to use for the hackathon.

  1. Open a JupyterLab session on the system you plan to use.
  2. Open a terminal in the JupyterLab environment.
  3. Clone your project: git clone https://github.com/username/cmip6hack-myproject.git
  4. Get to work!

How to make your project citable

Zenodo is a data archiving tool that can help make your project citable by assigning a DOI to the project's GitHub repository.

Follow the guidelines here https://guides.github.com/activities/citable-code