MODULES / NAMELIST / FILES / REFERENCES / ERRORS / PLANS / TERMS OF USE

PROGRAM create_ocean_obs

$Id: create_ocean_obs.html 11441 2017-04-06 22:00:44Z nancy@ucar.edu $

create_ocean_obs is responsible for converting an interim ASCII file of ocean observations into a DART observation sequence file. The interim ASCII file is a simple 'whitespace separated' table where each row is an observation and each column is specific information about the observation.

column number quantity description
1 longitude (in degrees) longitude of the observation
2 latitude (in degrees) latitude of the observation
3 depth (in meters) depth of the observation
4 observation value such as it is ...
5 vertical coordinate flag see location_mod:location_type for a full explanation. The short explanation is that surface == -1, and depth == 3 There is a pathological difference between a surface observation and an observation with a depth of zero.
6 observation variance good luck here ...
7 Quality Control flag integer value passed through to DART. There is a namelist parameter for filter to ignore any observation with a QC value <= input_qc_threshold
8 obs_kind_name a character string that must match a string in obs_def/obs_def_MITgcm_ocean_mod.f90
9 startDate_1 the year-month-date of the observation (YYYYMMDD format)
10 startDate_2 the hour-minute-second of the observation (HHMMSS format)

For example:

273.7500 21.3500 -2.5018 28.0441  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.4500 -2.5018 28.1524  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.5500 -2.5018 28.0808  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.6500 -2.5018 28.0143  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.7500 -2.5018 28.0242  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.8500 -2.5018 28.0160  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 21.9500 -2.5018 28.0077  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 22.0500 -2.5018 28.3399  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 22.1500 -2.5018 27.8852  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
273.7500 22.2500 -2.5018 27.8145  3 0.0400  1  GLIDER_TEMPERATURE 19960101  10000
...

It is always possible to combine observation sequence files with the program obs_sequence_tool, so it was simply convenient to generate a separate file for each observation platform and type ('GLIDER' and 'TEMPERATURE'), however it is by no means required.


MODULES USED

Some of these modules use modules ... those modules and namelists are not discussed here. probably should be ...

types_mod
utilities_mod
dart_MITocean_mod
obs_sequence_mod

NAMELIST

This program has a namelist of its own, and some of the underlying modules require namelists. To avoid duplication and, possibly, some inconsistency in the documentation; only a list of the required namelists is provided - with a hyperlink to the full documentation for each namelist.

NamelistPrimary Purpose
utilities_nml set the termination level and file name for the run-time log
obs_sequence_nml write binary or ASCII observation sequence files

We adhere to the F90 standard of starting a namelist with an ampersand '&' and terminating with a slash '/'. Consider yourself forewarned that filenames that contain a '/' must be enclosed in quotes to prevent them from prematurely terminating the namelist.

namelist /create_ocean_obs_nml/  year, month, day, &
         tot_days, max_num, fname, output_name, lon1, lon2, lat1, lat2

This namelist is read in a file called input.nml

Contents Type Description
year integer [default: 1996] The first year of interest.
month integer [default: 1] The first month of interest.
day integer [default: 1] The first day of interest.
tot_days integer [default: 31] Stop processing after this many days.
max_num integer [default: 800000] The maximum number of observations to read/write.
fname character(len=129)
[default: 'raw_ocean_obs.txt']
The name of the interim ASCII file of observations.
output_name character(len=129)
[default: 'raw_ocean_obs_seq.out']
The output file name.
lon1 real [default: 0.0] The leftmost longitude of interest.
lon2 real [default: 360.0] The rightmost longitude of interest.
lat1 real [default: -90.0] The most southern latitude of interest.
lat2 real [default: 90.0] The most northern latitude of interest.


FILES


REFERENCES


ERROR CODES and CONDITIONS

There are no error conditions specific to create_ocean_obs.

KNOWN BUGS

There are no known bugs.


FUTURE PLANS

None at this time. Feel free to suggest improvements.


Terms of Use

DART software - Copyright UCAR. This open source software is provided by UCAR, "as is", without charge, subject to all terms of use at http://www.image.ucar.edu/DAReS/DART/DART_download

Contact: Tim Hoar
Revision: $Revision: 11441 $
Source: $URL: https://svn-dares-dart.cgd.ucar.edu/DART/releases/Manhattan/models/MITgcm_ocean/create_ocean_obs.html $
Change Date: $Date: 2017-04-06 16:00:44 -0600 (Thu, 06 Apr 2017) $
Change history:  try "svn log" or "svn diff"