From f6220ed2d22fe1c299cf0a9ee03fe55645b582d8 Mon Sep 17 00:00:00 2001 From: Max Grover Date: Fri, 8 Dec 2023 08:35:44 -0600 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a0d84ac..18c3fe1 100644 --- a/README.md +++ b/README.md @@ -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 - - + + ## 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 @@ -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