= Merge-Hydro Branch =

This version will merge the version of ORCHIDEE developed at LMD with the 11-layer hydrological scheme into the latest version of the trunk (1.9.5.2). Based on the differences between the LMD version and those from which it originates (either 1_9 or 1_9_4_1) (see the attachments), several notes have been written in order to prepare the merge. Here below are the links to these notes.

The '''hydrology''' group is : isabelle.gouttevin, jan.polcher, aducharne, aurelien.campoy, matthieu.guimberteau, gerhard.krinner, nathalie.de-noblet, catherine.ottle, pierre.brender, tao.wang, frederique.cheruy, marie-alice.foujols, patricia.cadule.[[BR]]
Everybody with a svn login can(since 12 april 2012) download this branch but only people in the group can commit changes. [[BR]]

== How to download ORCHIDEE Hydrology branch for use in offline configuration ==

 1. Get modipsl
{{{
> svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
}}}

 2. Get the ORCHIDEE TOOLS-box. You will be prompted for username and password. Use personal svn login (firstname.lastname) or old sechiba cvs login. 
{{{
> cd modipsl/util
> svn co svn://forge.ipsl.jussieu.fr/orchidee/trunk/TOOLS
}}}
 3. Get the hydrology version. ''svn_login'' can be your personal svn login or sechiba
{{{
> TOOLS/recup_my_ORCHIDEE svn_login branches/Hydrology
}}}


== How to download ORCHIDEE Hydrology branch for use in coupled LMDZOR configuration ==
 1. Get modipsl
{{{
> svn co http://forge.ipsl.jussieu.fr/igcmg/svn/modipsl/trunk modipsl
}}}

 2. Modifiy in modipsl/util/mod.def to get ORCHIDEE Hydrology sources instead of default. 
{{{
In modipsl/util/mod.def change following line :
#-C- LMDZOR_v4  ORCHIDEE                    orchidee_1_9_5   2  .   modeles
into
#-C- LMDZOR_v4  branches/Hydrology/ORCHIDEE HEAD             15 .  modeles
}}}

 3. Extract configuration LMDZOR_v4 and compile, for more information see [https://forge.ipsl.jussieu.fr/igcmg/wiki/LMDZOR_v4 wiki LMDZOR_v4]
{{{
cd modipsl/util
./model LMDZOR_v4       => you will be asked for passwd for sechiba
./ins_make
cd ../config/LMDZOR_v4
gmake
}}}

 4. Some changes are needed to run this version.
  - Add in PARAM/orchidee.def : 
{{{
SOILCLASS_FILE = soils_param.nc
TOPOGRAPHY_FILE =cartepente2d_15min.nc
}}}
  - Add in orchidee.card, in section [!InitialStateFiles] following line (and add ", \" at line above):
{{{
(${R_INIT}/SRF/${config_UserChoices_TagName}/cartepente2d_15min.nc, .)
}}}
  - NB! For the moment this version bug with default set up using RIVER_ROUTING=y. To have it runnig, change in orchidee.def to RIVER_ROUTING=n.

== Notes to prepare the merge ==

[wiki:Branches/MergeHydro/cwrr_note Note on CWRR]

[wiki:Branches/MergeHydro/evapnu_note Note on evapnu]

[wiki:Branches/MergeHydro/dpu_note Note on dpu]

[wiki:Branches/MergeHydro/flag_couple_note Note on flag couple]

[wiki:Branches/MergeHydro/logz0_note Note on logz0]

[wiki:Branches/MergeHydro/lai_note Note on LAI]

[wiki:Branches/MergeHydro/Soilmap_note Note on Soil Map]

[wiki:Branches/MergeHydro/Interpolation_note Note on Interpolations]

[wiki:Branches/MergeHydro/Martial_notes_on_merge Martial notes for the merge]

== Testing the Merge-Hydro version ==

[wiki:Branches/MergeHydro/Matthieu_notes_on_merge Matthieu Guimberteau: Off-line tests in the Amazon with bug corrections]

Aurélien Campoy (Feb 2012) - test peformed off-line using 50 years of SAFRAN met forcing for the SIRTA site, without routing, without STOMATE : compares reasonably well with the CWRR version of ORCHIDEE before the merge

Jan Polcher (March 2012) - Off-line simulation over Europe using the WATCH forcing data set : simulation performed, to be analyzed

Nicolas Vuichard (March 2012) - off-line tests at FLUXNET sites using STOMATE : ongoing

Fabienne Maignan (Feb-Jun 2012) - global off-line simulation
 * forcing: ERA-Interim regular grid 0.72° 3-hourly
 * computer: LSCE/obelix*
 * 16 procs
 * CWRR + STOMATE + ROUTING
 * segmentation fault SIGSEGV here:
{{{
 Projection arrays for Slope map                      : 
 nbvmax =           16
 We will work with      1000105  points of the fine grid
 Aggregate_2d : Slope map                     
 
 aggregate_2D nbvmax =           16 max used =           16
}}}
 The problem is in ''slowproc_slope'' after the call to ''aggregate_vec'':
{{{
    DO ib = 1, nbpt
      idi=1
      !-
      !- Reinfiltration coefficient due to the slope: Calculation with parameteres maxlope_ro 
      !-
      slopecoef = zero
!@BUG SOURCE      DO WHILE ( sub_area(ib,idi) > zero ) !@END BUG SOURCE 
!@PROPOSED CORRECTION
       DO WHILE ( sub_area(ib,idi) > zero .AND. idi .LE. nbvmax) 
!@END PROPOSED CORRECTION
         ip = sub_index(ib,idi,1)
         jp = sub_index(ib,idi,2)
         !
         slopecoef = slopecoef + MIN(slopemap(ip,jp)/slope_noreinf, un) * sub_area(ib,idi)
         idi = idi +1
      ENDDO
}}}
 ''idi'' may become greater than ''nbvmax'', which causes the segmentation fault. The problem is resolved by the correction proposed in the above code.
 * stop in ''hydrol_soil_infilt'':
{{{
Error in the calculation of infilt tot -4.176114610371373E-008
 k, ji, jst, mc   1.17784270216726        2.16374183793683             2394
           1  0.277241865204730

FATAL ERROR FROM ROUTINE hydrol_soil_infilt
 --> We will STOP after hydrol_soil_infilt.
 -->
 -->

Fatal error from IOIPSL. STOP in ipslerr with code
}}}
 This is caused by slightly negative values in the ERA-Interim precipitations, as already mentionned by Nicolas Vuichard.
 Proposed (and validated) modification in ''intersurf_main_2d'' and ''intersurf_main_1d'':   
{{{
!@ PROPOSED MODIFICATION
    WHERE(zprecip_rain(:) .LT. 0.)
	zprecip_rain(:)=0.		
    ENDWHERE				
!@ END PROPOSED MODIFICATION
    !
    IF (check_INPUTS) THEN
...
}}}

Frédérique Cheruy - global simulation coupled to LMDz : to be done