Changes between Version 6 and Version 7 of Doc/Setup

Timestamp:

09/11/14 15:54:41 (10 years ago)

Author:

snguyen

Comment:

--

Doc/Setup

@@ -530 +530 @@
 Jobs headers for post-processing have to be carefully checked, especially elapsed time limits. They are in libIGCM directory (xxx.job) and are adapted for IPSLCM5A with 1Y for !RebuildFrequency and !PackFrequency. Change time limits if you use larger frequencies.
 
+----
+# Prepare ensembles with ins_job -e #
+
+{{{
+#!html
+<span style="border: solid 1px #000000; padding: 5px; font-weight: bold;"><span style="color: #ff0000">Remark !</span> What follows applies to IPSLCM5_v5. </span>
+}}}
+
+When IPSLCM5_v5 is downloaded with ./model IPSLCM5_v5 it will offer the possibility to launch experiments of the decadal type.
+To prepare an ensemble of simulations copy the config.card and ensemble.card files from the directory:
+{{{
+modipsl/config/IPSLCM5_v5/EXPERIMENTS/IPSLCM5/decadal/
+}}}
+into the directory:
+{{{
+modipsl/config/IPSLCM5_v5
+}}}
+
+Several types of ensemble simulations can be prepared by filling config.card and more importantly ensemble.card.
+
+== Config.card ==
+
+The file config.card is filled as a regular config.card (ins_job without the -e option).
+
+The important lines for the ensemble set up are in the [!UserChoices] section. Make sure that !JobName and !ExperimentName are filled with proper values.[[BR]]
+The variable !CalendarType should be consistent with the simulations from which you are initialising or else the restart file with the proper date may not exist.[[BR]]
+The variables !DateBegin and !DateEnd will be overriden by variables present in ensemble.card.
+{{{
+#D-- UserChoices -
+[UserChoices]
+#============================
+JobName=v3h4testB
+#----- Short Name of Experiment
+ExperimentName=v3h4testB
+#----- DEVT TEST PROD
+SpaceName=DEVT
+LongName="IPSLCM5A CMIP5 DEVT phase decadal example with limited outputs."
+TagName=IPSLCM5A
+#D- Choice of experiment in EXPERIEMENTS directory
+ExpType=IPSLCM5/decadal
+#============================
+#-- leap, noleap, 360d
+CalendarType=noleap
+#-- Experiment dates : Beginning and ending
+#-- "YYYY-MM-DD"
+DateBegin=2013-01-01
+DateEnd=2022-12-31
+#============================
+#-- 1Y, 1M, 5D, 1D Period Length of one trunk of simulation
+PeriodLength=1M
+#============================
+#-- Total Number of Processors (minimum is 2 for a coupled configuration)
+#JobNumProcTot=4
+JobNumProcTot=32
+}}}
+
+A section [Ensemble] should also be present. It contains the information that we want to prepare an ensemble simulation with variable !EnsembleRun set to y and three unset fields to be filled in the config.card of each member after ins_job -e has run.
+{{{
+[Ensemble]
+#D- Ensemble run ? 'y' or 'n'
+#D- If 'y', fill in ensemble.card !!
+EnsembleRun=y
+EnsembleName=
+EnsembleDate=
+EnsembleType=
+}}}
+
+== Ensemble.card ==
+
+There are several sections in ensemble.card:
+[Ens_PARAMETRIC], [Ens_DATE] and [Ens_PERTURB].
+
+The choice of ensemble types is done by setting the variable active to y or n.
+{{{
+[Ens_PERTURB]
+# active=y to use this ensemble type
+active=y
+}}}
+
+We cover here the third section which allows to generate members from an initial condition which is perturbed by different means.[[BR]]
+
+There are two ways to perturb the initial condition:
+ * apply some random white noise of defined amplitude to the temperature field of the coupler component (CPL) restart file
+ * apply some previously generated 3D temperature perturbation map to the temperature field of the ocean component (OCE) restart file
+
+Each method apply only to the relevant type of ensemble generation available inside [Ens_PERTURB] as will be explained later.
+
+Before detailing the different functionalities available in [Ens_PERTURB] let us discuss the NAME variable.[[BR]]
+This variable should be set identical to the !JobName variable, otherwise the script will fail to generate the proper files.
+{{{
+# ensemble name (must be equal to JobName in config.card)
+NAME=v3h4testB
+}}}
+
+=== Periodic start dates ===
+
+For this type of perturbed ensembles the following variables are left empty:
+{{{
+# member list (apply list of pattern to initial state)
+MEMBER_LIST=()
+
+# member list of names corresponding to each member
+MEMBER_NAMESLIST=()
+
+# member pattern global name
+MEMBER_INITFROM=
+
+# member pattern global directory for name
+MEMBER_INITPATH=
+...
+# start dates list
+NONPERIODIC=()
+# length list for non periodic simulation (NOTE: use length above if not fill)
+LENGTH_NONPERIODIC=()
+...
+# Path of Mask file
+MASKPATH=
+}}}
+
+In ensemble.card, it is possible to specify a periodic list of start dates.[[BR]] 
+Restart files will be generated for each member at each date starting from BEGIN_INIT to END_INIT with a periodicity of PERIODICITY.[[BR]]
+The variable MEMBER sets the number of members for each start date.
+
+The following part of ensemble.card sets 10 members from 19900101 to 20000101 every 2 years each lasting 10 years:
+{{{
+# member nb (i.e nb of perturb initial restart for each date)
+MEMBER=10
+...
+# periodic and member list simulations length
+LENGTH=10Y
+# start date of the first ensemble
+BEGIN_INIT=19900101
+# start date of the last ensemble
+END_INIT=20000101
+# timestep between each periodic simulation
+PERIODICITY=2Y
+}}} 
+
+This will produce 10 members starting at the dates : 19900101, 19920101, 19940101, 19960101, 19980101, 20000101. (PERIODICITY can be given in months for shorter periods)
+
+Each time the restart file to be perturbed in order to produce each member is taken from the previous day of the start date : 19893112, 19913112, etc...
+
+The directory in which the start date is retrieved is given by INITPATH and INITFROM.[[BR]]
+To restart from experiment v3h4BTxx in directory /ccc/store/cont003/gen2211/nguyens/IGCM_OUT/IPSLCM5A/PROD/historical fill:
+{{{
+# Restart name
+INITFROM=v3h4BTxx
+# Restart directory
+INITPATH=/ccc/store/cont003/gen2211/nguyens/IGCM_OUT/IPSLCM5A/PROD/historical
+}}} 
+
+The way the perturbed member is generated depends on PERTURB_BIN array.
+The first two elements are the most important. The first one is the executable to be used to produce the members, the second one is the component from which the restart is perturbed.
+
+In the Periodic Case it is only possible to build the members by applying a randomly generated temperature pattern on the restart file of the coupler.
+PERTURB_BIN should look like this:
+{{{
+PERTURB_BIN=(AddNoise, CPL, sstoc, O_SSTSST, 0.1)
+}}}
+The list is interpretted as follows:
+ * the used executable is ''!AddNoise'', 
+ * the component is the coupler (''CPL''), 
+ * the restart file to perturb contains ''sstoc'' in its name, 
+ * the variable to perturb in the restart file is ''O_SSTSST'',
+ * the randomly generated pertubation is in [-.05;+0.05] degrees
+
+For each member (in our example we have ten) a new restart file for the coupler will be generated using the executable addnoise to add some randomly generated temperature perturbation.[[BR]] 
+For the year 1990, the corresponding restart file of member 1 will be stored in 
+{{{
+$WORKDIR/IGCM_IN/v3h4testB190/v3h4testB190A/CPL/Restart/
+}}}
+
+=== Non-Periodic start dates ===
+
+For this type of perturbed ensembles the following variables are left empty:
+{{{
+# member list (apply list of pattern to initial state)
+MEMBER_LIST=()
+
+# member list of names corresponding to each member
+MEMBER_NAMESLIST=()
+
+# member pattern global name
+MEMBER_INITFROM=
+
+# member pattern global directory for name
+MEMBER_INITPATH=
+...
+# start dates list
+NONPERIODIC=()
+# length list for non periodic simulation (NOTE: use length above if not fill)
+LENGTH_NONPERIODIC=()
+...
+# start date of the first ensemble
+BEGIN_INIT=
+# start date of the last ensemble
+END_INIT=
+...
+# Path of Mask file
+MASKPATH=
+}}}
+
+The variable LENGTH must be set to something but is not used, PERIODICITY must be set to NONE:
+{{{
+# periodic and member list simulations length
+LENGTH=10Y
+...
+# timestep between each periodic simulation (NONE for nonperiodic)
+PERIODICITY=NONE
+}}}
+
+To set 10 members for the starting dates 1990 and 1992 for a duration of 10 years, set MEMBER, NONPERIODIC and LENGTH_NONPERIODIC as follows:
+{{{
+# member nb (i.e nb of perturb initial restart for each date)
+MEMBER=10
+...
+# start dates list
+NONPERIODIC=(19900101 19920101)
+# length list for non periodic simulation (NOTE: use length above if not fill)
+LENGTH_NONPERIODIC=(10Y 10Y)
+}}}
+This results in 20 simulations in total.
+
+
+The restart files to be perturbed to produce each member are sought in directory INITFROM which PATH is INITPATH.
+{{{
+# Restart name
+INITFROM=v3h4BT00
+# Restart directory
+INITPATH=/ccc/store/cont003/gen0826/labetoul/dmf_import/IGCM_OUT/IPSLCM5A/PROD/historical
+}}}
+This will result in using restarts from experiment ''v3h4BT00'' located in directory ''/ccc/store/cont003/gen0826/labetoul/dmf_import/IGCM_OUT/IPSLCM5A/PROD/historical''.
+
+The perturbation executable must be ''!AddNoise''.
+{{{
+PERTURB_BIN=(AddNoise, CPL, sstoc, O_SSTSST, 0.1)
+}}}
+
+=== List of members for a single start date ===
+
+For this type of perturbed ensembles the following variables are left empty:
+{{{
+# member nb (i.e nb of perturb initial restart for each date)
+MEMBER=
+# timestep between each periodic simulation (NONE for nonperiodic)
+PERIODICITY=NONE
+# start dates list
+NONPERIODIC=()
+# length list for non periodic simulation (NOTE: use length above if not fill)
+LENGTH_NONPERIODIC=()
+}}}
+It is important to leave PERIODICTY set to NONE and LENGTH_NONPERIODIC as an empty list: the list of member method only works for a single start date and neither with periodic start dates nor with non periodic start dates.
+
+The variables BEGIN_INIT and END_INIT are set to the same date, only BEGIN_INIT will be used to provide the start date of the simulation for each member.
+{{{
+# start date of the first ensemble
+BEGIN_INIT=20560101
+# start date of the last ensemble
+END_INIT=20560101
+}}}
+
+The variable LENGTH is the computation time which is the same for all members.
+{{{
+# periodic and member list simulations length
+LENGTH=10Y
+}}}
+
+MEMBER_NAMESLIST is the list of names given to each member. It gives the names of the subdirectories from which the Job is submitted for each member as well as the subdirectories in which the results are stored for each member. 
+
+MEMBER_LIST is the list of perturbation maps files names prefix to apply to the restart file. It is implied that the files are named ''prefix.nc''.
+
+MEMBER_INITFROM is the directory in which the perturbations maps are stored.
+
+MEMBER_INITPATH is the path to this directory.
+
+{{{
+# member list (apply list of pattern to initial state)
+MEMBER_LIST=(OWN3DT_A, OWN3DT_B, OWN3DT_C, OWN3DT_D)
+
+# member list of names corresponding to each member
+MEMBER_NAMESLIST=(OWN3DTA, OWN3DTB, OWN3DTC, OWN3DTD)
+
+# member pattern global directory name
+MEMBER_INITFROM=OWN3DTpf
+
+# member pattern global directory for name
+MEMBER_INITPATH=/ccc/work/cont003/gen2211/nguyens/PERTU/VECTORS
+}}}
+
+The variables INITFROM and INITPATH are still used to point to the directory where the restart files including the one to be perturbed are available.
+
+{{{
+# Restart name
+INITFROM=piControl2
+
+# Restart directory
+INITPATH=/ccc/store/cont003/dsm/p86caub/dmf_import/IGCM_OUT/IPSLCM5A/PROD/piControl
+}}}
+
+For the member list perturbation type we use the executable AddPertu3DOCE and set PERTURB_BIN this way:
+{{{
+# perturbation type
+PERTURB_BIN=(AddPertu3DOCE, OCE, restart, tn, ORCA2_mesh_mask.nc)
+}}}
+The elements of the list mean:
+ * the executable to be called to generate the perturbation is ''AddPertu3DOCE''
+ * the component is the Ocean (''OCE'')
+ * the restart file to perturb is ''*restart*.nc''
+ * the field to perturb in the restart file is ''tn''
+ * the meshmask file to tell if the gridcell is land or sea is ''ORCA2_mesh_mask.nc''
+
+The path to the mesh mask file is given in MASKPATH.
+{{{
+# Path of Mask file
+MASKPATH=/ccc/cont003/home/gen2211/nguyens/addpertu
+}}}
+
+Once config.card and ensemble.card properly filled the directories containing the jobs to launch the simulations are created by issuing the command:
+{{{
+ins_job -e
+}}}