Blame view

README.md 1.53 KB
40553ee2   Dany Dumont   Ajout de README.md
1

40553ee2   Dany Dumont   Ajout de README.md
2

c6c9dc9a   Dany Dumont   Other minor changes
3
4
5
6
7
8
Welcome to Phlag, the Phytoplankton Lagrangian Model! The model has been  
designed to be very user-friendly, however some modifications must be done to  
fit with your machine. So, please read the following steps to correctly start  
the model.

### 1) COMPILATION
40553ee2   Dany Dumont   Ajout de README.md
9

34525fb8   Dany Dumont   Minor changes
10
11
12
13
14
15
16
+ Ensure first that `gfortran` is installed on your machine. 
+ Ensure that the NETCDF FORTRAN libraries are installed on your machine.
+ Change the path for the NETCDF FORTRAN module and libraries in the makefile.
+ Compile the source codes using the command `make`. The executable will be  
   created in the parent directory.
+ You can also delete all object file and the executable by using the command  
   `make mrproper`.
40553ee2   Dany Dumont   Ajout de README.md
17

c6c9dc9a   Dany Dumont   Other minor changes
18
### 2) USE THE MODEL
40553ee2   Dany Dumont   Ajout de README.md
19

34525fb8   Dany Dumont   Minor changes
20
21
22
+ The model use namelists in `nml/` allowing to change some parameter values  
   without recompiling the source code.
+ outputs will be generated in the directory `output/`.
40553ee2   Dany Dumont   Ajout de README.md
23

c6c9dc9a   Dany Dumont   Other minor changes
24
### 3) USE THE MODEL WITH GOTM
40553ee2   Dany Dumont   Ajout de README.md
25

34525fb8   Dany Dumont   Minor changes
26
27
28
29
30
31
+ The model can call GOTM to produce a diffusivity profile. If you want to use  
   this feature you have to change the value of the parameter `mix_state`  
   in the namelist `model_parameter`.
+ Before doing this, ensure that GOTM is installed on your machine and copy  
   all the GOTM namelists you need in the directory `gotm/`. You should also  
   create a symbolic link of the executable in the directory `gotm/`.
40553ee2   Dany Dumont   Ajout de README.md
32

c6c9dc9a   Dany Dumont   Other minor changes
33
### 4) USE BATCH MODE
40553ee2   Dany Dumont   Ajout de README.md
34

34525fb8   Dany Dumont   Minor changes
35
36
+ You can also run the model in batch mode. To do this, you must change the  
   file `batch_bio_pbs.sh`.
40553ee2   Dany Dumont   Ajout de README.md
37

34525fb8   Dany Dumont   Minor changes
38
 Have fun!
40553ee2   Dany Dumont   Ajout de README.md
39

34525fb8   Dany Dumont   Minor changes
40
 For question, please contact me at mailto:baudryjeremy@gmail.com
40553ee2   Dany Dumont   Ajout de README.md
41