Difference between revisions of "I4DVAR Tutorial"

From WikiROMS
Jump to navigationJump to search
Line 1: Line 1:
<div class="title">Incremental, Strong Constraint, 4-DVar (I4DVAR) Data Assimilation</div>
<div class="title">Incremental, Strong Constraint, 4-DVar (I4DVAR) Data Assimilation</div>
The <span class="forestGreen">I4DVAR</span> directory  includes various files to run the incremental, strong constraint,  4-Dimensional Variational ('''4D-Var''') data assimilation algorithm in the California Current System, 1/3&deg; resolution, application ('''WC13''').
The <span class="twilightBlue">I4DVAR</span> directory  includes various files to run the incremental, strong constraint,  4-Dimensional Variational ('''4D-Var''') data assimilation algorithm in the California Current System, 1/3&deg; resolution, application ('''WC13''').


{{warning}}This page is under construction{{warning}}
{{warning}}This page is under construction{{warning}}
Line 9: Line 9:


<div style="clear: both"></div>
<div style="clear: both"></div>


==Important CPP Options==
==Important CPP Options==
<div class="box">  IS4DVAR                I4D-Var driver<br />  WC13                    Application CPP option</div>
<div class="box">  [[IS4DVAR]]                 I4D-Var driver<br />  [[WC13]]                   Application CPP option</div>


==Input NetCDF Files==
==Input NetCDF Files==
<div class="box">                      Grid File:  ../Data/wc13_grd.nc<br />          Nonlinear Initial File:  wc13_ini.nc<br />                Forcing File 01:  ../Data/coamps_wc13_lwrad_down.nc<br />                Forcing File 02:  ../Data/coamps_wc13_Pair.nc<br />                Forcing File 03:  ../Data/coamps_wc13_Qair.nc<br />                Forcing File 04:  ../Data/coamps_wc13_rain.nc<br />                Forcing File 05:  ../Data/coamps_wc13_swrad.nc<br />                Forcing File 06:  ../Data/coamps_wc13_Tair.nc<br />                Forcing File 07:  ../Data/coamps_wc13_wind.nc<br />                  Boundary File:  ../Data/wc13_ecco_bry.nc<br /><br />    Initial Conditions STD File:  ../Data/wc13_std_i.nc<br />    Boundary Conditions STD File:  ../Data/wc13_std_b.nc<br />        Surface Forcing STD File:  ../Data/wc13_std_f.nc<br />    Initial Conditions Norm File:  ../Data/wc13_nrm_i.nc<br />  Boundary Conditions Norm File:  ../Data/wc13_nrm_b.nc<br />      Surface Forcing Norm File:  ../Data/wc13_nrm_f.nc<br/>              Observations File:  wc13_obs.nc</div>
<div class="box">                      <span class="twilightBlue">Grid File:</span> ../Data/wc13_grd.nc<br />          <span class="twilightBlue">Nonlinear Initial File:</span> wc13_ini.nc<br />                <span class="twilightBlue">Forcing File 01:</span> ../Data/coamps_wc13_lwrad_down.nc<br />                <span class="twilightBlue">Forcing File 02:</span> ../Data/coamps_wc13_Pair.nc<br />                <span class="twilightBlue">Forcing File 03:</span> ../Data/coamps_wc13_Qair.nc<br />                <span class="twilightBlue">Forcing File 04:</span> ../Data/coamps_wc13_rain.nc<br />                <span class="twilightBlue">Forcing File 05:</span> ../Data/coamps_wc13_swrad.nc<br />                <span class="twilightBlue">Forcing File 06:</span> ../Data/coamps_wc13_Tair.nc<br />                <span class="twilightBlue">Forcing File 07:</span> ../Data/coamps_wc13_wind.nc<br />                  <span class="twilightBlue">Boundary File:</span> ../Data/wc13_ecco_bry.nc<br /><br />    <span class="twilightBlue">Initial Conditions STD File:</span> ../Data/wc13_std_i.nc<br />    <span class="twilightBlue">Boundary Conditions STD File:</span> ../Data/wc13_std_b.nc<br />        <span class="twilightBlue">Surface Forcing STD File:</span> ../Data/wc13_std_f.nc<br />    <span class="twilightBlue">Initial Conditions Norm File:</span> ../Data/wc13_nrm_i.nc<br />  <span class="twilightBlue">Boundary Conditions Norm File:</span> ../Data/wc13_nrm_b.nc<br />      <span class="twilightBlue">Surface Forcing Norm File:</span> ../Data/wc13_nrm_f.nc<br />              <span class="twilightBlue">Observations File:</span> wc13_obs.nc</div>
 
