radar-cookbook

A cookbook meant to work with various weather radar data

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

Science Score: 64.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
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    4 of 9 committers (44.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords from Contributors

gridding interactive mesh interpretability sequences generic projection optim embedded hacking
Last synced: 10 months ago · JSON representation ·

Repository

A cookbook meant to work with various weather radar data

Basic Info
Statistics
  • Stars: 13
  • Watchers: 3
  • Forks: 16
  • Open Issues: 9
  • Releases: 2
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

Radar Cookbook

radar thumbnail

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

Running on Binder

The simplest way to interact with a is through , 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 {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:

  1. Clone the "radar-cookbook" repository

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

  1. Move into the radar-cookbook directory

bash cd radar-cookbook

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

bash conda env create -f environment.yml conda activate radar-cookbook-dev

  1. Move into the notebooks directory and start up Jupyterlab bash 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.

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
    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."

GitHub Events

Total
  • Issues event: 3
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 59
  • Pull request review event: 2
  • Pull request event: 12
  • Create event: 2
Last Year
  • Issues event: 3
  • Watch event: 3
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 59
  • Pull request review event: 2
  • Pull request event: 12
  • Create event: 2

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 142
  • Total Committers: 9
  • Avg Commits per committer: 15.778
  • Development Distribution Score (DDS): 0.486
Past Year
  • Commits: 9
  • Committers: 3
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.444
Top Committers
Name Email Commits
Max Grover m****x@g****m 73
Brian Rose b****e@a****u 44
Julia Kent 4****t 12
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 (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 15
  • Total pull requests: 94
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 4
  • Total pull request authors: 8
  • Average comments per issue: 2.4
  • Average comments per pull request: 1.4
  • Merged pull requests: 81
  • Bot issues: 0
  • Bot pull requests: 7
Past Year
  • Issues: 1
  • Pull requests: 8
  • Average time to close issues: N/A
  • Average time to close pull requests: 23 days
  • Issue authors: 1
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mgrover1 (12)
  • brian-rose (3)
  • crystalclearwx (1)
  • jukent (1)
  • ktyle (1)
Pull Request Authors
  • brian-rose (48)
  • mgrover1 (34)
  • dependabot[bot] (7)
  • jukent (7)
  • gewitterblitz (2)
  • crystalclearwx (1)
  • m-zoerner (1)
  • rsignell-usgs (1)
Top Labels
Issue Labels
content (5) enhancement (3) bug (1) infrastructure (1)
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