verification/cpl_aim+ocn/README.md

a99d705983 Jean*0001 Atmosphere-Ocean coupled set-up example "cpl_aim+ocn"
                0002 ================================================================================
                0003 using simplified atmospheric physics (AIM), in realistic configuration (orography
                0004 & continent) with land and seaice component, on cubed-sphere (cs-32) grid.
                0005
                0006 ### Overview:
                0007 Uses "in-house" MITgcm coupler<br>
86f389907b Jean*0008 (`pkg/atm_ocn_coupler`, `pkg/compon_communic`, `pkg/atm_compon_interf`,
                0009 `pkg/ocn_compon_interf`)<br>
                0010 with each component config and customized src code in: `code_cpl`, `code_atm`,
                0011 `code_ocn` ;<br>
                0012 and input parameter files in: `input_cpl`, `input_atm`, `input_ocn`.
a99d705983 Jean*0013
86f389907b Jean*0014 - Atmos set-up and parameter is similar to `aim_5l_cs/` experiment
                0015 - Ocean set-up and parameter is similar to `global_ocean.cs32x15/` experiment
a99d705983 Jean*0016
                0017 Requires the use of MPI; as default, use 1 proc for each component.
                0018
                0019 ### Instructions:
86f389907b Jean*0020 To help getting started with this coupled set-up, the bash script
                0021 [../../tools/run_cpl_test](https://github.com/MITgcm/MITgcm/blob/master/tools/run_cpl_test)
                0022 (a short option summary is displayed when run without argument)
                0023 is provided and detailed instructions follow.
                0024
a99d705983 Jean*0025 To clean everything:
86f389907b Jean*0026
                0027     ../../tools/run_cpl_test 0
a99d705983 Jean*0028
                0029 Configure and compile, e.g., using gfortran optfile:
86f389907b Jean*0030
                0031     ../../tools/run_cpl_test 1 -of ../../tools/build_options/linux_amd64_gfortran
a99d705983 Jean*0032
                0033 To run primary setup, thermodynamic seaice only (no seaice dynamics):
86f389907b Jean*0034
                0035     ../../tools/run_cpl_test 2
                0036     ../../tools/run_cpl_test 3
                0037
a99d705983 Jean*0038 Step 2 above copies input files and directories, step 3 runs the coupled model.
                0039
86f389907b Jean*0040 To run secondary test (with seaice dynamics as part of ocean component), using
                0041 input parameter files in: `input_cpl.icedyn`, `input_atm.icedyn`, `input_ocn.icedyn`:
a99d705983 Jean*0042
86f389907b Jean*0043     ../../tools/run_cpl_test 2 icedyn
                0044     ../../tools/run_cpl_test 3
a99d705983 Jean*0045
86f389907b Jean*0046 Results are written in directories `rank_{0,1,2}`, for coupler, ocean and atmos
                0047 components, respectively.
a99d705983 Jean*0048
86f389907b Jean*0049 There is comparison output corresponding to the primary set-up in the directory:<br>
                0050 `results/atmSTDOUT.0000` & `results/ocnSTDOUT.0000`<br>
                0051 and the secondary test, in the same directory:<br>
                0052 `results/atmSTDOUT.icedyn` & `results/ocnSTDOUT.icedyn`
                0053
                0054 ##### Note:
                0055 To check the results, the monitor output can be compared to the reference (in `results/`)
                0056 using `run_cpl_test`, but this requires the additional comparison script `comp_res` and
                0057 the program `cmpnum.f`. Both can be found in GitHub repository
                0058 [MITgcm-contrib/jmc_scripts](https://github.com/MITgcm-contrib/jmc_scripts),
                0059 see README there. Once in place, step 4 performs the output comparison:<br>
a99d705983 Jean*0060 For primary set-up:
86f389907b Jean*0061
                0062     ../../tools/run_cpl_test 4
                0063
a99d705983 Jean*0064 and for secondary test:
86f389907b Jean*0065
                0066     ../../tools/run_cpl_test 4 icedyn