Commit 40553ee21714593a7fb690ba0894e9e21e8f8370

Authored by Dany Dumont
1 parent 765a18ea
Exists in master and in 1 other branch ontheside

Ajout de README.md

Showing 1 changed file with 49 additions and 0 deletions   Show diff stats
README.md 0 → 100644
... ... @@ -0,0 +1,49 @@
  1 +
  2 +
  3 + ----------------------------------------------------
  4 + Welcome to the Phytoplankton Lagrangian Model 2014!
  5 + ----------------------------------------------------
  6 +
  7 +
  8 +The model has been designed to be very user-friendly, however some modifications
  9 +must be done to fit with your machine.
  10 +So, please read the following steps to correctly start the model.
  11 +
  12 +
  13 + 1) COMPILATION:
  14 +
  15 + -Ensure first that gfortran is installed on your machine.
  16 + -Ensure that the NETCDF FORTRAN libraries are installed on your machine.
  17 + -Change the path for the NETCDF FORTRAN module and libraries in the makefile
  18 +
  19 + -compile the source codes using the command «make». The executable will be
  20 + created in the parent directory.
  21 + - you can also delete all object file and the executable by using the command «make mrproper»
  22 +
  23 + 2) USE THE MODEL
  24 +
  25 + - The model use namelists in nml/ allowing to change some parameter values without recompiling
  26 + the source code
  27 + - outputs will be generated in the directory output/
  28 +
  29 + 3) USE THE MODEL WITH GOTM
  30 +
  31 + - The model can call GOTM to produce a diffusivity profile. If you want to use this feature
  32 + you have to change the value of the parameter «mix_state» in the namelist model_parameter
  33 + - Before doing this, ensure that GOTM is installed on your machine and copy all the GOTM namelists
  34 + you need in the directory gotm/. You should also create a symbolic link of the executable in the
  35 + directory gotm/
  36 +
  37 + 4) USE BATCH MODE
  38 +
  39 + - you can also run the model in batch mode. To do this, you must change the file
  40 + batch_bio_pbs.sh
  41 +
  42 +
  43 + have fun
  44 +
  45 +
  46 + for question, please contact me at baudryjeremy@gmail.com
  47 +
  48 +
  49 +
... ...