Changeset 4132

Timestamp:

2013-10-25T12:57:37+02:00 (11 years ago)

Author:

andrewryan

Message:

renamed namoff to namooo to further reduce confusion with OFF_SRC, documentation, quick script, example namelist and data module have been updated and tested to reflect this change

Location:

branches/2013/dev_r3987_UKMO4_OBS

Files:

• DOC/TexFiles/Chapters/Chap_OBS.tex (modified) (8 diffs)
• NEMOGCM/NEMO/OOO_SRC/ooo.nml (modified) (1 diff)
• NEMOGCM/NEMO/OOO_SRC/ooo_data.F90 (modified) (3 diffs)
• NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/locator.py (modified) (4 diffs)
• NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/ooo.py (modified) (3 diffs)

branches/2013/dev_r3987_UKMO4_OBS/DOC/TexFiles/Chapters/Chap_OBS.tex

@@ -852 +852 @@
 The observation files and settings understood by \textbf{namobs} have been outlined in the online
 obs oper section. In addition there are two further namelists wich control the operation of the offline
-obs oper. \textbf{namoff} which controls the input model fields and \textbf{namcl4} which controls the
+obs oper. \textbf{namooo} which controls the input model fields and \textbf{namcl4} which controls the
 production of class 4 files. 
 
@@ -863 +863 @@
 \textbf{votemper}, \textbf{vosaline} and optionally \textbf{sshn} present.
 
-For each field read there must be an entry in the \textbf{namoff} namelist specifying the
+For each field read there must be an entry in the \textbf{namooo} namelist specifying the
 name of the file to read and the index along the \emph{time\_counter}. For example, to
 read the second time counter from a single file the namelist would be.
@@ -871 +871 @@
 \begin{verbatim} 
 !----------------------------------------------------------------------
-!       namoff Offline obs_oper namelist
+!       namooo Offline obs_oper namelist
 !----------------------------------------------------------------------
 !   ooo_files    specifies the files containing the model counterpart
 !   nn_ooo_idx   specifies the time_counter index within the model file
-&namoff
+&namooo
    ooo_files = "foo.nc"
    nn_ooo_idx = 2
@@ -892 +892 @@
 \begin{verbatim} 
 !----------------------------------------------------------------------
-!       namoff Offline obs_oper namelist
+!       namooo Offline obs_oper namelist
 !----------------------------------------------------------------------
 !   ooo_files    specifies the files containing the model counterpart
 !   nn_ooo_idx   specifies the time_counter index within the model file
 !   nn_ooo_freq  specifies number of time steps between read operations
-&namoff
+&namooo
    ooo_files = "foo.nc" "foo.nc"
    nn_ooo_idx = 1 2
@@ -915 +915 @@
 at different indices can be combined at a particular frequency in time to 
 generate a pseudo model evolution. As long as all that is needed is a single
-model counterpart at a regular interval then namoff is all that needs to
+model counterpart at a regular interval then namooo is all that needs to
 be edited. However, a far more interesting approach can be taken in which
 multiple forecasts, analyses, persisted analyses and climatologies are
@@ -933 +933 @@
 
 The above namelist performs two basic functions. It organises the fields
-given in \textbf{namoff} into groups so that observations can be matched
+given in \textbf{namooo} into groups so that observations can be matched
 up multiple times. It also controls the metadata and the output variable
 of the class 4 file when a write routine is called.
@@ -1044 +1044 @@
 
 In terms of files and indices of fields inside each file the class 4 approach
-makes use of the \textbf{namoff} namelist. If our fields are in separate files
+makes use of the \textbf{namooo} namelist. If our fields are in separate files
 with a single field per file our example inputs will be specified.
 
@@ -1062 +1062 @@
 \begin{verbatim}
 !----------------------------------------------------------------------
-!       namoff Offline obs_oper namelist
+!       namooo Offline obs_oper namelist
 !----------------------------------------------------------------------
 !   ooo_files    specifies the files containing the model counterpart
 !   nn_ooo_idx   specifies the time_counter index within the model file
 !   nn_ooo_freq  specifies number of time steps between read operations
