Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #322

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/melodies_monet_code_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 21 additions & 1 deletion docs/develop/developers_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,9 @@ project on GitHub to learn about current and future development.
`added an SSH key <https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account>`__
to your GitHub account for your current machine.
If you are new to GitHub, check out
`this GitHub tutorial <https://jlord.computer/git-it/>`__.

`Getting Started with GitHub on Project Pythia <https://foundations.projectpythia.org/foundations/getting-started-github.html>`__.

We recommend the SSH method, but if you don't add an SSH key
you can still clone the repositories via HTTPS, e.g. ::

Expand All @@ -184,3 +186,21 @@ project on GitHub to learn about current and future development.
$ conda env create -f docs/environment-docs.yml

to create a new conda environment (``melodies-monet-docs``).

Code workflow
-------------

The way the code is constructed (see :doc:`../getting_started/software_architecture`)
is based largely on code contained within a driver (``dirver.py``).
The main class, contained in ``driver.py``, is ``analysis``.
``analysis`` is in charge of creating and managing all other classes.
This driver contains the ``observation``, ``model`` and ``pair`` classes,
using the tools that can be found in ``util``.
Even though, right now, the driver.py is quite large,
we are working on reducing its complexity and,
as far as possible, managing most with specific utilities.

.. figure:: ../_static/melodies_monet_code_workflow.png
:alt: generalized workflow of the code.

Generalized structure of the code and its workflow.
81 changes: 50 additions & 31 deletions docs/develop/development_team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,35 @@ Development Team

MELODIES MONET development is a collaboration between NOAA Chemical Sciences
Laboratory (CSL), NOAA Air Resources Laboratory (ARL), NOAA Global Systems
Laboratory (GSL), and NCAR Atmospheric Chemistry Observations and Modeling
Laboratory (GSL), and NSF NCAR Atmospheric Chemistry Observations and Modeling
(ACOM) Laboratory. The representative leads for each organization are below.

=============== =============================
Organization Representative(s)
=============== =============================
NOAA CSL Rebecca Schwantes
=============== =============================
Organization Representative(s)
=============== =============================
NOAA CSL Rebecca Schwantes
NOAA ARL Barry Baker
NOAA GSL Jordan Schnell
NCAR ACOM Louisa Emmons, David Fillmore
NOAA GSL Jordan Schnell
NSF NCAR/ACOM Louisa Emmons, David Fillmore
=============== =============================

Code Reviewers
--------------

================= =============== ========================================================
Reviewer GitHub Username Expertise
================= =============== ========================================================
Zachary Moon zmoon Docs, Connections to MONET and MONETIO, CI tests
David Fillmore dwfncar Satellite obs, Plots, Stats, Connection to METplus
Colin Harkins colin-harkins Docs, Aircraft obs, Plots, Stats
Louisa Emmons lkemmons Docs, Aircraft obs, Plots, Stats
Rebecca Schwantes rschwant Docs, Surface and aircraft obs, Plots, Stats
================= =============== ========================================================
================== =============== ========================================================
Reviewer GitHub Username Expertise
================== =============== ========================================================
Zachary Moon zmoon Docs, Connections to MONET and MONETIO, CI tests
David Fillmore dwfncar Satellite obs, Plots, Stats, Connection to METplus
Colin Harkins colin-harkins Docs, Aircraft obs, Plots, Stats
Louisa Emmons lkemmons Docs, Aircraft obs, Plots, Stats
Rebecca Schwantes rschwant Docs, Surface and aircraft obs, Plots, Stats
Margaret Bruckner mbruckner-work Docs, Satellite obs, Plots, Stats
Rebecca Buchholz rrbuchholz Docs, Satellite obs, Plots, Stats
Pablo Lichtig blychs Docs, Satellite and surface obs, Plots, Stats
Quazi Ziaur Rasool quaz115 Docs, Aircraft obs, Plots, Stats
Beiming Tang btang1 Docs, Surface and ozone sonder obs, Plots, Stats
================== =============== ========================================================

