README.md 1.52 KB
Newer Older
Dany Dumont's avatar
Dany Dumont committed
1 2
	
	
Dany Dumont's avatar
Dany Dumont committed
3

Dany Dumont's avatar
Dany Dumont committed
4
Welcome to Phlag, the Phytoplankton Lagrangian Model! The model has been  
Dany Dumont's avatar
Dany Dumont committed
5 6 7
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.
Dany Dumont's avatar
Dany Dumont committed
8

Dany Dumont's avatar
Dany Dumont committed
9
### 1) COMPILATION:
Dany Dumont's avatar
Dany Dumont committed
10

Dany Dumont's avatar
Dany Dumont committed
11 12 13 14 15 16 17
+ 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`.
Dany Dumont's avatar
Dany Dumont committed
18

Dany Dumont's avatar
Dany Dumont committed
19
### 2) USE THE MODEL
Dany Dumont's avatar
Dany Dumont committed
20

Dany Dumont's avatar
Dany Dumont committed
21 22 23
+ 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/`.
Dany Dumont's avatar
Dany Dumont committed
24

Dany Dumont's avatar
Dany Dumont committed
25
### 3) USE THE MODEL WITH GOTM
Dany Dumont's avatar
Dany Dumont committed
26

Dany Dumont's avatar
Dany Dumont committed
27 28 29 30 31 32
+ 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/`.
Dany Dumont's avatar
Dany Dumont committed
33

Dany Dumont's avatar
Dany Dumont committed
34
### 4) USE BATCH MODE
Dany Dumont's avatar
Dany Dumont committed
35

Dany Dumont's avatar
Dany Dumont committed
36 37
+ You can also run the model in batch mode. To do this, you must change the  
   file `batch_bio_pbs.sh`.
Dany Dumont's avatar
Dany Dumont committed
38

Dany Dumont's avatar
Dany Dumont committed
39
 Have fun!
Dany Dumont's avatar
Dany Dumont committed
40

Dany Dumont's avatar
Dany Dumont committed
41
 For question, please contact me at baudryjeremy@gmail.com
Dany Dumont's avatar
Dany Dumont committed
42 43 44