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.

Sign up for GitHub

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

Add Aircraft Examples and Update Docs #283

Merged
merged 15 commits into from
Oct 4, 2024
Merged

Add Aircraft Examples and Update Docs #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
84d0806
Add aircraft examples for AEROMMA
rschwant Oct 2, 2024
944e737
Add aircraft pairing example to docs
rschwant Oct 3, 2024
8e1a918
add aircraft plot example and update util to read example data
rschwant Oct 3, 2024
7f79bb8
Update docs to include reference tables for models and model variables
rschwant Oct 3, 2024
34b7545
fix output plots
rschwant Oct 4, 2024
ffcfd09
Update docs/examples/aircraft_pairing.rst
rschwant Oct 4, 2024
8e8384f
Update docs/examples/aircraft_pairing.rst
rschwant Oct 4, 2024
07b777b
Update docs/examples/aircraft_pairing.rst
rschwant Oct 4, 2024
f7202da
Update docs/examples/aircraft_pairing.rst
rschwant Oct 4, 2024
32b599b
Update docs/examples/aircraft_pairing.rst
rschwant Oct 4, 2024
0fbe949
Update docs/develop/datasets.rst
rschwant Oct 4, 2024
bf772b0
Update docs/develop/datasets.rst
rschwant Oct 4, 2024
08f9625
Update docs/develop/datasets.rst
rschwant Oct 4, 2024
aee6ed6
Update docs/develop/datasets.rst
rschwant Oct 4, 2024
6a37087
update variable table in datasets to be clearer
rschwant Oct 4, 2024
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
55 changes: 55 additions & 0 deletions docs/develop/datasets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,58 @@ While a part of the MONETIO repository,
the private MELODIES MONET readers are designated with prefix ``_mm``.

Support for additional models is also under developed.

Standard variables are required to be computed in each model reader for each capability including surface, aircraft, and satellite as specified in the table below.

.. list-table:: Required Variables for Model Readers
:widths: 10 30 30 30
:header-rows: 1

* - Capability
- | Variable Name
| in Code
- Description
- Additional Requirements
* - Surface
- | ``time``
| ``latitude``
| ``longitude``
- | Time in ``datetime64[ns]`` format
| Latitude in degrees
| Longitude in degrees
- | Provide only surface model data
| or if provide vertical model data,
| first level must be the level
| nearest to the surface.
| All gases are in ppb and
| all aerosols are in µg/m3.
Comment on lines +47 to +48
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is a "requirement", as you can get around magnitude differences, e.g., using MM config. But certainly it's usually easier if they are in these units.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to list it as a requirement, so that there is consistency in the tool. But of course, if people prefer not to do this, there will not be an error and you can fix it in the unit conversion step later.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also prefer "ppbv" if you agree.

* - Aircraft
- | ``time``
| ``latitude``
| ``longitude``
| ``pres_pa_mid``
| ``temperature_k``
- | Time in ``datetime64[ns]`` format
| Latitude in degrees
| Longitude in degrees
| Mid-level pressure in pascals (Pa)
| Mid-level temperature in kelvin (K)
- | Provide vertical model data.
| All gases are in ppb and
| all aerosols are in µg/m3.
* - Satellites
- | ``time``
| ``latitude``
| ``longitude``
| ``pres_pa_mid``
| ``temperature_k``
| ``dz_m``
| ``surfpres_pa``
- | Time in ``datetime64[ns]`` format
| Latitude in degrees
| Longitude in degrees
| Mid-level pressure in pascals (Pa)
| Mid-level temperature in kelvin (K)
| Layer thickness in meters (m)
| Surface pressure in pascals (Pa)
- | Provide vertical model data.
20 changes: 0 additions & 20 deletions docs/develop/developers_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,26 +26,6 @@ via pull requests.
Forks of the central repository should follow the same
branching conventions.

develop_aircraft
________________
The *develop_aircraft* branch is the place
for adding new features related to aircraft observations.

develop_satellite
_________________
The *develop_satellite* branch is intended
for adding support for reading and processing
satellite observations.
This includes both gridded satellite data products
and swath or geostationary disk data products.
Sub-branches are sometimes created off of *develop_satellite*,
such as *develop_satellite_swath*.

develop_testsuite
_________________
The *develop_testsuite* branch holds modules
under development for unit tests and regression tests.

.. _dev-install-instructions:

Setting up your development environment
Expand Down
Loading
Loading