A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Radar Cookbook

This Project Pythia Cookbook covers the basics of working with weather radar data in Python.
https://github.com/projectpythia/radar-cookbook

Category: Sustainable Development
Sub Category: Education

Keywords from Contributors

transforms projection measur archiving compose data-catalog conversion grid animals generic

Last synced: about 3 hours ago
JSON representation

Repository metadata

A cookbook meant to work with various weather radar data

README.md

Radar Cookbook

nightly-build
Binder
DOI

This Project Pythia Cookbook covers the basics of working with weather radar data in Python.

Motivation

This cookbook provides the essential materials to learning how to work with weather radar data using Python.

Most of the curriculum is focused around the Python ARM Toolkit, which is defined as:

"a Python module containing a collection of weather radar algorithms and utilities. Py-ART is used by the Atmospheric Radiation Measurement (ARM) user facility for working with data from a number of its precipitation and cloud radars, but has been designed so that it can be used by others in the radar and atmospheric communities to examine, processes, and analyze data from many types of weather radars."

Once you go through this material, you will have the skills to read in radar data, apply data corrections, and visualize your data, building off of the core foundational Python material covered in the Foundations Book

Authors

Max Grover, Zachary Sherman, Milind Sharma, Alfonso Ladino, Crystal Camron, Takashi Unuma

Contributors

Structure

This cookbook is broken up into two main sections - "Foundations" and "Example Workflows."

Foundations

The foundational content includes the:

  • Py-ART Basics - an overview of Py-ART package, how to read in data, and basic plotting functionality
  • Py-ART Corrections - how to correct your data, especially when dealing with raw radar data
  • Py-ART Gridding - how to utilize the gridding tools in Py-ART

If you are new to Py-ART, starting with the basics is a good place to start, and is required to know before moving onto Py-ART Corrections and Py-ART Gridding.

Example Workflows

Here, we apply the lessons learned in the foundational material to various analysis workflows, including everything from reading in the data to plotting a beautiful visualization at the end. We include the additional dataset-specific details, focusing on building upon the foundational materials rather than duplicating previous content.

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
Foundations book 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
Shift 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:

  1. Clone the "radar-cookbook" repository

    git clone https://github.com/ProjectPythia/radar-cookbook.git
    
  2. Move into the radar-cookbook directory

    cd radar-cookbook
    
  3. Create and activate your conda environment from the environment.yml file

    conda env create -f environment.yml
    conda activate radar-cookbook-dev
    
  4. Move into the notebooks directory and start up Jupyterlab

    cd notebooks/
    jupyter lab
    

At this point, you can interact with the notebooks! Make sure to check out the "Getting Started with Jupyter" content from the Pythia Foundations material if you are new to Jupyter or need a refresher.

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
    orcid: https://orcid.org/0000-0002-0370-8974 # optional
    website: https://github.com/mgrover1
    affiliation: Argonne National Laboratory # optional
  - family-names: Sherman
    given-names: Zachary
  - family-names: Sharma
    given-names: Milind
    website: https://github.com/gewitterblitz 
    orcid: https://orcid.org/0000-0003-3318-7601
    affiliation: Texas A&M University
  - family-names: Ladino
    given-names: Alfonso
    website: https://github.com/aladinor
    orcid: https://orcid.org/0000-0001-8081-7827
    affiliation: University of Illinois at Urbana Champaign
  - family-names: Camron
    given-names: Crystal
    website: https://github.com/crystalclearwx
    orcid: https://orcid.org/0009-0009-6628-6287
    affiliation: Problem Solutions, Inc./AccuWeather, Inc.
  - family-names: Unuma
    given-names: Takashi
    website: https://github.com/TakashiUNUMA
    orcid: https://orcid.org/0000-0003-4350-9758
    affiliation: Meteorological Research Institute - Japan Meteorological Agency
  - name: "Radar Cookbook contributors" # use the 'name' field to acknowledge organizations
    website: "https://github.com/ProjectPythia/radar-cookbook/graphs/contributors"
title: "Radar Cookbook"
abstract: "A cookbook meant to work with various weather radar data."

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 139
Total Committers: 9
Avg Commits per committer: 15.444
Development Distribution Score (DDS): 0.482

Commits in past year: 12
Committers in past year: 4
Avg Commits per committer in past year: 3.0
Development Distribution Score (DDS) in past year: 0.417

Name Email Commits
Max Grover m****x@g****m 72
Brian Rose b****e@a****u 44
Julia Kent 4****t 10
dependabot[bot] 4****] 7
Milind Sharma s****1@p****u 2
Takashi Unuma k****u@g****m 1
Rich Signell r****l@u****v 1
Alfonso Ladino a****r@u****o 1
Crystal c****y@a****m 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 18
Total pull requests: 109
Average time to close issues: about 1 month
Average time to close pull requests: 3 days
Total issue authors: 4
Total pull request authors: 8
Average comments per issue: 2.06
Average comments per pull request: 1.44
Merged pull request: 95
Bot issues: 0
Bot pull requests: 8

Past year issues: 1
Past year pull requests: 2
Past year average time to close issues: N/A
Past year average time to close pull requests: about 1 month
Past year issue authors: 1
Past year pull request authors: 2
Past year average comments per issue: 1.0
Past year average comments per pull request: 1.0
Past year merged pull request: 2
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/projectpythia/radar-cookbook

Top Issue Authors

  • mgrover1 (13)
  • brian-rose (3)
  • jukent (1)
  • ktyle (1)

Top Pull Request Authors

  • brian-rose (49)
  • mgrover1 (42)
  • dependabot[bot] (8)
  • jukent (4)
  • gewitterblitz (2)
  • m-zoerner (2)
  • crystalclearwx (1)
  • rsignell-usgs (1)

Top Issue Labels

  • content (4)
  • enhancement (3)
  • bug (1)

Top Pull Request Labels


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
environment.yml conda
  • act-atmos >=1.2.0
  • arm_pyart
  • cartopy
  • datashader
  • hvplot
  • imageio
  • jupyter-book
  • jupyter_server
  • jupyterlab
  • matplotlib
  • metpy
  • numpy
  • panel
  • pip
  • python >=3.10
  • s3fs >=2024.3.1
  • sphinx-pythia-theme
  • xarray

Score: 5.241747015059643