source: NEMO/branches/UKMO/dev_r9950_GO8_package_write/cfgs/GYRE_BFM/README @ 10659

Last change on this file since 10659 was 4230, checked in by cetlod, 8 years ago

dev_LOCEAN_CMCC_INGV_2013 : merge LOCEAN & CMCC_INGV branches, see ticket #1182

File size: 4.1 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: October 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-----------------------------------------------------------------------
35NEMO-BFM is compiled from the BFM configuration script relying on the
36NEMO FCM compilation environment. This is done to allow BFM users to
37use new configurations in NEMO that are not part of the NEMO
38standard distribution code.
39The BFM configuration shipped with NEMO is GYRE_BFM (see next section)
40
41Make sure that the BFMDIR variable is defined in your environment
42and define the variable NEMODIR pointing to the root of NEMO source code
43It is assumed here that you have expanded the bfm in /home/user/bfm
44and the root of this NEMO directory in /home/user/nemo then
45and that you have already adjusted the appropriate ARCHFILE that
46is used for the NEMO compilation with makenemo in ../../ARCH
47
48Execute the following commands:
49>> export BFMDIR=/home/user/bfm
50>> export NEMODIR=/home/user/nemo
51>> cd $BFMDIR/build
52>> ./bfm_config.sh -gcd -p GYRE_BFM
53
54The script will generate (-g) the BFM code, then launch
55makenemo for compilation (-c) and create the run directory
56(-d) in $BFMDIR/run.
57
58to get information on how to use the BFM configuration script run
59>> ./bfm_config.sh -h
60
61-----------------------------------------------------------------------
62Standard test case
63-----------------------------------------------------------------------
64The distributed standard test case is GYRE_BFM, a version of GYRE
65with a full-blown BFM. It is a demnstration simulation and it is not
66meant to produce any published result.
67GYRE_BFM runs with analytical input data only.
68The namelists for the BFM are not distributed with NEMO but are
69generated directly by the BFM, in directory $BFMDIR/run/gyre_bfm.
70The generation of the BFM namelist also copy the required NEMO
71namelist and namelist_top files to this directory.
72This is why there are no namelist files found in the standard
73run directory $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00
74
75Note for expert users:
76If a user prefers to work in the NEMO directory than she has to
77copy the generated namelists there
78>> cp $BFMDIR/run/gyre_bfm/* $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00
79Once the BFM code has been generated the first time, the code can be
80also rebuilt with the standard NEMO command:
81>> ./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo
82
83-----------------------------------------------------------------------
84Other examples
85-----------------------------------------------------------------------
86Other couplings with NEMO are available in $BFMDIR/build/configurations.
87Run the command
88>> ./bfm_config.sh -P
89to get a list of available presets
90Please refer to the README file in each directory for more information.
Note: See TracBrowser for help on using the repository browser.