Changeset 3744 for branches/2012/dev_MERGE_2012/NEMOGCM/CONFIG/GYRE_BFM/README

Timestamp:

2013-01-12T13:59:49+01:00 (11 years ago)

Author:

vichi

Message:

Update of the GYRE_BFM configuration

The BFM namelists have been removed because they are part of
the BFM tree and can be taken from there.
An updated version of the README has been incuded.

File:

• branches/2012/dev_MERGE_2012/NEMOGCM/CONFIG/GYRE_BFM/README (modified) (1 diff)

branches/2012/dev_MERGE_2012/NEMOGCM/CONFIG/GYRE_BFM/README

@@ -1 @@
-To compile with the BFM:
-export BFMDIR=path/to/bfm
-cd ..
-./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo -j 8
+-----------------------------------------------------------------------
+Coupling with the Biogeochemical Flux Model (BFM)
+-----------------------------------------------------------------------
+Author: M. Vichi, BFM system team and NEMO system team
+INFO HELPDESK: info@bfm-community.eu
+WEB SITE: www.bfm-community.eu
+REVISION DATE: January 2013
+
+Please address any technical query to the BFM System Team 
+bfm_st@lists.cmcc.it
+-----------------------------------------------------------------------
+
+-----------------------------------------------------------------------
+What is the BFM?
+-----------------------------------------------------------------------
+The Biogeochemical Flux Model (BFM) is a numerical model for the 
+simulation of the dynamics of major biogeochemical properties 
+in marine ecosystems.  The BFM is open source software freely available 
+under the GNU Public License. The model can be used in standalone mode 
+to simulate a 0-D system or coupled with other OGCM.
+The coupling with NEMO is maintained by CMCC as part of the 
+NEMO system team activity
+
+-----------------------------------------------------------------------
+How to get the BFM code
+-----------------------------------------------------------------------
+The code can be downloaded from http://www.bfm-community.eu after
+the registration of a new user. Follow the instructions on how to 
+install the code. It is recommended to run the STANDALONE test cases 
+before using the NEMO-BFM coupled system.
+
+-----------------------------------------------------------------------
+Compile NEMO with the BFM 
+-----------------------------------------------------------------------
+Make sure that the BFMDIR variable is defined in your environment
+(ex: export BFMDIR=path/to/bfm)
+Define the variable NEMODIR pointing to the root of NEMO source code
+(ex: export NEMODIR=path/to/nemo)
+
+Go to the $BFMDIR/build directory and modify the script
+config_GYRE_BFM.sh
+adding the appropriate ARCHFILE that is used for the NEMO compilation.
+The script will generate the BFM code and then launch makenemo
+to build the executable in this directory.
+
+Once the BFM code has been generated the first time, the code can be 
+rebuilt with the following command:
+./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo 
+
+-----------------------------------------------------------------------
+Standard test case
+-----------------------------------------------------------------------
+The distributed standard test case is GYRE_BFM, a version of GYRE
+with a full-blown BFM. It is a demnstration simulation and it is not
+meant to produce any published result. The namelistsfor the BFM are 
+not distributed with NEMO but are found in the BFM tree, in
+directory $BFMDIR/run/nemo/GYRE_BFM. The user can either copy the content
+of $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00 in this directory or the
+other way around. GYRE_BFM runs with analytical input data only.
+
+-----------------------------------------------------------------------
+Other examples
+-----------------------------------------------------------------------
+Other couplings with NEMO are available in $BFMDIR/run/nemo/.
+Please refer to the README file in each directory for more information.