==Various Scripts and Include Files==
==Various Scripts and Include Files==
<div class="box">  build.bash         bash shell script to compile application<br />  build.sh           csh Unix script to compile application<br />  job_i4dvar.sh       job configuration script<br />  ocean_wc13.in       ROMS standard input script for WC13<br />  s4dvar.in           4D-Var standard input script template<br />  wc13.h             WC13 header with CPP options</div>
<div class="box">  [[build_Script|build.bash]]            bash shell script to compile application<br />  [[build_Script|build.sh]]              csh Unix script to compile application<br />  [[job_i4dvar|job_i4dvar.sh]]        job configuration script<br />  <span class="twilightBlue">ocean_wc13.in</span>        ROMS standard input script for WC13<br />  [[s4dvar.in]]            4D-Var standard input script template<br />  <span class="twilightBlue">wc13.h</span>                WC13 header with CPP options</div>


==Instructions==
==Instructions==
To run this application you need to take the following steps:
To run this application you need to take the following steps:


#Customize your preferred <span class="red">build</span> script and provide the appropriate values for:
#Customize your preferred [[build_Script|build script]] and provide the appropriate values for:
#*Root directory, MY_ROOT_DIR
#*Root directory, MY_ROOT_DIR
#*ROMS source code, MY_ROMS_SRC
#*ROMS source code, MY_ROMS_SRC
Line 28: Line 28:
#*MPI flags, USE_MPI and USE_MPIF90
#*MPI flags, USE_MPI and USE_MPIF90
#*Path of MPI, NetCDF, and ARPACK libraries according to the compiler. Notice that you need to provide the correct places of these libraries for your computer. If you want to ignore this section, comment out the assignment for the variable USE_MY_LIBS.
#*Path of MPI, NetCDF, and ARPACK libraries according to the compiler. Notice that you need to provide the correct places of these libraries for your computer. If you want to ignore this section, comment out the assignment for the variable USE_MY_LIBS.
#Notice that the most important CPP option for this application is specified in the <span class="red">build</span> script instead of <span class="forestGreen">wc13.h</span>:<div class="box">setenv MY_CPP_FLAGS "-DIS4DVAR"</div>This is to allow flexibility with different CPP options.<br /><br />For this to work, however, any '''#undef''' directives MUST be avoided in the header file <span class="forestGreen">wc13.h</span> since it has precedence during C-preprocessing.
#Notice that the most important CPP option for this application is specified in the [[build_Sript|build script]] instead of <span class="twilightBlue">wc13.h</span>:<div class="box"><span class="twilightBlue">setenv MY_CPP_FLAGS "-DIS4DVAR"</span></div>This is to allow flexibility with different CPP options.<br /><br />For this to work, however, any '''#undef''' directives MUST be avoided in the header file <span class="twilightBlue">wc13.h</span> since it has precedence during C-preprocessing.
#You MUST use the <span class="red">build</span> script to compile.
#You MUST use the [[build_Script|build script]] to compile.
#Customize the ROMS input script <span class="forestGreen">ocean_wc13.in</span> and specify the appropriate values for the distributed-memory partition. It is set by default to:<div class="box">NtileI == 2                              ! I-direction partition<br />NtileJ == 2                              ! J-direction partition</div>Notice that the adjoint-based algorithms can only be run in parallel using MPI. This is because of the way that the adjoint model is constructed.
#Customize the ROMS input script <span class="twilightBlue">ocean_wc13.in</span> and specify the appropriate values for the distributed-memory partition. It is set by default to:<div class="box">[[Variables#NtileI|NtileI]] == 2                              ! I-direction partition<br />[[Variables#NtileJ|NtileJ]] == 2                              ! J-direction partition</div>Notice that the adjoint-based algorithms can only be run in parallel using MPI. This is because of the way that the adjoint model is constructed.
#Customize the configuration script <span class="red">job_i4dvar.sh</span> and provide the appropriate place for the "substitute" Perl script:<div class="box">set SUBSTITUTE=${ROMS_ROOT}/ROMS/Bin/substitute</div>This script is distributed with ROMS and it is found in the ROMS/Bin sub-directory. Alternatively, you can define ROMS_ROOT environmental variable in your .cshrc login script. For example, I have:<div class="box">setenv ROMS_ROOT /home/arango/ocean/toms/repository/trunk</div>
#Customize the configuration script [[job_i4dvar|job_i4dvar.sh]] and provide the appropriate place for the "substitute" Perl script:<div class="box"><span class="twilightBlue">set SUBSTITUTE=${ROMS_ROOT}/ROMS/Bin/substitute</span></div>This script is distributed with ROMS and it is found in the ROMS/Bin sub-directory. Alternatively, you can define ROMS_ROOT environmental variable in your .cshrc login script. For example, I have:<div class="box"><span class="twilightBlue">setenv ROMS_ROOT /home/arango/ocean/toms/repository/trunk</span></div>
#Execute the configuration <span class="red">job_i4dvar.sh</span> '''BEFORE''' running the model. It copies the required files and creates <span class="forestGreen">i4dvar.in</span> input script from template <span class="forestGreen">s4dvar.in</span>.
#Execute the configuration [[job_i4dvar|job_i4dvar.sh]] '''BEFORE''' running the model. It copies the required files and creates <span class="twilightBlue">r4dvar.in</span> input script from template <span class="twilightBlue">s4dvar.in</span>. This has to be done '''EVERY TIME''' that you run this application. We need a clean and fresh copy of the initial conditions and observation files since they are modified by ROMS during execution.
#Run ROMS with data assimilation:<div class="box">mpirun -np 4 oceanM ocean_wc13.in > & log &</div>
#Run ROMS with data assimilation:<div class="box"><span class="red">mpirun -np 4 oceanM ocean_wc13.in > & log &</span></div>


