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
                0005 ### Overview:
                0006 This experiment is derived from `tutorial_global_oce_latlon` (see also
                0007 `global_ocean.90x40x15`) with surface forcing provided by specific pkgs, either
                0008 `pkg/ebm` or `pkg/exf`, instead of relying on the main model surface forcing capability.
                0009 It contains 3 forward set-up, all using the same executable built from `code`
                0010 config but with specific input files from `input/` (primary test) and,
                0011 as secondary tests, from `input.w_exf\` and `input.yearly/`.
                0012 An adjoint set-up configuration for TAF AD compiler, is also provided as an
                0013 example with simple control (initial Temperature, `xx_theta`).
                0014
                0015 The **primary** forward test, using input files from `input/` dir, relies on Energy-Balance Model
                0016 package (`pkg/ebm`) to compute oceanic surface forcing.<br>
                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 The two **secondary** tests, using input files from `input.w_exf\` and `input.yearly/`,
                0022 use prescribed monthly-mean air-sea surface fluxes from `pkg/exf`.<br>
                0023 **Note:**
                0024 1.  these 2 set-up have been moved (in PR #830) from `verification/global_with_exf/`
                0025     where a "README" still provides some details related to `pkg/exf` specific
                0026     features used here.
                0027 2.  the ability, using `pkg/exf`, to compute surface fluxes from near surface
                0028     atmospheric state and downward radiation as shown, e.g., in experiment
                0029     `global_ocean.cs32x15` (secondary test `input.seaice` or `input.icedyn` or `input.in_p`)
                0030     is not used here (`#undef ALLOW_BULKFORMULAE`).
                0031
                0032 ### Instructions for Forward tests:
                0033 Configure and compile the code:
                0034 ```
                0035   cd build
                0036   ../../../tools/genmake2 -mods ../code [-of my_platform_optionFile]
                0037  [make Clean]
                0038   make depend
                0039   make
                0040   cd ..
                0041 ```
                0042
                0043 To run primary test:
                0044 ```
                0045   cd run
                0046   ln -s ../input/* .
                0047   ../build/mitgcmuv > output.txt
                0048   cd ..
                0049 ```
                0050
                0051 There is comparison output in the directory:
                0052   `results/output.txt`
                0053
                0054 To run any of secondary `$st` test (`$st` in: `w_exf`, `yearly`):
                0055 ```
                0056   cd run
                0057   rm *
                0058   ln -s ../input.$st/* .
                0059   ln -s ../input/* .
                0060   ./prepare_run
                0061   ../build/mitgcmuv > output.txt
                0062 ```
                0063
                0064 There is comparison output in the directory:
                0065   `results/output.$st.txt`
                0066
                0067 ### Instructions for Adjoint tests:
                0068 Note: This requires access to a TAF license.<br>
                0069 Configure and compile the code:
                0070 ```
                0071   cd build
                0072   ../../../tools/genmake2 -mods ../code_ad [-of my_platform_optionFile]
                0073  [make Clean]
                0074   make depend
                0075   make adall
                0076   cd ..
                0077 ```
                0078
                0079 To run:
                0080 ```
                0081   cd run
                0082   ln -s ../input_ad/* .
                0083   ../input_ad/prepare_run
                0084   ../build/mitgcmuv_ad > output_adm.txt
                0085   cd ..
                0086 ```
                0087
                0088 There is comparison output in the directory:
                0089   `results/output_adm.txt`