Blame view

README.md 1.77 KB
7c07b1cc   Dany Dumont   Other minor changes
1

c6c9dc9a   Dany Dumont   Other minor changes
2
Welcome to Phlag, the Phytoplankton Lagrangian Model! The model has been  
7c07b1cc   Dany Dumont   Other minor changes
3
4
5
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.
c6c9dc9a   Dany Dumont   Other minor changes
6

8a16b803   Dany Dumont   Other minor changes
7
#### 1. Compile the model
40553ee2   Dany Dumont   Ajout de README.md
8

34525fb8   Dany Dumont   Minor changes
9
10
11
12
13
14
15
+ 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
16

8a16b803   Dany Dumont   Other minor changes
17
#### 2. Use the model
40553ee2   Dany Dumont   Ajout de README.md
18

34525fb8   Dany Dumont   Minor changes
19
20
21
+ 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
22

8a16b803   Dany Dumont   Other minor changes
23
#### 3. Use the model with GOTM
40553ee2   Dany Dumont   Ajout de README.md
24

34525fb8   Dany Dumont   Minor changes
25
26
27
28
29
30
+ 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
31

8a16b803   Dany Dumont   Other minor changes
32
#### 4. Use the model in the batch mode
40553ee2   Dany Dumont   Ajout de README.md
33

34525fb8   Dany Dumont   Minor changes
34
35
+ 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
36

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

da1df895   Dany Dumont   Référence à l'art...
39
40
41
42
43
44
45
 If you have questions, please contact me at baudryjeremy@gmail.com

#### 5. References

 Baudry, J., D. Dumont, I.R. Schloss (2018) Turbulent mixing and phytoplankton
 life history: A Lagrangian versus Eulerian model comparison,
 Mar. Ecol. Prog. Ser., 600, 55-70, doi:10.3354/meps12634.
40553ee2   Dany Dumont   Ajout de README.md
46