---------------------------------------------------------------------------

               *****  replay tools  ***********

Developed by F. Hourdin, 2022, frederic.hourdin@lmd.ipsl.fr

---------------------------------------------------------------------------

Purpose :
---------

The idea is to rerun a unique subroutine (which could istelf call others) from
the LMDZ physcs package after a first simulations (i.e. routines in
LMDZ/libf/phylmd).
The variables in the interface of the routine are stored in binary files
(dump_ini.bin and dump_param.bin).
The tools also creates automatically an netcdf file phys.nc with all the
variables of the subroutine stored at each time-step.

1D : run lmdz1d.e first and then replay1d.e
   both lmdz1d.F90 and replay1d.F90 are on libf/phylmd/dyn1d
3D : run gcm.e first and then replay3d.e
   both gcm.F90 and replay3d.F90 are on libf/dyn3d
   Available in sequential mode only (no parallel version so far)


Contains :
---------

* replay_equip.sh
  The main script, to be run on the phylmd directory.
  It equips the fortran routine before compilation.
  The main documentation of the replay tools is in this script
  By default, it equips the code for binary output for replay and nc output
    for diangostics.
  The -nconly option can be used to equip other routines with nc output only
  replay_equip.sh -h 
  to see the options

* replay_param.sh
  a first, simpler, but less powerfull version of replay_equip.sh

* replay_clean.sh
  to be run on phylmd to clean all what was added automatically by
  replay_equip.sh

* replay_1D.sh
  A script to run automatically replay tools in SCM mode on
  1D/EXEC/...

It is suggested to add
export PATH=$PATH:~/LMDZ/Replay
(or any other location of the Replay directory on you computer)
so that you can invoke the script from wherever on your computer.


Available through
-----------------
svn checkout https://svn.lmd.jussieu.fr/LMDZ/BOL/Replay
Rm : svn deposit created from FH laptop through :
     svn import ./Replay https://svn.lmd.jussieu.fr/LMDZ/BOL/Replay -m "Import initial des outils Replay"