Changeset 4344 for BOL/Replay/Readme

Timestamp:

Nov 10, 2022, 2:09:18 PM (2 years ago)

Author:

fhourdin

Message:

Documentation

File:

• BOL/Replay/Readme (modified) (2 diffs)

BOL/Replay/Readme

@@ +1 @@
+---------------------------------------------------------------------------
+
                *****  replay tools  ***********
 
 Developed by F. Hourdin, 2022, frederic.hourdin@lmd.ipsl.fr
 
-The idea is to rerun a unique from the LMDZ physcs package after a first
-simulations.
+---------------------------------------------------------------------------
+
+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 with all the variables of
-the subroutine stored at each time-step.
+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
@@ -16 +24 @@
    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
+
 * 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"
+