Ver el código de «OR1proc OR 1proc»

ORCHIDEE's work-flow management for 1 processor.

Climate runs require simulations for long periods of time. Geophysical models require different sources of forcing. Usually one should not and ofently can not prepare boundary conditions for all the period of the run (usually more than 10 years). Instead, models perform long simulations by `chunks' or fractions of the period making use of restart files. For each of these chunks, forcing data has to be prepared. 

One could do this manually waiting until the end of the run. It is much more efficient if a work-flow can be generated in order to concatenated the chunks in an automatic way.

Here is presented a very simple work-flow manager for off-line ORCHIDEE simulations on single processor machines.

= Files & structure =
It is assumed that ORCHIDEE has already been installed into the machine, and user already has downloaded all the required data for the run.  On a main folder called <code>[foldOR1proc]</code> (as example) it is expected to contain:
 * components: with two additional folders
 * * ORtemplate: Folder with an example of ORCHIDEE's  <code>run.def</code>; <code>bin/</code>, folder with the compiled binaries: <code>orchideedriver</code>, <code>orchidee_ol</code>, <code>rebuild</code>
 * * python: Folder with required work-flow python scripts: <code>change_namelist.py</code>
 * * shell: Folder with the work-flow scripts: <code>run_multi-or_1proc.bash</code>,  <code>prepare_forcings.bash</code>; configuration file: <code>or_multi-config.txt</code>; <code>rebuild.bash</code> shell to rebuild ORCHIDEE's output files
 * forcings: Folder with all the anciallary data and meteorological forcings

== or_multi-config.txt ==
This is the main file for the work-flow and the unique one to be modified by the user. It contains the definition of a series of variables. As an example:
<pre>
# scratch
scratch=true

# Period of simulation
period=1990-2010

# config
foldOR1proc=/home/administrador/installOR
components=${foldOR1proc}/components
batsHOME=${components}/shell
pyH=${components}/python
binfolder=${components}/ORtemplate/bin
forcingfolder=${foldOR1proc}/forcings
OUTfolder=/home/administrador/installOR/test_multi-run

# Anciliary data 1 file without year (original name of the files with the ancilliary data [origFilen]@[ORfilen])
filestolink='alb_bg_modisopt_2D_ESA_v2.nc@alb_bg.nc:'
filestolink=${filestolink}'cartepente2d_15min.nc@cartepente2d_15min.nc:'
filestolink=${filestolink}'reftemp.nc@reftemp.nc:routing.nc@routing.nc:'
filestolink=${filestolink}'soil_bulk_and_ph.nc@soil_bulk_and_ph.nc:'
filestolink=${filestolink}'soils_param.nc@soils_param.nc'

# Anciliary data 1 file with year (original name of the files with the ancilliary data [origFilen]@[ORfilen], [YYYY] to be changed by the correspondant year)
filestolinkyr='PFTmap_YYYY.nc@PFTmap.nc:woodharvest_YYYY.nc@woodharvest.nc'

# Anciliary data 3 files with year-1,year,year+1 (original name of the files with the ancilliary data [origFilen]@[ORfilen], [YYYY] to be changed by the correspondant year-1, year, yerar+1)
filestolink3yr='cruncep_halfdeg_YYYY.nc@cruncep_halfdeg_YYYY.nc'

# Atmospheric forcing as [ForcingName]@[HeaderForcingFiles] [assuming ${forcingfolder}/ATMOS/{ForcingName}/{HeaderForcingFiles}_YYYY.nc]
atmos='CRUNCEP@cruncep_halfdeg'

# Additional parameters for run.def as [paramName1]:[values1];...;[paramNameN]:[valuesN] (! for spaces)
addparams=
</pre>

* period: period of simulation providing the initial and the ending year in format <code>[iyear]-[eyear]</code>
* pyBIN: path to the binary of python (2.x version is required)
* OUTfolder: path to the place where the simulation will be performed
* foldOR1proc: path to the main folder ot the work-flow manager
* components: path to the components of the work-flow (no need to be changed)
* shellHOME: path to the shell scripts of the work-flow (no need to be changed)
* pyH: path to the python scripts of the work-flow (no need to be changed)
* binfolder: path to the binaries of the work-flow (no need to be changed)
* forcingfolder: path to the forcings of the work-flow (no need to be changed)
* filestolink: ':' separated list of values for the anciliary data that comes from files without year dependency (in format [origFilen]@[ORfilen]; [origFilen], original name of the file; [ORfilen]: expected name by ORCCHIDEE)
* filestolinkyr: ':' separated list of values for the ancillary data that comes from files with year dependency (in format [origFilen]@[ORfilen]; [origFilen], original name of the file; [ORfilen]: expected name by ORCCHIDEE. Name of the files must contain the string chain 'YYYY' that will be automatically changed)
* filestolink3yr: ':' separated list of values for the ancillary data that comes from files with year dependency (in format [origFilen]@[ORfilen]; [origFilen], original name of the file; [ORfilen]: expected name by ORCCHIDEE. Name of the files must contain the string chain 'YYYY' that will be automatically changed as year-1, year, yerar+1)
* atmos Atmospheric forcing as [ForcingName]@[HeaderForcingFiles] [assuming ${forcingfolder}/ATMOS/{ForcingName}/{HeaderForcingFiles}_YYYY.nc]
* addparams: ';' separated list of additional parameters for <code>run.def</code> as <code>[paramName1]:[values1] (using ! for spaces)

= How to run =
One located at the desired output folder <code>[OUTfolder]</code>:
# copy the file <code>or_multi-config.txt<code>
# link the main work-flow manager script: <code>run_multi-or_1proc.bash</code>
# adapt the content of  <code>or_multi-config.txt<code> to the experiment
# run the work-flow (recommending to run it in background as the example)
<pre>
$ cd [OUTfolder]
$ cp [foldOR1proc]/components/shell/or_multi-config.txt ./
$ ln -s [foldOR1proc]/components/shell/run_multi-or_1proc.bash ./
$ vim or_multi-config.txt 
$ nohup ./run_multi-or_1proc.bash >& run_multi_or_1proc.log &
</pre>

= orout =
Along the experiment the work-flow will create in <code>[OUTfolder]</code> a new directory called <code>orout</code> within which will be antother folder with the output of each year of simulation. Work-flow manager looks for the presence of <code>sechiba_rest_out.nc</code> in <code>orout/[year]</code> in order to determine if such chunk should be run.

Inside the folder user will also find:
* <code>run.def</code>: ORCHIDEE's configuration file used to run the chunk
* <code>used_run.def</code>: ORCHIDEE's full configuration (also with the parameters not set in <code>run.def</code>) file used to run the chunk
* <code>out_orchidee_0000</code>: ORCHIDEE's standard output for the simulation