esgf-cookbook

Cookbook for ESGF-hosted datasets

https://github.com/projectpythia/esgf-cookbook

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Cookbook for ESGF-hosted datasets

Basic Info
Statistics
  • Stars: 3
  • Watchers: 5
  • Forks: 13
  • Open Issues: 6
  • Releases: 2
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

ESGF Cookbook

thumbnail

nightly-build Binder DOI

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 Juptyerhub or on your local machine.

Running on Binder

The simplest way to interact with a Jupyter Notebook is through the NIMBUS Juptyerhub, 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:

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

  1. Move into the cookbook-example directory bash cd esgf-cookbook
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate esgf-cookbook-dev
  3. Move into the notebooks directory and start up Jupyterlab bash cd notebooks/ jupyter lab

Owner

  • Name: Project Pythia
  • Login: ProjectPythia
  • Kind: organization
  • Email: projectpythia@ucar.edu
  • Location: United States of America

Community learning resource for Python-based computing in the geosciences

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this cookbook, please cite it as below."
authors:
  # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
  - family-names: Grover
    given-names: Maxwell A.
    orcid: https://orcid.org/0000-0002-0370-8974 # optional
    website: https://github.com/mgrover1 # optional
    affiliation: Argonne National Laboratory
  - family-names: Collier
    given-names: Nathan
    orcid: https://orcid.org/0000-0002-7367-3981
    website: https://github.com/nocollier
    affiliation: Oak Ridge National Laboratory
  - family-names: Ehbrecht
    given-names: Carsten
    website: https://github.com/cehbrecht
    affiliation:  German Climate Computing Center (DKRZ)
  - family-names: Nugent
    given-names: Jacqueline
    orcid: https://orcid.org/0000-0002-1392-1023
    website: https://github.com/jacnugent
    affiliation: University of Wyoming
  - family-names: Rivera Tello
    given-names: Gerardo A.
    orcid: https://orcid.org/0000-0002-3131-8615
    website: https://github.com/griverat
    affiliation: University of Hawaiʻi at Mānoa
title: "ESGF Cookbook"
abstract: "A cookbook for working with data from the Earth System Grid Federation."

GitHub Events

Total
  • Create event: 4
  • Release event: 1
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 28
  • Push event: 95
  • Pull request review event: 3
  • Pull request event: 24
  • Fork event: 3
Last Year
  • Create event: 4
  • Release event: 1
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 28
  • Push event: 95
  • Pull request review event: 3
  • Pull request event: 24
  • Fork event: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: about 7 hours
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 1
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: about 7 hours
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
  • mgrover1 (1)
  • clyne (1)
  • griverat (1)
  • jukent (1)
  • jacnugent (1)
Pull Request Authors
  • mgrover1 (12)
  • jacnugent (3)
  • brian-rose (2)
  • dependabot[bot] (2)
  • jukent (2)
  • halderm100 (2)
  • nocollier (1)
  • griverat (1)
Top Labels
Issue Labels
content (1) bug (1)
Pull Request Labels
dependencies (2) github_actions (2)

Dependencies

.github/workflows/nightly-build.yaml actions
.github/workflows/publish-book.yaml actions
.github/workflows/trigger-book-build.yaml actions
.github/workflows/trigger-delete-preview.yaml actions
.github/workflows/trigger-link-check.yaml actions
.github/workflows/trigger-preview.yaml actions
.github/workflows/trigger-replace-links.yaml actions
  • actions/checkout v4 composite
  • jacobtomlinson/gha-find-replace v3 composite
  • stefanzweifel/git-auto-commit-action v5 composite
environment.yml pypi
  • sphinx-pythia-theme *