source: NEMO/branches/2020/dev_r12565_VALID-11_clevy_OASIS_TESTCASE/tests/CPL_OASIS/README.md @ 12663

Last change on this file since 12663 was 12663, checked in by clevy, 8 months ago

Add CPL_OASIS test case, see #2379

File size: 3.9 KB
Line 
1# Coupling with OASIS test case
2The CPL_OASIS test case allows to set up and check a basic coupling of NEMOto a simple TOYATM fake tmposhere through the OASIS coupler. A very limited number of fields are exchanged between NEMO and the TOYATM. The tests checks that the fields are indeed exchanged through OASIS and that the ATSSTSST field of sea surface temparture received by the TOYATM makes sense. If the test is sucessful, it states that the set up of NEMO-OASIS interface in the NEMO SBC module is working fine.
3<br>
4We here provide a description of details of this experiment so as as how to run it and check test is sucessful. This experiment is **created and tested** for NEMO ** revision 12573 (to be replace by NEMO release 4.2 by end 2020)**.
5
6## Objectives
7This test case enables the OASIS interface in NEMO (in the OCE/SBC module). A few fields are sent and received by NEMO and by TOYATM (the simplified "atmosphere"). The success of this test (see below ** Verification**) indicates that
8* the OASIS interface in NEMO is functionnal (some fields are sent and received)
9* The sea surface temperature received by the TOYATM makes sense
10
11This test case can be seen as a template to set up a coupling between NEMO and an atmospheric model through OASIS.
12
13## Detailed description
14
15This test case is a set up of NEMO (dynamics, sea-ice and biogeochemistry) on a global 2° grid (as in ithe ORCA2_ICE_PISCES reference configuration), except NEMO is here coupled to a "toyatm" through OASIS.
16
17NEMO is running 160 time-steps (10 days). The coupling is done at each timestep (nn_fsbc=1 in namelist_cfg). The fields exchanged with the toyatm are defined in the &namsbc_cpl namelist in namelist_cfg file.
18
19
20This test case requires:
21* NEMO (no mofication of source code, from rev 12573 or higher (e.g. compatible with NEMO reease 4.2
22* OASIS (need to be downloaded and compiled, with correct paths set in your arch file for NEMO
23* TOYATM (the simple toy in place of an atmospheric model) (located in NEMO/tools directory, need to created executable using tools/maketools command)
24
25This tests/CPL_OASIS directory contains all the need files:
26* cpp_CPL_OASIS.fcm defining the active cpp keys for NEMO
27* EXPREF directory containing all the input files: namelists, xml files, a template job tu run the test case, and a script to check the results and produce the report
28    * More specifically, the fields exchanged by NEMO through OASIS ae defined in the namelist_cfg input file (see &namsbc_cpl variables)
29
30
31## Building the CPL_OASIS test case
32* Download and compile OASIS
33* Build the NEMO executable for this CPL_OASIS test case. In your local NEMO root directory:
34```
35./makenemo -a CPL_OASIS -n MYCPL_OASIS -m "your arch file"
36```
37This makenemo command will create the test case in cfgs/MYCPL_OASIS
38* Build the TOYATM executable
39```
40cd tools
41./maketools -n TOYATM -m "your arch file"
42```
43
44## Running the test case
45```
46cd tests/MYCPL_OASIS/EXP00
47cp ../../CPL_OASIS/job_run_CPL_TESTCASE .
48Adapt the job_run_CPL_TESTCASE to your target computer and run it
49```
50In this directory the job_run_cpl_testcase contains all the steps to run the testcase. These steps are commented in the file.
51** After adapting the headers for your batch system and the paths for the files **, run this script through the batch system of your target computer.
52
53## Verification and validation of the test case
54The script gen_report.sh located in the CPL_OASIS directory allows to check if the run came to a sucessful ending:
55```
56cd MYCPL_OASIS/EXP00
57cp ../../CPL_OASIS/gen_report.sh .
58./gen_report.sh
59```
60If the report is successful, a final check sould be done by visualising the ATSSTSST_toyatm_01.nc (using ncview or any other visualiser for NETCDF files) and comparing it to the reference ref_ATSSTSST_last_time_step.jpg image in the CPL_OASIS directory: the two visualisations must look alike.
61
62reference ref_ATSSTSST_last_time_step.jpg
63.. image:: ref_ATSSTSST_last_time_step.jpg
64
65
Note: See TracBrowser for help on using the repository browser.