==References==
==References==

Revision as of 20:10, 28 June 2010

Incremental, Strong Constraint, 4-DVar (I4DVAR) Data Assimilation

The I4DVAR directory includes various files to run the incremental, strong constraint, 4-Dimensional Variational (4D-Var) data assimilation algorithm in the California Current System, 1/3° resolution, application (WC13).

WarningThis page is under constructionWarning



Important CPP Options

IS4DVAR I4D-Var driver
WC13 Application CPP option

Input NetCDF Files

Grid File: ../Data/wc13_grd.nc
Nonlinear Initial File: wc13_ini.nc
Forcing File 01: ../Data/coamps_wc13_lwrad_down.nc
Forcing File 02: ../Data/coamps_wc13_Pair.nc
Forcing File 03: ../Data/coamps_wc13_Qair.nc
Forcing File 04: ../Data/coamps_wc13_rain.nc
Forcing File 05: ../Data/coamps_wc13_swrad.nc
Forcing File 06: ../Data/coamps_wc13_Tair.nc
Forcing File 07: ../Data/coamps_wc13_wind.nc
Boundary File: ../Data/wc13_ecco_bry.nc

Initial Conditions STD File: ../Data/wc13_std_i.nc
Boundary Conditions STD File: ../Data/wc13_std_b.nc
Surface Forcing STD File: ../Data/wc13_std_f.nc
Initial Conditions Norm File: ../Data/wc13_nrm_i.nc
Boundary Conditions Norm File: ../Data/wc13_nrm_b.nc
Surface Forcing Norm File: ../Data/wc13_nrm_f.nc
Observations File: wc13_obs.nc