-&namoff
+&namooo
    ooo_files = "F.1.nc" "F.2.nc" "F.3.nc" "P.1.nc" "P.2.nc" "P.3.nc" "A.1.nc"
    nn_ooo_idx = 1 1 1 1 1 1 1

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/NEMO/OOO_SRC/ooo.nml

@@ -1 +1 @@
 
 !----------------------------------------------------------------------
-!       namoff Offline obs_oper namelist
+!       namooo Offline obs_oper namelist
 !----------------------------------------------------------------------
 !   ooo_files     specifies the files containing the model counterpart
 !   nn_ooo_idx    specifies the index within the model file
 !   nn_ooo_freq   specifies the number of timesteps between file reads
-&namoff
+&namooo
    ooo_files = 'fcst.0.nc'
    nn_ooo_idx = 1

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/NEMO/OOO_SRC/ooo_data.F90

@@ -55 +55 @@
 
       ! Standard offline obs_oper information
-      NAMELIST/namoff/ooo_files, nn_ooo_idx, nn_ooo_freq
+      NAMELIST/namooo/ooo_files, nn_ooo_idx, nn_ooo_freq
 
       ! Class 4 file specifiers
@@ -85 +85 @@
 
       ! Standard offline obs_oper settings
-      READ(numnam, namoff)
+      READ(numnam, namooo)
 
       ! Read class 4 output settings
@@ -108 +108 @@
          WRITE(numout,*) 'offline obs_oper : Initialization'
          WRITE(numout,*) '~~~~~~~~~~~~~~~~~'
-         WRITE(numout,*) '   Namelist namoff : set offline obs_oper parameters' 
+         WRITE(numout,*) '   Namelist namooo : set offline obs_oper parameters' 
          DO jf = 1, n_files
             WRITE(numout,'(1X,2A)') '   Input forecast file name          forecastfile = ', &

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/locator.py

@@ -7 +7 @@
     >>> namobs = observations(date, types=["profbfiles"])
 
-    >>> namoff, namcl4 = forecasts(date, types=["forecast", "persistence"], lead_times=[12, 36, 60])
+    >>> namooo, namcl4 = forecasts(date, types=["forecast", "persistence"], lead_times=[12, 36, 60])
 """
 
@@ -86 +86 @@
     :param lead_times: A list of lead_times to search for
 
-    :returns: tuple of namelist data, (namoff, namcl4)
+    :returns: tuple of namelist data, (namooo, namcl4)
     """
-    namoff = {}
+    namooo = {}
     namcl4 = {}
     if types is None: types = []
@@ -115 +115 @@
         cl4_vars += len(files) * [type]
 
-    # Namoff
-    namoff["ooo_files"] = ooo_files
-    namoff["nn_ooo_idx"] = nn_ooo_idx
+    # Namoo
+    namooo["ooo_files"] = ooo_files
+    namooo["nn_ooo_idx"] = nn_ooo_idx
 
     # Namcl4
@@ -123 +123 @@
     namcl4["cl4_fcst_idx"] = cl4_fcst_idx
 
-    return namoff, namcl4
+    return namooo, namcl4
 
 def field(date, type=None, lead_time=None):

branches/2013/dev_r3987_UKMO4_OBS/NEMOGCM/TOOLS/OBSTOOLS/OOO/ooo/ooo.py

@@ -43 +43 @@
     types = args.forecast_types
     lead_times = args.lead_times
-    namoff, namcl4 = locator.forecasts(date=date,
+    namooo, namcl4 = locator.forecasts(date=date,
                                        types=types,
                                        lead_times=lead_times)
@@ -51 +51 @@
     sublists = nml.namelists(text)
 
-    # namoff
-    if "namoff" not in sublists:
+    # namooo
+    if "namooo" not in sublists:
         # Attach boilerplate
-        text += nml.new("namoff")
-    text = nml.update("namoff", text, data=namoff)
+        text += nml.new("namooo")
+    text = nml.update("namooo", text, data=namooo)
 
     # namcl4
@@ -68 +68 @@
     namcl4["cl4_sys"] = "FOAM"
     namcl4["cl4_cfg"] = "orca025"
-    namcl4["cl4_vn"] = "1.0"
+    namcl4["cl4_vn"] = "'1.0'"
     namcl4["cl4_prefix"] = "class4"
     namcl4["cl4_contact"] = "example@example.com"