atmos-modeling-cookbook

An open educational resource within Project Pythia for teaching atmospheric modeling fundamentals in Python with Numba

https://github.com/projectpythia/atmos-modeling-cookbook

Science Score: 54.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: sciencedirect.com, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

An open educational resource within Project Pythia for teaching atmospheric modeling fundamentals in Python with Numba

Basic Info
Statistics
  • Stars: 4
  • Watchers: 3
  • Forks: 14
  • Open Issues: 14
  • Releases: 0
Created almost 2 years ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

Fundamentals of Atmospheric Modeling Cookbook

thumbnail

nightly-build Binder DOI

This Project Pythia Cookbook covers the fundamentals of atmospheric modeling, including topics such as:

  • basic conservation equations
  • approaches to finite differencing
  • numerical scheme assessments
  • numerical corrections and filtering
  • coordinate systems
  • initial/boundary conditions
  • limitations and tradeoffs in modeling

Motivation

Numerical models are widely used, but gaining expertise in how they work has often been unnecessarily challenging. This cookbook hopes to address that! This is intended for a somewhat broad audience: those with at least some atmospheric dynamics knowledge, but nearly any level of programming experience (assuming a baseline level as covered in the Pythia Foundations).

Authors

Contributors

Addition contributions to discussions and decisions for this notebook by:

Resources

This cookbook would not be possible without the vast collection of academic texts and prior work in atmospheric modeling. The key resources used in building this notebook include:

Structure

(State one or more sections that will comprise the notebook. E.g., This cookbook is broken up into two main sections - "Foundations" and "Example Workflows." Then, describe each section below.)

Section 1 ( Replace with the title of this section, e.g. "Foundations" )

(Add content for this section, e.g., "The foundational content includes ... ")

Section 2 ( Replace with the title of this section, e.g. "Example workflows" )

(Add content for this section, e.g., "Example workflows include ... ")

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.

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/ProjectPythia/cookbook-example repository:

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

  1. Move into the cookbook-example directory bash cd cookbook-example
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate cookbook-example
  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: Keshri
    given-names: Shreya
    orcid: https://orcid.org/0009-0008-3236-0074 
    website: https://github.com/ShreyaK12345
    affiliation: The City College of New York (City University of New York) # optional
  - family-names: Rivera Tello
    given-names: Gerardo
    orcid: https://orcid.org/0000-0002-3131-8615
    website: https://github.com/griverat
    affiliation: University of Hawaiʻi at Mānoa
  - family-names: Wu
    given-names: Lin
    orcid: https://orcid.org/0009-0006-2290-4942 # optional
    website: https://github.com/lwu127 # optional
    affiliation: SUNY-ESF # optional
  - family-names: Samantaray
    given-names: Snigdha
    orcid: https://orcid.org/0009-0009-1617-1270
    website: https://github.com/snigsam
    affiliation: University of Miami
  - family-names: Freeman
    given-names: Brittany
    orcid: https://orcid.org/0009-0006-2806-1149
    website: https://github.com/bl-freeman
    affiliation: University at Albany (State University of New York)
  - family-names: Tyle
    given-names: Kevin
    orcid: https://orcid.org/0000-0001-5249-9665
    website: https://github.com/ktyle
    affiliation: University at Albany (State University of New York)
  - family-names: Thielen
    given-names: JT
    orcid: https://orcid.org/0000-0002-5479-0189
    website: https://github.com/jthielen
    affiliation: Colorado State University
  - name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
    website: "https://github.com/ProjectPythia/cookbook-template/graphs/contributors"
title: "Atmospheric Modeling Cookbook Collaborators"
abstract: "Add a description when done!"

GitHub Events

Total
  • Create event: 1
  • Issues event: 4
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 41
  • Push event: 146
  • Gollum event: 4
  • Pull request review comment event: 9
  • Pull request review event: 25
  • Pull request event: 31
Last Year
  • Create event: 1
  • Issues event: 4
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 41
  • Push event: 146
  • Gollum event: 4
  • Pull request review comment event: 9
  • Pull request review event: 25
  • Pull request event: 31