Various Scripts and Include Files

build.bash bash shell script to compile application
build.sh csh Unix script to compile application
job_i4dvar.sh job configuration script
ocean_wc13.in ROMS standard input script for WC13
s4dvar.in 4D-Var standard input script template
wc13.h WC13 header with CPP options

Instructions

To run this application you need to take the following steps:

  1. Customize your preferred build script and provide the appropriate values for:
    • Root directory, MY_ROOT_DIR
    • ROMS source code, MY_ROMS_SRC
    • Fortran compiler, FORT
    • MPI flags, USE_MPI and USE_MPIF90
    • Path of MPI, NetCDF, and ARPACK libraries according to the compiler. Notice that you need to provide the correct places of these libraries for your computer. If you want to ignore this section, comment out the assignment for the variable USE_MY_LIBS.
  2. Notice that the most important CPP option for this application is specified in the build script instead of wc13.h:
    setenv MY_CPP_FLAGS "-DIS4DVAR"
    This is to allow flexibility with different CPP options.

    For this to work, however, any #undef directives MUST be avoided in the header file wc13.h since it has precedence during C-preprocessing.
  3. You MUST use the build script to compile.
  4. Customize the ROMS input script ocean_wc13.in and specify the appropriate values for the distributed-memory partition. It is set by default to:
    NtileI == 2  ! I-direction partition
    NtileJ == 2  ! J-direction partition
    Notice that the adjoint-based algorithms can only be run in parallel using MPI. This is because of the way that the adjoint model is constructed.
  5. Customize the configuration script job_i4dvar.sh and provide the appropriate place for the "substitute" Perl script:
    set SUBSTITUTE=${ROMS_ROOT}/ROMS/Bin/substitute
    This script is distributed with ROMS and it is found in the ROMS/Bin sub-directory. Alternatively, you can define ROMS_ROOT environmental variable in your .cshrc login script. For example, I have:
    setenv ROMS_ROOT /home/arango/ocean/toms/repository/trunk
  6. Execute the configuration job_i4dvar.sh BEFORE running the model. It copies the required files and creates r4dvar.in input script from template s4dvar.in. This has to be done EVERY TIME that you run this application. We need a clean and fresh copy of the initial conditions and observation files since they are modified by ROMS during execution.
  7. Run ROMS with data assimilation:
    mpirun -np 4 oceanM ocean_wc13.in > & log &

References

Moore, A.M., H.G. Arango, G. Broquet, B.S. Powell, J. Zavala-Garay, and A.T. Weaver, 2010: The Regional Ocean Modeling System (ROMS) 4-dimensional variational data assimilation systems, Part I: System overview, Ocean Modelling, draft.


Moore, A.M., H.G. Arango, and G. Broquet, C. Edwards, M. Veneziani, B.S. Powell, D. Foley, J. Doyle, D. Costa, and P. Robinson, 2010: The Regional Ocean Modeling System (ROMS) 4-dimensional variational data assimilation systems, Part II: Performance and application to the California Current System, Ocean Modelling, Draft.


Moore, A.M., H.G. Arango, and G. Broquet, C. Edwards, M. Veneziani, B.S. Powell, D. Foley, J. Doyle, D. Costa, and P. Robinson, 2010: The Regional Ocean Modeling System (ROMS) 4-dimensional variational data assimilation systems, Part III: Observation Impact and Observation Sensitivity in the California Current System, Ocean Modelling, Draft.