README.repro: instructions to reproduce the model experiment from this study

wkoeve@geomar.de, v. 1.0 04.02.24

Instructions to reproduce runs related the data repository:
   https://hdl.handle.net/20.500.12085/f0bf4877-e4f8-499a-b47c-3411348cef89
or its temporary representation (during manuscript review):
   https://b2drop.eudat.eu/s/ZDQgCpnCNGMA99t
   
"Southern Ocean heat burp in a cooling world"  

Currently this data set is shared only for the purpose of the review process of the paper given above. All rights reserved.


- download UVic 2.9 from the official UVic web site (http://terra.seos.uvic.ca/model/)
- configure UVic 2.9 to run on your local mashine in the default mode
   (see UVic web site for details)
- make sure you can compile and run UVic in the default mode; follow the instructions
  provided by the official UVic web site (you may need to make run/mk.ver complient with your system)

For each of the runs to be reproduced

- mkdir a respective run folder (e.g. 'Frenger_et_al_DEFAULT') 
- mkdir a subfolder called 'updates' within the run folder
- copy all files code/*.f, code/*.h and code/*.inc from the respective repro repository folder 
  (e.g. repro/DEFAULT) to that updates folder
- cd to the updates folder
- rename all .f files to .F files, e.g. by means of the perl script rename (rename .f .F *.f )
- cd back to your run folder
- compile the code given your system's needs using 
  repro/misk/mk.repro.in (copied as mk.in to your run folder) and the mk script provided 
  by the official UVic web site (see also repro/misk); check any instruction in 
  repro/misk/mk.repro.in for details (check Version_Directory path!).   
- after compilation, cd to the code sub-folder in your run folder; check that the first line 
  in .f and .h files points to the subfolder updates as the source of the code
- cd back to the runfolder  
- mkdir a subfolder data' inside the run folder
- copy forcing files and restart files (both can be found in the 
  data folder of the repro repository, e.g. repro/DEFAULT/data) to that data folder
- make sure that also the linked files repro/data.100.100.19 are copied (or linked) into your data folder  
- copy control* files from the repository to your run folder
- copy .slr files from repository to your run folder
- adopt command sequence from .nqs or .slr runscript to your run environment; 
  in particular make sure to use correct restart.nc and control.in files, 
  as indicated in that .nqs / .slr runs script
- carry out the respective run

You should have an overall structure like this:

YourVersionDirectory
  |- source   (with the original UVic 2.9 files)
  |- updates  
  |- run      
  |- data.100.100.19
  |- Frenger_etal_DEFAULT (or whatever you name it; one folder per run!)
         |- updates (with code from the repository, .f converted to .F)
         |- code     (where your precompiled code will be found after you compile)
         |- data     (forcing and restart data,from repository)
         mk.in
         control*.in
         *.nqs or *.slr
         ... your output files (tsi, tavg, restart and log files) after the run has completed

Note: The folder 'run' which comes with the original UVic 2.9 code contains the file mk.ver. You may need to configure
this file given your local paths; eventually ask your admin for help, if needed.  
For compiling the code from this paper, make sure to link netcdf libs etc suitable for your system and compiled with your compiler. Folder data.100.100.19 which comes with orig UVic contains forcing data. By default, we you will overwrite
this generic forcing dataset by specific forcing files provided here and stored in the run's local data subfolder.