Skip to content
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _create_obs_sequence:

program ``create_obs_sequence``
===============================

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _pmo:

program ``perfect_model_obs``
=============================

Expand Down
5 changes: 2 additions & 3 deletions guide/adding-your-observations-to-dart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ converted from its native format to the DART observation sequence format and
that the observation forward operator is already implemented. Keep in mind that
forward operators are not specific to any one model.

The observation converters are in the *observations/obs_converter* directory and
you should look there for the documentation describing which converters are
available.
The observation converters are in the *observations/obs_converter* directory,
and are documented in :ref:`available_observation_converters`.

The forward operators are functionally or logically grouped into Fortran modules
in the *observations/forward_operator* directory. DART employs a ‘contractual’
Expand Down
2 changes: 1 addition & 1 deletion guide/advice-for-new-collaborators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ DART is often used for the following types of projects:
- Using DART to teach DA

You can view a list of models that are already supported at :ref:`Supported models`
and a list of supported observations at :ref:`programs`.
and a list of supported observations at :ref:`available_observation_converters`.

Everything on this "possible goals" list except adding support for a new model
can generally be done by a single user with minimal help from the DART team.
Expand Down
121 changes: 72 additions & 49 deletions guide/available-observation-converters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _available_observation_converters:

Available observation converter programs
========================================

Expand All @@ -7,60 +9,65 @@ into the format required by DART.

Each directory has at least one converter:

- ``AIRS``: :doc:`/observations/obs_converters/AIRS/README`
- ``ARVOR``: :doc:`../observations/obs_converters/ARVOR/readme`

- ``AIRS``: :ref:`airs`
- ``ARVOR``: :ref:`arvor`
- ``AURA``: See ``DART/observations/obs_converters/AURA``
- ``Aviso+/CMEMS``: :doc:`../observations/obs_converters/AVISO/AVISO`
- ``Ameriflux``: :doc:`../observations/obs_converters/Ameriflux/level4_to_obs`
- ``BATS``: :doc:`../observations/obs_converters/BATS/readme`
- ``CHAMP``: :doc:`../observations/obs_converters/CHAMP/work/README`
- ``cice``: :doc:`../observations/obs_converters/cice/cice_to_obs`
- ``Aviso+/CMEMS``: :ref:`aviso`
- ``Ameriflux``:

- :ref:`fluxnetfull_to_obs`
- :ref:`level4_to_obs`
- ``BATS``: :ref:`bats`
- ``CHAMP``: :ref:`champ`
- ``cice``: :ref:`cice_to_obs`
- ``CNOFS``: See ``DART/observations/obs_converters/CNOFS``
- ``CONAGUA``: :doc:`../observations/obs_converters/CONAGUA/README`
- ``COSMOS``: :doc:`../observations/obs_converters/COSMOS/COSMOS_to_obs`
- ``CrocoLake``: :doc:`../observations/obs_converters/CrocoLake/readme`
- ``DWL``: :doc:`../observations/obs_converters/DWL/dwl_to_obs`
- ``GMI``: :doc:`../observations/obs_converters/GMI/README`
- ``GOES``: :doc:`../observations/obs_converters/GOES/README`
- ``GPSPW``: :doc:`../observations/obs_converters/GPSPW/README`
- ``CONAGUA``: :ref:`conagua`
- ``COSMOS``: :ref:`cosmos`
- ``CrocoLake``: :ref:`crocolake`
- ``DWL``: :ref:`dwl`
- ``GMI``: :ref:`gmi`
- ``GOES``: :ref:`goes`
- ``GPSPW``: :ref:`gpspw`
- ``GRACE``: See ``DART/observations/obs_converters/GRACE``
- ``GSI2DART``: :doc:`../observations/obs_converters/GSI2DART/readme`
- ``GTSPP``: :doc:`../observations/obs_converters/GTSPP/GTSPP`
- ``HFradar``: :doc:`../observations/obs_converters/HFradar/readme`
- ``GSI2DART``: :ref:`gsi2dart`
- ``GTSPP``: :ref:`gtspp`
- ``HFradar``: :ref:`hfradar`
- ``IODA``: :ref:`ioda2obsq <ioda2obsq>`
- ``MADIS``: :doc:`../observations/obs_converters/MADIS/MADIS`
- ``MIDAS``: :doc:`../observations/obs_converters/MIDAS/MIDAS_to_obs`
- ``MODIS``: :doc:`../observations/obs_converters/MODIS/MOD15A2_to_obs`
- ``MODIS``: :doc:`../observations/obs_converters/MODIS/MOD29E1D_to_obs`
- ``MADIS``: :ref:`madis`
- ``MIDAS``: :ref:`midas`
- ``MODIS``: :ref:`modis15`
- ``MODIS``: :ref:`modis29`
- ``MPD``: See ``DART/observations/obs_converters/MPD``
- ``NCEP``: (prepbufr -> ascii) :doc:`../observations/obs_converters/NCEP/prep_bufr/prep_bufr`
- ``NCEP``: (ascii -> obs_seq) :doc:`../observations/obs_converters/NCEP/ascii_to_obs/create_real_obs`
- ``ROMS``: :doc:`../observations/obs_converters/ROMS/ROMS`
- ``SIF``: :doc:`../observations/obs_converters/SIF/SIF_to_obs_netcdf`
- ``SSEC``: :doc:`../observations/obs_converters/SSEC/SSEC`
- ``SST``: :doc:`../observations/obs_converters/SST/SST`
- ``SSUSI``: :doc:`../observations/obs_converters/SSUSI/convert_f16_edr_dsk`
- ``WOD``: :doc:`../observations/obs_converters/WOD/WOD`
- ``gnd_gps_vtec``: :doc:`../observations/obs_converters/gnd_gps_vtec/README`
- ``GPS``: :doc:`../observations/obs_converters/gps/gps`
- ``ok_mesonet``: :doc:`../observations/obs_converters/ok_mesonet/ok_mesonet`
- ``QuikSCAT``: :doc:`../observations/obs_converters/quikscat/QuikSCAT`
- ``Radar``: :doc:`../observations/obs_converters/radar/README`
- ``snow``: :doc:`../observations/obs_converters/snow/snow_to_obs`
- ``SVP``: :doc:`../observations/obs_converters/SVP/readme`
- ``Text``: :doc:`../observations/obs_converters/text/text_to_obs`
- ``NASA_Earthdata``: :ref:`nasa_earthdata`
- ``NCEP``:

