README.md 1.63 KB
Newer Older
Dany Dumont's avatar
Dany Dumont committed
1 2
	
	
Dany Dumont's avatar
Dany Dumont committed
3 4 5
	----------------------------------------------------
	Welcome to the Phytoplankton Lagrangian Model 2014!
	----------------------------------------------------
Dany Dumont's avatar
Dany Dumont committed
6

Dany Dumont's avatar
Dany Dumont committed
7
 The model has been designed to be very user-friendly, however some modifications
Dany Dumont's avatar
Dany Dumont committed
8 9
 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
10

Dany Dumont's avatar
Dany Dumont committed
11
# 1) COMPILATION:
Dany Dumont's avatar
Dany Dumont committed
12

Dany Dumont's avatar
Dany Dumont committed
13 14 15 16 17 18 19
+ 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
20

Dany Dumont's avatar
Dany Dumont committed
21
# 2) USE THE MODEL
Dany Dumont's avatar
Dany Dumont committed
22

Dany Dumont's avatar
Dany Dumont committed
23 24 25
+ 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
26

Dany Dumont's avatar
Dany Dumont committed
27
# 3) USE THE MODEL WITH GOTM
Dany Dumont's avatar
Dany Dumont committed
28

Dany Dumont's avatar
Dany Dumont committed
29 30 31 32 33 34
+ 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
35

Dany Dumont's avatar
Dany Dumont committed
36
# 4) USE BATCH MODE
Dany Dumont's avatar
Dany Dumont committed
37

Dany Dumont's avatar
Dany Dumont committed
38 39
+ 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
40

Dany Dumont's avatar
Dany Dumont committed
41
 Have fun!
Dany Dumont's avatar
Dany Dumont committed
42

Dany Dumont's avatar
Dany Dumont committed
43
 For question, please contact me at mailto:baudryjeremy@gmail.com
Dany Dumont's avatar
Dany Dumont committed
44 45 46