Merge pull request #283 from rschwant/develop

Add Aircraft Examples and Update Docs
NOAA-CSL · Oct 4, 2024 · 4af3f04 · 4af3f04
2 parents 57e5b7e + 6a37087
commit 4af3f04
Show file tree

Hide file tree

Showing 20 changed files with 7,710 additions and 27 deletions.
diff --git a/docs/develop/datasets.rst b/docs/develop/datasets.rst
@@ -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.
+   * - 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.
diff --git a/docs/develop/developers_guide.rst b/docs/develop/developers_guide.rst
@@ -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