- (prepbufr -> ascii) :ref:`ncep_prepbufr`
- (ascii -> obs_seq) :ref:`ncep_ascii`
- ``NSIDC``: :ref:`nsidc_smap_l2`
- ``ocean color``: :ref:`ocean_color`
- ``ROMS``: :ref:`roms`
- ``SIF``: :ref:`sif`
- ``SSEC``: :ref:`ssec`
- ``SST``: :ref:`sst`
- ``SSUSI``: :ref:`ssusi`
- ``WOD``: :ref:`wod`
- ``gnd_gps_vtec``: :ref:`gnd_gps_vtec`
- ``GPS``: :ref:`gps`
- ``ok_mesonet``: :ref:`ok_mesonet`
- ``QuikSCAT``: :ref:`quikscat`
- ``Radar``: :ref:`radar`
- ``snow``: :ref:`snow`
- ``SVP``: :ref:`svp`
- ``Text``: :ref:`text`
- ``text_GITM``: See ``DART/observations/obs_converters/text_GITM``
- ``tpw``: :doc:`../observations/obs_converters/tpw/tpw`
- ``Tropical Cyclones``: :doc:`../observations/obs_converters/tropical_cyclone/tc_to_obs`
- ``Var (little-r)``: :doc:`../observations/obs_converters/var/littler_tf_dart`
- ``Var (radar)``: :doc:`../observations/obs_converters/var/rad_3dvar_to_dart`
- ``tpw``: :ref:`tpw`
- ``Tropical Cyclones``: :ref:`tropical_cyclone`
- ``Var (3D/4D)``: :ref:`var`

There are also a couple utilities of note:
- ``Var (little-r)``: :ref:`littler_tf_dart`
- ``Var (radar)``: :ref:`rad_3dvar_to_dart`

- :doc:`../observations/obs_converters/even_sphere/README` - a utility for generating evenly-spaced
observation locations that can then be used in a perfect model experiment.
- :doc:`../observations/obs_converters/obs_error/README` - modules that specify observation errors
based on what is used by ECMWF and NCEP

In addition the following external program produces DART observation sequence
files:
Expand All @@ -72,15 +79,31 @@ files:
three-dimensions (Cartesian). Analyses are output in netCDF, Vis5d, and/or
DART (Data Assimilation Research Testbed) formats.

Contact the `DART development group <mailto:[email protected]>`__ if you
have observations in a different format that you want to convert. We can
give you advice and pointers on how to approach writing the code.

.. _synthetic_observations:

Synthetic observations
--------------------------

For generating synthetic observations, see the documentation for the
:doc:`../assimilation_code/programs/create_obs_sequence/create_obs_sequence`.
:ref:`create_obs_sequence`.
You can also generate observation files based on text input. See the
documentation for the :doc:`../observations/obs_converters/text/text_to_obs`.
documentation for the :ref:`text`.
Or for simulating a large complex observing system, you can use the DART
library routines in a Fortran program to compute the observation information
and have the DART routines write the output file.

There are also a couple utilities of note:

- :ref:`even_sphere` - a utility for generating evenly-spaced
observation locations that can then be used in a perfect model experiment.
- :ref:`obs_error` - modules that specify observation errors
based on what is used by ECMWF and NCEP

