Changeset 4060

Timestamp:

2013-10-12T13:24:10+02:00 (11 years ago)

Author:

vichi

Message:

Update the README file in CONFIG/GYRE_BFM

File:

• branches/2013/dev_r3996_CMCC6_topbc/NEMOGCM/CONFIG/GYRE_BFM/README (modified) (4 diffs)

branches/2013/dev_r3996_CMCC6_topbc/NEMOGCM/CONFIG/GYRE_BFM/README

@@ -5 +5 @@
 INFO HELPDESK: info@bfm-community.eu
 WEB SITE: www.bfm-community.eu
-REVISION DATE: February 2013
+REVISION DATE: October 2013
 
 Please address any technical query to the BFM System Team 
@@ -33 +33 @@
 Compile NEMO with the BFM 
 -----------------------------------------------------------------------
+NEMO-BFM is compiled from the BFM configuration script relying on the
+NEMO FCM compilation environment. This is done to allow BFM users to
+use new configurations in NEMO that are not part of the NEMO
+standard distribution code.
+The BFM configuration shipped with NEMO is GYRE_BFM (see next section)
+
 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)
+and define the variable NEMODIR pointing to the root of NEMO source code
+It is assumed here that you have expanded the bfm in /home/user/bfm
+and the root of this NEMO directory in /home/user/nemo then
+and that you have already adjusted the appropriate ARCHFILE that
+is used for the NEMO compilation with makenemo in ../../ARCH
 
-Go to the $BFMDIR/build/configurations/GYRE_BFM directory and read 
-carefully the README file.
-Altrenatively, execute
-$BFMDIR/build/bfm_config.sh -h
-to get information on how to add 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.
+Execute the following commands:
+>> export BFMDIR=/home/user/bfm
+>> export NEMODIR=/home/user/nemo
+>> cd $BFMDIR/build
+>> ./bfm_config.sh -gcd -p GYRE_BFM
 
-Once the BFM code has been generated the first time, the code can be 
-also rebuilt with the standard NEMO command:
-./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo 
+The script will generate (-g) the BFM code, then launch 
+makenemo for compilation (-c) and create the run directory
+(-d) in $BFMDIR/run.
+
+to get information on how to use the BFM configuration script run
+>> ./bfm_config.sh -h
 
 -----------------------------------------------------------------------
@@ -64 +72 @@
 This is why there are no namelist files found in the standard 
 run directory $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00 
-If a user prefers to work in that directory than she has to
+
+Note for expert users:
+If a user prefers to work in the NEMO directory than she has to
 copy the generated namelists there 
+>> cp $BFMDIR/run/gyre_bfm/* $NEMODIR/NEMOGCM/CONFIG/GYRE_BFM/EXP00
+Once the BFM code has been generated the first time, the code can be 
+also rebuilt with the standard NEMO command:
+>> ./makenemo -n GYRE_BFM -m ARCHFILE -e $BFMDIR/src/nemo 
 
 -----------------------------------------------------------------------
@@ -71 +85 @@
 -----------------------------------------------------------------------
 Other couplings with NEMO are available in $BFMDIR/build/configurations.
+Run the command 
+>> ./bfm_config.sh -P
+to get a list of available presets
 Please refer to the README file in each directory for more information.