verification/global_ocean_ebm/README.md

7fe51dd492 Jean*0001 # Global Ocean Simulation at 4 degree Resolution, Alternative Forcing
                0002 Quasi-global ocean set-up, $`80^\circ`$S -- $`80^\circ`$N, at $`4^\circ`$
                0003 horizontal resolution with 15 vertical levels.
                0004
f1b47febb7 Jean*0005 This experiment has been moved (PR #944) inside `global_oce_latlon`,
                0006 and is now run there as a secondary test (`global_oce_latlon.ebm`) using
                0007 `input.ebm/` and `input_ad.ebm/` for the forward and adjoint test respectively.
                0008
                0009 Original Description:
                0010 =====================
                0011
7fe51dd492 Jean*0012 ### Overview:
                0013 This experiment is derived from `tutorial_global_oce_latlon` (see also
f1b47febb7 Jean*0014 `global_ocean.90x40x15`) and relies on Energy-Balance Model
7fe51dd492 Jean*0015 package (`pkg/ebm`) to compute oceanic surface forcing.<br>
f1b47febb7 Jean*0016
7fe51dd492 Jean*0017 The adjoint test, with customized code in `code_ad` and input files in `input_ad/` dir, provides
                0018 an adjoint set-up of the forward primary tests with some adjoint specific simplifications
                0019 (less compiled pkgs, simpler GM-Redi code, no time-dependent control ...).
                0020
                0021 ### Instructions for Forward tests:
                0022 Configure and compile the code:
                0023 ```
                0024   cd build
                0025   ../../../tools/genmake2 -mods ../code [-of my_platform_optionFile]
                0026  [make Clean]
                0027   make depend
                0028   make
                0029   cd ..
                0030 ```
                0031
                0032 To run primary test:
                0033 ```
                0034   cd run
                0035   ln -s ../input/* .
                0036   ../build/mitgcmuv > output.txt
                0037   cd ..
                0038 ```
                0039
                0040 There is comparison output in the directory:
                0041   `results/output.txt`
                0042
                0043 ### Instructions for Adjoint tests:
                0044 Note: This requires access to a TAF license.<br>
                0045 Configure and compile the code:
                0046 ```
                0047   cd build
                0048   ../../../tools/genmake2 -mods ../code_ad [-of my_platform_optionFile]
                0049  [make Clean]
                0050   make depend
                0051   make adall
                0052   cd ..
                0053 ```
                0054
                0055 To run:
                0056 ```
                0057   cd run
                0058   ln -s ../input_ad/* .
                0059   ../input_ad/prepare_run
                0060   ../build/mitgcmuv_ad > output_adm.txt
                0061   cd ..
                0062 ```
                0063
                0064 There is comparison output in the directory:
                0065   `results/output_adm.txt`