To learn how to run a model with a set of observations that have only
locations, types, and times, and have the forward operators compute the
observation values, see the documentation for the
:doc:`/assimilation_code/programs/perfect_model_obs/perfect_model_obs`.
:ref:`pmo`.
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,6 @@ References
guide/detailed-structure-obs-seq
guide/creating-obs-seq-synthetic
guide/creating-obs-seq-real
guide/available-observation-converters
guide/manipulating-with-obs-sequence-tool
guide/difference-between-type-and-quantity
guide/adding-support-new-type
Expand All @@ -320,6 +319,7 @@ References
:caption: Observation Converters

observations/obs_converters/README
guide/available-observation-converters


.. toctree::
Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/AIRS/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _airs:

AIRS and AMSU
=============

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/ARVOR/readme.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _arvor:

ARVOR (Profiling Floats)
========================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/AVISO/AVISO.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _aviso:

Aviso+/CMEMS Observations
=========================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/Ameriflux/fluxnetfull_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _fluxnetfull_to_obs:

PROGRAM ``fluxnetfull_to_obs``
==============================

Expand Down
4 changes: 3 additions & 1 deletion observations/obs_converters/Ameriflux/level4_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _level4_to_obs:

PROGRAM ``level4_to_obs``
=========================

Expand All @@ -10,7 +12,7 @@ AmeriFlux level 4 data to DART observation sequence converter
| This routine was designed to convert the flux tower Level 4 data from the `AmeriFlux <http://ameriflux.lbl.gov>`__
network of observations from micrometeorological tower sites. The download link and flux data format for this code
*has been discontinued* (e.g. ``USBar2004_L4_h.txt``). Thus if you are using flux obs converters for the first time
*PLEASE USE* the updated ``Fluxnetfull_to_obs.f90`` converter and follow the documentation there :doc:`./fluxnetfull_to_obs`
*PLEASE USE* the updated ``Fluxnetfull_to_obs.f90`` converter and follow the documentation there :ref:`fluxnetfull_to_obs`.
We have kept this code available if you still use the older Ameriflux data format. Also this code uses a general approach
to calculating sensible, latent and net ecosystem exchange uncertainty, that may be helpful.
| The AmeriFlux Level 4 data products are provided in the local time of the flux tower location. DART observation sequence
Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/BATS/readme.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _bats:

BATS
====

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/CHAMP/work/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _champ:

CHAMP
=====

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/CONAGUA/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _conagua:

CONAGUA
=======

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/COSMOS/COSMOS_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _cosmos:

PROGRAM ``COSMOS_to_obs``
=========================

Expand Down
3 changes: 3 additions & 0 deletions observations/obs_converters/CrocoLake/readme.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _crocolake:

CrocoLake
=========

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/DWL/dwl_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _dwl:

PROGRAM ``dwl_to_obs``
======================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/GMI/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _gmi:

GMI Brightness Temperatures
============================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/GOES/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _goes:

NOAA GOES-R Series Advanced Baseline Imager (ABI) Level 1b Radiances
====================================================================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/GPSPW/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _gpspw:

GPSPW
=====

Expand Down
3 changes: 3 additions & 0 deletions observations/obs_converters/GSI2DART/readme.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _gsi2dart:

GSI2DART
========

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/GTSPP/GTSPP.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _gtspp:

GTSPP Observations
==================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/HFradar/readme.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _hfradar:

========
HF Radar
========
Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/MADIS/MADIS.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _madis:

MADIS Data Ingest System
========================

Expand Down
3 changes: 3 additions & 0 deletions observations/obs_converters/MIDAS/MIDAS_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _midas:

PROGRAM ``MIDAS_to_obs``
========================

Expand Down
3 changes: 3 additions & 0 deletions observations/obs_converters/MODIS/MOD15A2_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _modis15:

PROGRAM ``MOD15A2_to_obs``
==========================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/MODIS/MOD29E1D_to_obs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
pair: MOD29E1D_to_obs; MODIS
sea ice temperature

.. _modis29:

PROGRAM ``MOD29E1D_to_obs``
===========================

Expand Down
3 changes: 3 additions & 0 deletions observations/obs_converters/NASA_Earthdata/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _nasa_earthdata:

PROGRAMS ``LPRM_L3_to_obs.f90`` ``AMSR_E_L2_to_obs.f90``
===========================================================================
This is a brief description of the converters and utilities in this directory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

.. _ncep_ascii:

PROGRAM create_real_obs
=======================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/NCEP/prep_bufr/prep_bufr.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _ncep_prepbufr:

PROGRAM ``prepbufr``
====================

Expand Down
2 changes: 2 additions & 0 deletions observations/obs_converters/NSIDC/SMAP_L2_to_obs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _nsidc_smap_l2:

PROGRAM ``SMAP_L2_to_obs``
==========================

Expand Down
Loading