--- MITgcm_contrib/PRM/README	2005/01/26 15:14:41	1.1
+++ MITgcm_contrib/PRM/README	2012/06/04 18:06:58	1.14
@@ -1 +1,46 @@
-Code customization for MITgcm multi-component super-param runs with ESMF.
+# $Header: /home/ubuntu/mnt/e9_copy/MITgcm_contrib/PRM/README,v 1.14 2012/06/04 18:06:58 jmc Exp $
+# $Name:  $
+
+# Code customization for MITgcm multi-component super-param runs with ESMF.
+# =========================================================================
+#   works with ESMF version 3.0.0
+#   works and has been tested with MITgcm checkpoint63m
+
+# On aces compile on compute machine
+# e.g qsub -I -l walltime=08:00:00 -i nodes=1:ppn=2 -q long
+# Check out latest MITgcm source code into directory MITgcm_HEAD
+cvs co -P -d MITgcm_HEAD MITgcm
+# Add in prm stuff
+cd MITgcm_HEAD/verification
+cvs co -P -d prm MITgcm_contrib/PRM
+
+# Setup makefiles etc... for prm
+cd prm/multi_comp_setup/esmf_test/run
+# Make sure that mpich/compiler e.g. "module load mpich/intel" are set and
+#   MITgcm optfile + ESMF path are set correctly in file "prm_site_config_file"
+do_links
+do_genmake2
+# to generate MITgcm libs using "ieee" or "devel" optfile flags,
+#    type instead: "do_genmake2 -ieee" or "do_genmake2 -devel" respectively.
+
+# Build executables (still in directory prm/multi_comp_setup/esmf_test/run)
+do_make
+# note: options that are used to compile PRM F90 source files are hard-coded in:
+#    prm/build_scripts/makemake.sh through variable F90C_ARGS
+
+# Run stuff (still in directory prm/multi_comp_setup/esmf_test/run)
+mkpgfile
+do_run
+# Tidy up (still in directory prm/multi_comp_setup/esmf_test/run)
+do_clean
+
+#- Note(jmc): directories which are not used (just to keep development version):
+ multi_comp_setup/comp_mitgcm/code_basic/hidden
+ multi_comp_setup/comp_mitgcm/code_fancy
+ multi_comp_setup/comp_mitgcm/build
+ multi_comp_setup/multi_code
+ multi_comp_setup/esmf_test/run/test_redist
+
+#- Note(jmc): dir structure and source-code location: see file
+ multi_comp_setup/doc/contents.txt
+