Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mgrover1 authored Dec 8, 2023
1 parent b73e60b commit f6220ed
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,41 @@
[![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/cookbook-template/main?labpath=notebooks)
[![DOI](https://zenodo.org/badge/475509405.svg)](https://zenodo.org/badge/latestdoi/475509405)

This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., _working with radar data in Python_)
This Project Pythia Cookbook covers how to access and analyze datasets that can be accessed from Earth System Grid Federation (ESGF) cyberinfrastructure.

## Motivation

(Add a few sentences stating why this cookbook will be useful. What skills will you, "the chef", gain once you have reached the end of the cookbook?)
This cookbook focuses on highlighting analysis recipes, as well as data acccess methods, all accesible within the Python programming language. This cookbook also spans beyond the scope of a single Climate Model Intercomparison Project (ex. CMIP6), expanding to other experiments/datasets such as CMIP5 and obs4MIPs.

## Authors

[First Author](@first-author), [Second Author](@second-author), etc. _Acknowledge primary content authors here_
[Max Grover](@mgrover1), [Nathan Collier](@nocollier)

### Contributors

<a href="https://github.com/ProjectPythia/cookbook-template/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ProjectPythia/cookbook-template" />
<a href="https://github.com/esgf2-us/esgf-cookbook/graphs/contributors">
<img src="https://contrib.rocks/image?repo=esgf2-us/esgf-cookbook" />
</a>

## Structure

(State one or more sections that will comprise the notebook. E.g., _This cookbook is broken up into two main sections - "Foundations" and "Example Workflows."_ Then, describe each section below.)
### Searching

### Section 1 ( Replace with the title of this section, e.g. "Foundations" )
This content includes details on how to search for datasets hosted on ESGF cyberinfrastructure.

(Add content for this section, e.g., "The foundational content includes ... ")
### Workflows

### Section 2 ( Replace with the title of this section, e.g. "Example workflows" )

(Add content for this section, e.g., "Example workflows include ... ")
Scientific workflows utilizing data accessed from ESGF.

## Running the Notebooks

You can either run the notebook using [Binder](https://binder.projectpythia.org/) or on your local machine.
You can either run the notebook using [the NIMBUS Binder](https://binder-nimbus.llnl.gov/) or on your local machine.

### Running on Binder

The simplest way to interact with a Jupyter Notebook is through
[Binder](https://binder.projectpythia.org/), which enables the execution of a
[Jupyter Book](https://jupyterbook.org) in the cloud. The details of how this works are not
[the NIMBUS Binder](https://binder-nimbus.llnl.gov/), which enables the execution of a
[Jupyter Book](https://jupyterbook.org) in the cloud-like infrastructure. The details of how this works are not
important for now. All you need to know is how to launch a Pythia
Cookbooks chapter via Binder. Simply navigate your mouse to
the top right corner of the book chapter you are viewing and click
Expand All @@ -61,20 +59,20 @@ If you are interested in running this material locally on your computer, you wil

(Replace "cookbook-example" with the title of your cookbooks)

1. Clone the `https://github.com/ProjectPythia/cookbook-example` repository:
1. Clone the `https://github.com/esgf2-us/esgf-cookbook` repository:

```bash
git clone https://github.com/ProjectPythia/cookbook-example.git
git clone https://github.com/esgf2-us/esgf-cookbook.git
```

1. Move into the `cookbook-example` directory
```bash
cd cookbook-example
cd esgf-cookbook
```
1. Create and activate your conda environment from the `environment.yml` file
```bash
conda env create -f environment.yml
conda activate cookbook-example
conda activate esgf-cookbok-dev
```
1. Move into the `notebooks` directory and start up Jupyterlab
```bash
Expand Down

0 comments on commit f6220ed

Please sign in to comment.