source: branches/2012/dev_MERGE_2012/NEMOGCM/CONFIG/GYRE_BFM/README @ 3813

Last change on this file since 3813 was 3813, checked in by vichi, 9 years ago

Updated README file for the BFM coupling

File size: 3.2 KB
Line 
1-----------------------------------------------------------------------
2Coupling with the Biogeochemical Flux Model (BFM)
3-----------------------------------------------------------------------
4Author: M. Vichi, BFM system team and NEMO system team
5INFO HELPDESK: info@bfm-community.eu
6WEB SITE: www.bfm-community.eu
7REVISION DATE: February 2013
8
9Please address any technical query to the BFM System Team
10bfm_st@lists.cmcc.it
11-----------------------------------------------------------------------
12
13-----------------------------------------------------------------------
14What is the BFM?
15-----------------------------------------------------------------------
16The Biogeochemical Flux Model (BFM) is a numerical model for the
17simulation of the dynamics of major biogeochemical properties
18in marine ecosystems.  The BFM is open source software freely available
19under the GNU Public License. The model can be used in standalone mode
20to simulate a 0-D system or coupled with other OGCM.
21The coupling with NEMO is maintained by CMCC as part of the
22NEMO system team activity
23
24-----------------------------------------------------------------------
25How to get the BFM code
26-----------------------------------------------------------------------
27The code can be downloaded from http://www.bfm-community.eu after
28the registration of a new user. Follow the instructions on how to
29install the code. It is recommended to run the STANDALONE test cases
30before using the NEMO-BFM coupled system.
31
32-----------------------------------------------------------------------
33Compile NEMO with the BFM
34-----------------------------------------------------------------------
35Make sure that the BFMDIR variable is defined in your environment
36(ex: export BFMDIR=path/to/bfm)
37Define the variable NEMODIR pointing to the root of NEMO source code
38(ex: export NEMODIR=path/to/nemo)
39
40Go to the $BFMDIR/build/Configurations/GYRE_BFM directory and read
41carefully the README file.
42Altrenatively, execute
43$BFMDIR/build/bfm_config.sh -h
44to get information on how to add the appropriate ARCHFILE that
45is used for the NEMO compilation.
46The script will generate the BFM code and then launch makenemo
47to build the executable in this directory.
48
49Once the BFM code has been generated the first time, the code can be
50rebuilt with the following command:
51./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo
52
53-----------------------------------------------------------------------
54Standard test case
55-----------------------------------------------------------------------
56The distributed standard test case is GYRE_BFM, a version of GYRE
57with a full-blown BFM. It is a demnstration simulation and it is not
58meant to produce any published result. The namelists for the BFM are
59not distributed with NEMO but are generated directly by the BFM, in
60directory $BFMDIR/run/GYRE_BFM. The user can either copy the content
61of $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00 in this directory or the
62other way around. GYRE_BFM runs with analytical input data only.
63
64-----------------------------------------------------------------------
65Other examples
66-----------------------------------------------------------------------
67Other couplings with NEMO are available in $BFMDIR/build/Configurations.
68Please refer to the README file in each directory for more information.
Note: See TracBrowser for help on using the repository browser.