[Dart-dev] [3635] DART/trunk/models/MITgcm_ocean:
Added the documentation for create_ocean_obs, and changed namelist
nancy at ucar.edu
nancy at ucar.edu
Tue Oct 21 11:24:18 MDT 2008
An HTML attachment was scrubbed...
URL: http://mailman.ucar.edu/pipermail/dart-dev/attachments/20081021/e17464e4/attachment.html
-------------- next part --------------
Modified: DART/trunk/models/MITgcm_ocean/create_ocean_obs.f90
===================================================================
--- DART/trunk/models/MITgcm_ocean/create_ocean_obs.f90 2008-10-20 14:09:47 UTC (rev 3634)
+++ DART/trunk/models/MITgcm_ocean/create_ocean_obs.f90 2008-10-21 17:24:17 UTC (rev 3635)
@@ -51,7 +51,7 @@
lat1 = -90.0_r8, & ! lower latitude bound
lat2 = 90.0_r8 ! upper latitude bound
-namelist /ocean_obs_nml/ year, month, day, tot_days, max_num, &
+namelist /create_ocean_obs_nml/ year, month, day, tot_days, max_num, &
fname, output_name, lon1, lon2, lat1, lat2
! ----------------------------------------------------------------------
@@ -66,14 +66,14 @@
call static_init_obs_sequence()
! Read the namelist entry
-call find_namelist_in_file("input.nml", "ocean_obs_nml", iunit)
-read(iunit, nml = ocean_obs_nml, iostat = io)
-call check_namelist_read(iunit, io, "ocean_obs_nml")
+call find_namelist_in_file("input.nml", "create_ocean_obs_nml", iunit)
+read(iunit, nml = create_ocean_obs_nml, iostat = io)
+call check_namelist_read(iunit, io, "create_ocean_obs_nml")
! Record the namelist values used for the run ...
-call error_handler(E_MSG,'create_ocean_obs','ocean_obs_nml values are',' ',' ',' ')
-if (do_output()) write(logfileunit, nml=ocean_obs_nml)
-if (do_output()) write( * , nml=ocean_obs_nml)
+call error_handler(E_MSG,'create_ocean_obs','create_ocean_obs_nml values are',' ',' ',' ')
+if (do_output()) write(logfileunit, nml=create_ocean_obs_nml)
+if (do_output()) write( * , nml=create_ocean_obs_nml)
lon1 = min(max(lon1,0.0_r8),360.0_r8)
lon2 = min(max(lon2,0.0_r8),360.0_r8)
Added: DART/trunk/models/MITgcm_ocean/create_ocean_obs.html
===================================================================
--- DART/trunk/models/MITgcm_ocean/create_ocean_obs.html (rev 0)
+++ DART/trunk/models/MITgcm_ocean/create_ocean_obs.html 2008-10-21 17:24:17 UTC (rev 3635)
@@ -0,0 +1,310 @@
+<HTML>
+<HEAD>
+<TITLE>program create_ocean_obs</TITLE>
+<link rel="stylesheet" type="text/css" href="../../doc/html/doc.css"></link>
+</HEAD>
+<BODY>
+<!--
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! !!
+!! GNU General Public License !!
+!! !!
+!! This file is part of the Data Assimilation Research Testbed (DART). !!
+!! !!
+!! DART is free software; you can redistribute it and/or modify !!
+!! it and are expected to follow the terms of the GNU General Public !!
+!! License as published by the Free Software Foundation. !!
+!! !!
+!! DART is distributed in the hope that it will be useful, !!
+!! but WITHOUT ANY WARRANTY; without even the implied warranty of !!
+!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the !!
+!! GNU General Public License for more details. !!
+!! !!
+!! You should have received a copy of the GNU General Public License !!
+!! along with DART; if not, write to: !!
+!! Free Software Foundation, Inc. !!
+!! 59 Temple Place, Suite 330 !!
+!! Boston, MA 02111-1307 USA !!
+!! or see: !!
+!! http://www.gnu.org/licenses/gpl.txt !!
+!! !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+-->
+
+<DIV ALIGN=CENTER>
+<A HREF="#Namelist">NAMELIST</A> /
+<A HREF="#FilesUsed">FILES</A> /
+<A HREF="#References">REFERENCES</A> /
+<A HREF="#Errors">ERRORS</A> /
+<A HREF="#KnownBugs">BUGS</A> /
+<A HREF="#FuturePlans">PLANS</A>
+</DIV>
+
+<!--==================================================================-->
+
+<H1>PROGRAM create_ocean_obs</H1>
+<A NAME="HEADER"></A>
+<TABLE summary="">
+<TR><TD>Contact: </TD><TD> Tim Hoar </TD></TR>
+<TR><TD>Revision: </TD><TD> $Revision$ </TD></TR>
+<TR><TD>Source: </TD><TD> $URL:
+http://subversion.ucar.edu/DAReS/DART/trunk/models/MITgcm_ocean/create_ocean_obs.html $ </TD></TR>
+<TR><TD>Change Date: </TD><TD> $Date$ </TD></TR>
+<TR><TD>Change history:</TD><TD> try "svn log" or "svn diff" </TD></TR>
+</TABLE>
+
+<!--==================================================================-->
+
+<A NAME="OVERVIEW"></A>
+<HR>
+<H2 class="indent1">OVERVIEW</H2>
+<P class="indent1">
+ <em class="program">create_ocean_obs</em> 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.
+</P>
+
+<TABLE border=2 cellpadding=3 class="indent1">
+<TR><TH align="left">column number</TH>
+ <TH align="left" width="30%">quantity</TH>
+ <TH align="left">description</TH></TR>
+
+<TR><TD> 1</TD>
+ <TD> longitude (in degrees)</TD>
+ <TD> longitude of the observation</TD></TR>
+<TR><TD> 2</TD>
+ <TD> latitude (in degrees)</TD>
+ <TD> latitude of the observation </TD></TR>
+<TR><TD> 3</TD>
+ <TD> depth (in meters)</TD>
+ <TD> depth of the observation </TD></TR>
+<TR><TD> 4</TD>
+ <TD> observation value</TD>
+ <TD> such as it is ... </TD></TR>
+<TR><TD> 5</TD>
+ <TD>vertical coordinate flag</TD>
+ <TD> see <a
+href="../../location/threed_sphere/location_mod.html#location_type">location_mod:location_type</a>
+ for a full explanation. The short explanation is that
+ <em>surface == -1</em>, and
+ <em>depth == 3</em> There is a pathological difference between
+ a surface observation and an observation with a depth of zero.</TD></TR>
+<TR><TD> 6</TD>
+ <TD> observation variance</TD>
+ <TD> good luck here ... </TD></TR>
+<TR><TD> 7</TD>
+ <TD> Quality Control flag</TD>
+ <TD> integer value passed through to DART. There is a namelist
+ parameter for <em class="program">filter</em> to ignore any
+ observation with a
+ QC value <= <a
+ href="../../filter/filter.html#Namelist">input_qc_threshold</a>
+ </TD></TR>
+<TR><TD> 8</TD>
+ <TD> obs_kind_name</TD>
+ <TD> a character string that must match a string in
+ <a href="../../obs_def/obs_def_MITgcm_ocean_model_mod.html">obs_def/obs_def_MITgcm_ocean_mod.f90</a></TD></TR>
+<TR><TD> 9</TD>
+ <TD> startDate_1</TD>
+ <TD> the year-month-date of the observation (YYYYMMDD format)</TD></TR>
+<TR><TD>10</TD>
+ <TD> startDate_2</TD>
+ <TD> the hour-minute-second of the observation (HHMMSS format)</TD></TR>
+</TABLE>
+
+<P class="indent1">For example:</P>
+<pre class="indent1">
+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
+...
+</pre>
+
+<P class="indent1">It is always possible to combine observation sequence
+files with the program
+<a href="../../obs_sequence/merge_obs_seq.html">merge_obs_seq</a>, 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.
+</P>
+
+<!--==================================================================-->
+
+<A NAME="OTHER MODULES USED"></A>
+<HR>
+<H2 class="indent1">OTHER MODULES USED</H2>
+<P class="indent1">
+Some of these modules use modules ... <strong>those</strong> modules and
+namelists are not discussed here. probably should be ...
+</P>
+<PRE class="indent1">
+types_mod
+utilities_mod
+ocean_obs_mod
+obs_sequence_mod
+</PRE>
+
+<!--==================================================================-->
+
+<A NAME="Namelist"></A>
+<HR>
+<H2 class="indent1">NAMELIST</H2>
+<P class="indent1">
+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.
+</P>
+
+<TABLE border=0 cellpadding=3 width=100% class="indent1">
+<TR><TH align="left">Namelist</TH><TH align="left">Primary Purpose</TH></TR>
+<TR><TD><a
+ href="../../utilities/utilities_mod.html#Namelist">utilities_nml</a></TD>
+ <TD>set the termination level and file name for the run-time log</TD></TR>
+
+<TR><TD><a
+ href="../../obs_sequence/obs_sequence_mod.html#Namelist">obs_sequence_nml</a></TD>
+ <TD>write binary or ASCII observation sequence files</TD></TR>
+</TABLE>
+
+<P class="indent1">
+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.
+</P>
+<div class=namelist><pre>
+<em class=call>namelist /create_ocean_obs_nml/ </em> year, month, day, &
+ tot_days, max_num, fname, output_name, lon1, lon2, lat1, lat2
+</pre>
+</div>
+<H3 class="indent1">Discussion</H3>
+
+<P class="indent1">This namelist is read in a file called <em class=file>input.nml</em>
+</P>
+
+<TABLE border=0 cellpadding=3 width=100% class="indent1">
+<TR><TH align=left>Contents </TH>
+ <TH align=left>Type </TH>
+ <TH align=left>Description </TH></TR>
+
+<TR><!--contents--><TD valign=top>year</TD>
+ <!-- type --><TD valign=top>integer <em class="unit">[default: 1996]</em></TD>
+ <!--descript--><TD>The first year of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>month</TD>
+ <!-- type --><TD valign=top>integer <em class="unit">[default: 1]</em></TD>
+ <!--descript--><TD>The first month of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>day</TD>
+ <!-- type --><TD valign=top>integer <em class="unit">[default: 1]</em></TD>
+ <!--descript--><TD>The first day of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>tot_days</TD>
+ <!-- type --><TD valign=top>integer <em class="unit">[default: 31]</em></TD>
+ <!--descript--><TD>Stop processing after this many days.</TD><TR>
+
+<TR><!--contents--><TD valign=top>max_num</TD>
+ <!-- type --><TD valign=top>integer <em class="unit">[default: 800000]</em></TD>
+ <!--descript--><TD>The maximum number of observations to read/write.</TD><TR>
+
+<TR><!--contents--><TD valign=top>fname</TD>
+ <!-- type --><TD valign=top>character(len=129)<br>
+ <em class="unit">[default: 'raw_ocean_obs.txt']</em></TD>
+ <!--descript--><TD>The name of the interim ASCII file of observations.</TD><TR>
+
+<TR><!--contents--><TD valign=top>output_name</TD>
+ <!-- type --><TD valign=top>character(len=129)<br>
+ <em class="unit">[default: 'raw_ocean_obs_seq.out']</em></TD>
+ <!--descript--><TD>The output file name.</TD><TR>
+
+<TR><!--contents--><TD valign=top>lon1</TD>
+ <!-- type --><TD valign=top>real <em class="unit">[default: 0.0]</em></TD>
+ <!--descript--><TD>The leftmost longitude of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>lon2</TD>
+ <!-- type --><TD valign=top>real <em class="unit">[default: 360.0]</em></TD>
+ <!--descript--><TD>The rightmost longitude of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>lat1</TD>
+ <!-- type --><TD valign=top>real <em class="unit">[default: -90.0]</em></TD>
+ <!--descript--><TD>The most southern latitude of interest.</TD><TR>
+
+<TR><!--contents--><TD valign=top>lat2</TD>
+ <!-- type --><TD valign=top>real <em class="unit">[default: 90.0]</em></TD>
+ <!--descript--><TD>The most northern latitude of interest.</TD><TR>
+</TABLE>
+
+<!--==================================================================-->
+<!-- Describe the Files Used by this module. -->
+<!--==================================================================-->
+
+<A NAME="FilesUsed"></A>
+<HR>
+<H2 class="indent1">FILES</H2>
+<UL class="indent1">
+ <LI>input namelist file: <em class="file">input.nml</em></LI>
+ <LI>input data file: as listed by
+ <em class="file">input.nml</em><em class="code">&create_ocean_obs_nml:fname</em></LI>
+ <LI>output data file: as listed by
+ <em class="file">input.nml</em><em
+ class="code">&create_ocean_obs_nml:output_name</em></LI>
+</UL>
+
+<!--==================================================================-->
+<!-- Cite references, if need be. -->
+<!--==================================================================-->
+
+<A NAME="References"></A>
+<HR>
+<H2 class="indent1">REFERENCES</H2>
+
+<!--==================================================================-->
+<!-- Describe all the error conditions and codes. -->
+<!-- Putting a <BR> after the synopsis creates a nice effect. -->
+<!--==================================================================-->
+
+<A NAME="Errors"></A>
+<HR>
+<H2 class="indent1">ERROR CODES and CONDITIONS</H2>
+<P class="indent1">There are no error conditions specific to
+<em class="program">create_ocean_obs</em>.
+</P>
+</div>
+
+<!--==================================================================-->
+<!-- Describe the bugs. -->
+<!--==================================================================-->
+
+<A NAME="KnownBugs"></A>
+<HR>
+<H2 class="indent1">KNOWN BUGS</H2>
+<P class="indent1">
+There are no known bugs.
+</P>
+
+<!--==================================================================-->
+<!-- Descibe Future Plans. -->
+<!--==================================================================-->
+
+<A NAME="FuturePlans"></A>
+<HR>
+<H2 class="indent1">FUTURE PLANS</H2>
+<P class="indent1">
+None at this time. Feel free to suggest improvements.
+</P>
+
+<!--==================================================================-->
+
+</BODY>
+</HTML>
Property changes on: DART/trunk/models/MITgcm_ocean/create_ocean_obs.html
___________________________________________________________________
Name: svn:mime-type
+ text/html
Name: svn:keywords
+ Date Rev Author URL Id
Name: svn:eol-style
+ native
Modified: DART/trunk/models/MITgcm_ocean/create_ocean_obs.nml
===================================================================
--- DART/trunk/models/MITgcm_ocean/create_ocean_obs.nml 2008-10-20 14:09:47 UTC (rev 3634)
+++ DART/trunk/models/MITgcm_ocean/create_ocean_obs.nml 2008-10-21 17:24:17 UTC (rev 3635)
@@ -1,4 +1,4 @@
-&ocean_obs_nml
+&create_ocean_obs_nml
year = 1996,
month = 1,
day = 1,
Modified: DART/trunk/models/MITgcm_ocean/model_mod.html
===================================================================
--- DART/trunk/models/MITgcm_ocean/model_mod.html 2008-10-20 14:09:47 UTC (rev 3634)
+++ DART/trunk/models/MITgcm_ocean/model_mod.html 2008-10-21 17:24:17 UTC (rev 3635)
@@ -1637,7 +1637,7 @@
... one long array. If <em class="code">.false.</em>,
the state vector is parsed into prognostic variables and
output that way -- much easier to use with 'ncview', for
- example.
+ example.</TD><TR>
<TR><!--contents--><TD valign=top>model_perturbation_amplitude</TD>
<!-- type --><TD valign=top>real(r8) <em class="unit">[default: 0.2]</em></TD>
<!--descript--><TD>The amount of noise to add when trying to perturb a single
Modified: DART/trunk/models/MITgcm_ocean/work/input.nml
===================================================================
--- DART/trunk/models/MITgcm_ocean/work/input.nml 2008-10-20 14:09:47 UTC (rev 3634)
+++ DART/trunk/models/MITgcm_ocean/work/input.nml 2008-10-21 17:24:17 UTC (rev 3635)
@@ -217,7 +217,7 @@
# fname = '../observations/ssh_pseudo.txt',
# fname = '../observations/tmi_pseudo.txt',
-&ocean_obs_nml
+&create_ocean_obs_nml
year = 1996,
month = 1,
day = 1,
More information about the Dart-dev
mailing list