Development Team Members
------------------------
Expand All @@ -53,13 +58,13 @@ primarily focus on adding capabilities for comparison of satellite observations
output and expanding data processing options.

**Rebecca Buchholz:**
I am a Project Scientist at NCAR/ACOM helping with the development of MELODIES MONET.
I am a Project Scientist at NSF NCAR/ACOM helping with the development of MELODIES MONET.
My development plans include incorporating satellite datasets such as MOPITT CO and
ground-based remote sensing observations such as from NDACC or TCCON; incorporating
model output from CESM2; and expanding the analysis of model comparisons with remote
sensing data.

**Patrick C. Campbell**
**Patrick C. Campbell:**
I am a research assistant professor at George Mason University and a NOAA-Air
Resources Laboratory affiliate. I have contributed to the base Community Multiscale
Air Quality (CMAQ) model analysis scripts used in MONET, used in support of development
Expand All @@ -69,20 +74,20 @@ development of model evaluation and statistical analysis techniques, adding more
observational datasets, and adding the capability of pairing to 3D aircraft observations
(e.g., CMAQ-ICARTT) to MELODIES MONET.

**Louisa Emmons**
I am a Scientist at NCAR/ACOM and PI of the NSF Earthcube MELODIES grant. I have been
**Louisa Emmons:**
I am a Scientist at NSF NCAR/ACOM and PI of the NSF Earthcube MELODIES grant. I have been
working on comparisons of model results and observations for over 20 years and hope to
contribute to many aspects of the development.

**David Fillmore**
I am a software developer at NCAR ACOM and work on MELODIES MONET and the NASA CERES project.
**David Fillmore:**
I am a software developer at NSF NCAR/ACOM and work on MELODIES MONET and the NASA CERES project.
My primary focus is adding functionality for satellite dataset analysis within MELODIES MONET,
in particular ungridded satellite observations on an orbital swath or geostationary disc view.
I will also be adding and maintaining a tests suite for unit/regression tests and tutorial
examples.

**Duseong Jo**
I am a postdoc at NCAR ACOM. My development plans include expanding MELODIES-MONET to deal
**Duseong Jo:**
I am a postdoc at NSF NCAR/ACOM. My development plans include expanding MELODIES-MONET to deal
with unstructured grids and related plotting tools, adding custom options for more flexibility,
and bringing in new regridding capabilities.

Expand All @@ -99,13 +104,27 @@ additional surface observational datasets, adding the capability of pairing
to aircraft observations, and expanding plotting and statistics for analysis
of aircraft data.

**Jun Zhang**
I am a postdoc at ACOM NCAR. My research interests are at the UTLS region.
**Jun Zhang:**
I am a postdoc at NSF NCAR/ACOM. My research interests are at the UTLS region.
I am hoping to add cross-section plots (lat vs height) and also to incorporate MLS data
for comparison.






**Pablo Lichtig:**
I am a postdoc at NSF NCAR/ACOM. My development plans include adding TEMPO support,
working with remote sensing instruments from the surface and adding support for BoulderAir
and other surface networks, and expanding MELODIES-MONET to other regional and global
models.

**Quazi Ziaur Rasool**
I am a research scientist at CIRES/NOAA CSL helping with MELODIES-MONET development.
My development plans include incorporating new comparisons (already tested) for aircraft
observation datasets such as FIREX, ASIA-AQ, and AEROMMA with model output from WRF-Chem
(regional), UFS-AQM (global); and expanding the analysis of model-aircraft comparisons
with new visualizations (for e.g., curtain plots, spatial plots along aircraft tracks,
vertical profiles, time series with altitude) and new observations or model data pairing of
interest.

**Beiming Tang**
Dr. Beiming Tang is a postdoc at NOAA Air Resources Laboratory.
His research focuses on developing NOAA's Atmospheric Composition forecast model by advancing AI techniques, MELODIES MONET development, and supporting UFS-AQM evaluations.
For the development of MELODIES MONET, Beiming created surface multi-box plot, scorecard, and CSI plots, and ozonesonde plots and TOLNet plots.