= Basic installations instructions =

== Installation of iLOVECLIM on obelix (LSCE)==
You first need an account on the ipsl forge.


To install iloveclim, open a terminal, go to the chosen directory, and type:

* To get the iLOVECLIM code with svn:[[BR]]
{{{ 
svn co svn+ssh://forge.ipsl.jussieu.fr/ipsl/forge/projets/ludus/svn/trunk iloveclim/.
}}}

* On personal lsce machines:
Create specific config and fconfig files in config to have config.lenomdevotremachine and fconfig.lenomdevotremachine. Copy and modify from Didier, Aurelien or Nathaelle.


-- OLD version (deprecated)

* To load the modules:[[BR]]
{{{ 
module load netcdf
}}}
{{{
module load udunits
}}}

* To install everything:
{{{
./install_ludus.sh 
}}}

and comment medusa in config/make.macros and / or in config/make.macros-omp: [[BR]]
{{{
# MEDUSAINCLUDE→  = -I/include
# MEDUSALIB→      = -L/lib -lmedusa -L/lib/libthdyct/lib -lthdyct
}}}


[[BR]]


-- NEW version: [[BR]]

* To load the modules:[[BR]]
{{{ 
module purge

module load intel-fcomp/2020 netcdf/4
}}}

* To install everything:
either without extended components
{{{
cd iloveclim
./New_install_ludus.sh
}}}

or with extended components (grisli...)

 o check out of additional modules, ex for Grisli :svn co svn+ssh://forge.ipsl.fr/ipsl/forge/projets/grisli/svn/branches/iLoveclim Mon_repertoire_Grisli

 o specification of the paths for the extended components in the directory config/*.paths files [[BR]]
ex for Grisli: /home/clim01/aquiquet/GRISLI/GRISLI_iLOVECLIM

 o then [[BR]]
{{{
./New_install_ludus.sh -E
}}}
[[BR]]

iloveclim is now ready to run.[[BR]]



[[BR]]


== Running iLOVECLIM ==

Test : you can then start the test run, by default it runs for 1 year. It will copy all the files in the wkdir directory, compile and run the simulation.
{{{
./bin/run-iloveclim
}}}

If everything is ok it should have run. 

    To start a different run interactively on obelix, with a simulation called LH which lasts 500 years and writes restart files every 250 years, starting from the default initial conditions:
{{{
./bin/run-iloveclim -l LH -n 500 -r 250
}}}


To keep the simulation running even if the terminal is closed, and redirects the terminal outputs to a file:
{{{
nohup ./bin/run-iloveclim -l LH -n 500 -r 250 > run_LH &
}}}

    To get the help and see more options:
{{{
./bin/run-iloveclim -h
}}}


Note: old version:
{{{
./bin/loveclim-new-run
}}}

== OpenMP ==

As of version 758, there is a possibility to run with OpenMP activated. Just use the "-p" switch in the call e.g.: 
{{{
./binloveclim-new-run -l LH -n 500 -r 250 -p
}}}
this will by default use all cores available on the given machine. [[BR]]

The expected performance increase is of about 40-50% on 4 cores, slightly more with carbon cycle activated, at time of writing (2017-11-30). [[BR]]
An example of the comparative performance is displayed below:

[[Image(Screenshot_2017-12-13_15-40-33.png)]]