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 3 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 (10.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 15
  • Open Issues: 1
  • Releases: 2
Created 8 months ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

OSDF Cookbook

thumbnail

nightly-build Binder DOI

This Project Pythia Cookbook covers using the Open Science Data Federation (OSDF), a service for streaming scientific data across the globe.

Motivation

Have you ever been frustrated by the complications of accessing scientific data? Why can't it "just work", like watching a Netflix movie?

The OSDF is a service that simplifies the streaming of a wide range of scientific datasets with a goal that data access "just works". It is meant to improve data availability for researchers working at any scale from individual laptops to distributed computing services such as the OSG's OSPool.

This cookbook gives motivating use cases from the geoscience community, including using datasets from NSF NCAR's Research Data Archive (RDA) and the datasets of AWS OpenData.

Authors

Harsha R. Hampapura Brian Bockelman Alexander Hoelzemann Carrie Wall Emma Turetsky Amandha Wingert Barok Aashish Panta Joanmarie Del Vecchio Justin Hiemstra Douglas Schuster Riley Conroy Kibiwott Koech

Contributors

Structure

This cookbook is broken up into two pieces - some background knowledge on the OSDF service itself and then a series of motivating examples from different repositories accessible via the OSDF.

OSDF Fundamentals

What is the OSDF? Who supports it? How can it benefit from my science? A dive into the infrastructure itself.

Using Datasets from NCAR's Research Data Archive

NSF NCAR's Research Data Archive (RDA) contains a large collection of meteorological, atmospheric composition, and oceanographic observations, and operational and reanalysis model outputs, integrated with NSF NCAR High Performance Compute services to support atmospheric and geosciences research. This chapter demonstrates how to use common data science tools when streaming from the RDA.

Using Datasets from FIU's Envistor

Florida International University (FIU) runs the Envistor project, aggregating climate datasets from the south Florida region.

Using NOAA's SONAR Fisheries Datasets

NOAA maintains a copy of its SONAR-based datasets of Atlanta fisheries data in the popular Zarr format. This chapter shows how to load and use the datasets and fuse it with other products.

Using Sentinel Data from AWS

All of AWS OpenData is connected to the OSDF! This chapter includes examples of streaming Sentinel-2 data, stored in AWS's OpenData program, to your notebook.

Running the Notebooks

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

Running on Binder

The simplest way to interact with a Jupyter Notebook is through Binder, which enables the execution of a Jupyter Book in the cloud. 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.

Note, not all Cookbook chapters are executable. If you do not see the rocket ship icon, such as on this page, you are not viewing an executable book chapter.

Running on Your Own Machine

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

  1. Clone the https://github.com/ProjectPythia/osdf-cookbook repository:

bash git clone https://github.com/ProjectPythia/osdf-cookbook.git

  1. Move into the osdf-cookbook directory bash cd osdf-cookbook
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate osdf-cookbook
  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:
  - family-names: Hampapura
    given-names: Harsha R.
    orcid: https://orcid.org/0000-0002-2449-9032
    website: https://github.com/hrhampapura
    affiliation: NCAR

  - family-names: Hoelzemann
    given-names: Alexander
    orcid: https://orcid.org/0000-0001-6509-0009
    website: https://github.com/ahoelzemann
    affiliation: University of Colorado Boulder

  - family-names: Wall
    given-names: Carrie
    orcid: https://orcid.org/0000-0002-5315-8528
    website: https://github.com/carriecwall
    affiliation: University of Colorado Boulder and NOAA

  - family-names: Panta
    given-names: Aashish
    orcid: https://orcid.org/0009-0001-5843-2098
    affiliation: CEDMAV, University of Utah

  - family-names: Schuster
    given-names: Douglas
    orcid: https://orcid.org/0000-0003-0448-3591
    affiliation: NSF National Center for Atmospheric Research

  - family-names: Turetsky
    given-names: Emma T.
    orcid: https://orcid.org/0009-0001-0067-6540
    website: https://github.com/turetske
    affiliation: Morgridge Institute for Research

  - family-names: Wingert Barok
    given-names: Amandha
    orcid: https://orcid.org/0009-0001-3391-3741
    website: https://github.com/amandhawb
    affiliation: Florida International University

  - family-names: Bockelman
    given-names: Brian
    orcid: https://orcid.org/0000-0003-2981-3809
    website: https://github.com/bbockelm
    affiliation: Morgridge Institute for Research

  - family-names: Hiemstra
    given-names: Justin T.
    orcid: https://orcid.org/0009-0003-2993-0308
    website: https://github.com/jhiemstrawisc
    affiliation: Center for High Throughput Computing

  - family-names: Conroy
    given-names: Riley P.
    orcid: https://orcid.org/0009-0002-6453-2412
    website: https://github.com/rpconroy
    affiliation: NSF/NCAR

  - family-names: Del Vecchio
    given-names: Joanmarie
    orcid: https://orcid.org/0000-0003-3313-6097
    website: https://jmdelvecchio.github.io/
    affiliation: W&M

  - family-names: Koech
    given-names: Kibiwott
    orcid: https://orcid.org/0009-0004-3919-9739
    website: https://github.com/kkbch
    affiliation: W&M

  - name: OSDF cookbook contributors
    website: https://github.com/ProjectPythia/osdf-cookbook/graphs/contributors

title: "OSDF Cookbook"
abstract: "A sample cookbook description."

GitHub Events

Total
  • Create event: 4
  • Release event: 1
  • Issues event: 7
  • Delete event: 1
  • Member event: 4
  • Issue comment event: 59
  • Push event: 258
  • Pull request review event: 20
  • Pull request event: 94
  • Fork event: 14
Last Year
  • Create event: 4
  • Release event: 1
  • Issues event: 7
  • Delete event: 1
  • Member event: 4
  • Issue comment event: 59
  • Push event: 258
  • Pull request review event: 20
  • Pull request event: 94
  • Fork event: 14

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 v6 composite
environment.yml pypi