ESGF Cookbook

This Project Pythia Cookbook covers how to access and analyze datasets that can be accessed from Earth System Grid Federation (ESGF) cyberinfrastructure.

Motivation

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

Max Grover, Nathan Collier, Carsten Ehbrecht, Jacqueline Nugent, Gerardo Rivera Tello

Contributors

Structure

Searching

This content includes details on how to search for datasets hosted on ESGF cyberinfrastructure.

Workflows

Scientific workflows utilizing data accessed from ESGF.

Running the Notebooks

You can either run the notebook using the NIMBUS Binder or on your local machine.

Running on Binder

The simplest way to interact with a Jupyter Notebook is through the NIMBUS Binder, which enables the execution of a Jupyter Book 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 on the rocket ship icon, (see figure below), and be sure to select “launch Binder”. After a moment you should be presented with a notebook that you can interact with. I.e. you’ll be able to execute and even change the example programs. You’ll see that the code cells have no output at first, until you execute them by pressing {kbd}Shift+{kbd}Enter. Complete details on how to interact with a live Jupyter notebook are described in Getting Started with Jupyter.

Running on Your Own Machine

If you are interested in running this material locally on your computer, you will need to follow this workflow:

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

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

    git clone https://github.com/esgf2-us/esgf-cookbook.git

2. Move into the cookbook-example directory

   cd esgf-cookbook

3. Create and activate your conda environment from the environment.yml file

   conda env create -f environment.yml
   conda activate esgf-cookbook-dev

4. Move into the notebooks directory and start up Jupyterlab

   cd notebooks/
   jupyter lab