| 1 | |
| 2 | = Documentation on spin-up job with libIGCM = |
| 3 | |
| 4 | == User documentation == |
| 5 | |
| 6 | This page gives a short documentation on the spin-up job in ORCHIDEE_OL |
| 7 | sources since OOL_1_9_2 version. |
| 8 | |
| 9 | If you just want to run a simple job without spin-up scheme you should copy the entire directory to another name and work inside the new one. For |
| 10 | example for ORCHIDEE_OL : |
| 11 | {{{ |
| 12 | > cp -Rp OOL_SEC_STO MY_OOL_SEC_STO |
| 13 | > cd MY_OOL_SEC_STO |
| 14 | }}} |
| 15 | |
| 16 | |
| 17 | The ORCHIDEE_OL/SPINUP script use other libIGCM scripts in ORCHIDEE_OL. |
| 18 | You should also copy this directory to another name and work inside the new one : |
| 19 | {{{ |
| 20 | > cp -Rp SPINUP MY_SPINUP |
| 21 | > cd MY_SPINUP |
| 22 | }}} |
| 23 | |
| 24 | |
| 25 | Other ORCHIDEE_OL directories may not be modified for the SPINUP to run correctly : |
| 26 | * OOL_SEC for SECHIBA alone runs, |
| 27 | * OOL_SEC_STO for SECHIBA and STOMATE (whole ORCHIDEE) runs, |
| 28 | * TESTSTOMATE for teststomate (STOMATE alone) runs, |
| 29 | * and FORCESOIL for forcesoil (stomate_soilcarbon function in src_stomate) runs. |
| 30 | All thoses will be called "subjob" inside the spinup. They will are copy inside the spinup directory |
| 31 | with differente stage names. Some of their parameters will be changed according to the spinup parameters. |
| 32 | And will be launched with a simple "nohup". |
| 33 | |
| 34 | Then all these directories must be considered by users as skeleton and must be use or change with |
| 35 | care because otherwise, it will break the spinup. |
| 36 | The SPINUP directory itself is a brick of other jobs (see FluxnetValidation page on this site. |
| 37 | |
| 38 | In SPINUP/COMP directory, you will find spinup.card to manage SPINUP with ORCHIDEE in libIGCM scripts environment. |
| 39 | |
| 40 | First, you must consider SPINUP configuration in section [User``Choices] : |
| 41 | * The first two options are |
| 42 | {{{ |
| 43 | #!sh |
| 44 | # |
| 45 | ###-- STOMATE flag |
| 46 | # |
| 47 | ok_stomate=n |
| 48 | # |
| 49 | ###-- CO2 flag |
| 50 | # |
| 51 | ok_co2=n |
| 52 | }}} |
| 53 | and other flags that will change the behaviour of the whole spinup run. |
| 54 | * The second main configuration is the algorithm of the spinup itself : |
| 55 | {{{ |
| 56 | #!sh |
| 57 | # SPINUP configuration : |
| 58 | # ---------------------- |
| 59 | # Initialisation for spin-up : |
| 60 | # orchidee with sechiba alone (!!! if ok_stomate == n !!!) |
| 61 | duree_nostomate=1 |
| 62 | # orchidee with stomate |
| 63 | duree_inistomate=1 |
| 64 | # teststomate (only if duree_nostomate or duree_inistomate > 0) |
| 65 | duree_offlineini=1 |
| 66 | |
| 67 | # Loop configuration for spin-up : |
| 68 | # The whole job is restarted n_iter times |
| 69 | n_iter=10 |
| 70 | # orchidee with sechiba (and stomate if ok_stomate=y below) |
| 71 | duree_sechiba=1 |
| 72 | # teststomate |
| 73 | duree_stomate=1 |
| 74 | # forcesoil |
| 75 | duree_carbonsol=1 |
| 76 | |
| 77 | # Finalization for spin-up : |
| 78 | # all orchidee |
| 79 | duree_final=1 |
| 80 | }}} |
| 81 | Here the first three parameters deal with the initialization, if you don't want to start it from some restart. |
| 82 | After that, you have the main loop on "n_iter" and at the end the finalization of the spinup. [[BR]] |
| 83 | All those parameters (but the n_iter) are number of years. |
| 84 | * Finally, you can change |
| 85 | * The name of the forcing file. You can for example use ${year} variable of libIGCM to build interanual spinup as in : |
| 86 | {{{ |
| 87 | #!sh |
| 88 | [SubJobForcingFile] |
| 89 | # Boundary Files for ORCHIDEE subjobs : |
| 90 | List= (${R_BC}/OOL/${config_UserChoices_TagName}/NCC/ncc_for_${year}.nc, .) |
| 91 | ListNonDel= () |
| 92 | }}} |
| 93 | * Some parameters inside the subjobs. |
| 94 | {{{ |
| 95 | #!sh |
| 96 | [SubJobParams] |
| 97 | # You can specify here any parameters to be modified in run.def for SpinUp Subjobs. |
| 98 | DEBUG_INFO=n |
| 99 | LONGPRINT=n |
| 100 | }}} |
| 101 | * The post-treatment section for SECHIBA and STOMATE runs (Time``Series variables) : |
| 102 | {{{ |
| 103 | #!sh |
| 104 | [SubJobPost] |
| 105 | # |
| 106 | ##-- TimeSeries |
| 107 | # |
| 108 | sechiba_TimeSeriesVars=(lai, maxvegetfrac, vegetfrac, nobiofrac, alb_nir, ..., temp_sol, tsol_max, tsol_min, drainage, CO2FLUX) |
| 109 | # ALMAOUTPUT |
| 110 | #sechiba_TimeSeriesVars = (vegetfrac, maxvegetfrac, nobiofrac, ..., SnowDepth, dis, GPP) |
| 111 | stomate_TimeSeriesVars=(CO2FLUX_MONTHLY, LAI, VEGET, VEGET_MAX, NPP, GPP, ..., CONVFLUX, CFLUX_PROD10, CFLUX_PROD100) |
| 112 | }}} |
| 113 | |
| 114 | |
| 115 | == Directories of spin-up job == |
| 116 | |
| 117 | SPINUP for ORCHIDEE is a set of jobs running SEQUENTIALLY. |
| 118 | |
| 119 | in ORCHIDEE_OL source, you will find squeleton jobs OOL_SEC_STO, FORCESOIL (for example). |
| 120 | And the SPINUP master job. |
| 121 | |
| 122 | Only the spinup master job is launch and re-submit, but it create sub-directories for all spinup steps as in spinup-Quest``Spdir |
| 123 | in attachment. |
| 124 | |
| 125 | You will see subdirs created by the master job. All job restart from the one of the previous step. The output.card |
| 126 | is the output of the master spinup job (see the last one in attachment). |
| 127 | |
| 128 | |
| 129 | As all libIGCM jobs, you will find in config.card the two main variables to qualify the job : [[BR]] |
| 130 | {{{ |
| 131 | JobName=QuestSp |
| 132 | LongName="Spin Up CO2 2degrees for ORCHIDEE. Protocole Quest (years CO2 + VEGET 1860). Harvest + Fire = y" |
| 133 | }}} |
| 134 | |
| 135 | |
| 136 | The date begin gives the beginning of each step that loop from this date with the same duration : |
| 137 | {{{ |
| 138 | DateBegin=1901-01-01 |
| 139 | }}} |
| 140 | |
| 141 | You must know that the End date in this specific config.card is not give in the beginning, but |
| 142 | reflect the number of step programmed for the spinup and IS MODIFIED by spinup.driver, as in : |
| 143 | {{{ |
| 144 | DateEnd= 3750-12-31 |
| 145 | }}} |
| 146 | |
| 147 | And the DMNFS (output storage) directory for this SPINUP contain two parts : |
| 148 | * Quest``Sp main directory that contains all steps (but not the final one) of the SPINUP in SPIN/Output directory. |
| 149 | All those sub-directories are standard libIGCM output directories. |
| 150 | * QuestSpFIN is the last step and is still in IGCM_OUT/Tag``Name/ main directory (as other future jobs will start from this one). |
| 151 | |