Heracles 4.3 User's Guide: Difference between revisions
No edit summary |
|||
(5 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
cvs co -r ''TAGNAME'' -d ''DIRECTORY'' GEOSagcm | cvs co -r ''TAGNAME'' -d ''DIRECTORY'' GEOSagcm | ||
where ''TAGNAME'' is the model "tag" (version). A tag in <code>cvs</code> marks the various versions of the source files in the repository that together make up a particular version of the model. A sample release tag is <code>Heracles- | where ''TAGNAME'' is the model "tag" (version). A tag in <code>cvs</code> marks the various versions of the source files in the repository that together make up a particular version of the model. A sample release tag is <code>Heracles-4_3</code>, indicating the latest patch of version Heracles 4.3 for general use. ''DIRECTORY'' is the directory that the source code tree will be created. If you are using a stock model tag it is reasonable to name the directory the same as the tag. This directory determines which model in presumably your space a particular experiment is using. Some scripts use the environment variable <code>ESMADIR</code>, which should be set to the absolute (full) pathname of this directory. | ||
When a modified version of some component of the model is saved to the repository, the tag it uses -- different from the standard model tag -- is supposed to be applied at most only to the directories with modified files. This means that if you need to use some variant tag of a gridded component, you will have to <code>cd</code> to that directory and update to the variant tag. So, for example, if you needed to apply updates to the SatSim gridded component, you would have to <code>cd</code> several levels down to the directory <code>GEOSsatsim_GridComp</code> and run | When a modified version of some component of the model is saved to the repository, the tag it uses -- different from the standard model tag -- is supposed to be applied at most only to the directories with modified files. This means that if you need to use some variant tag of a gridded component, you will have to <code>cd</code> to that directory and update to the variant tag. So, for example, if you needed to apply updates to the SatSim gridded component, you would have to <code>cd</code> several levels down to the directory <code>GEOSsatsim_GridComp</code> and run | ||
Line 40: | Line 40: | ||
Enter an Experiment Source Tag for History (Default: Heracles- | Enter an Experiment Source Tag for History (Default: Heracles-4_3): | ||
Line 49: | Line 49: | ||
This gives you an opportunity to copy | This gives you an opportunity to copy an existing experiment while changing what needs to be changed to make it work. If you enter yes, the script will ask you which experiment to clone, and then will do so and exit. | ||
Line 76: | Line 76: | ||
Enter the Atmospheric Model Vertical Resolution: LM (Default: 72) | Enter the Atmospheric Model Vertical Resolution: LM (Default: 72) | ||
Unless you know you want a different vertical resolution, hit enter. | |||
Do you wish to run the COUPLED Ocean/Sea-Ice Model? (Default: NO or FALSE) | Do you wish to run the COUPLED Ocean/Sea-Ice Model? (Default: NO or FALSE) | ||
Line 130: | Line 131: | ||
Hit ENTER to use Default Location: | Hit ENTER to use Default Location: | ||
---------------------------------- | ---------------------------------- | ||
Default: /discover/nobackup/aeichman/Heracles- | Default: /discover/nobackup/aeichman/Heracles-4_3 | ||
This determines which of your local builds is used to create the experiment. It defaults to the build of the script you are running, which is generally a good idea. | This determines which of your local builds is used to create the experiment. It defaults to the build of the script you are running, which is generally a good idea. | ||
Line 169: | Line 170: | ||
----- | ----- | ||
Build Directory: /discover/nobackup/aeichman/ Heracles- | Build Directory: /discover/nobackup/aeichman/ Heracles-4_3 | ||
---------------- | ---------------- | ||
Line 175: | Line 176: | ||
The following executable has been placed in your Experiment Directory: | The following executable has been placed in your Experiment Directory: | ||
---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ||
/discover/nobackup/aeichman/Heracles- | /discover/nobackup/aeichman/Heracles-4_3/Linux/bin/GEOSgcm.x | ||
Line 182: | Line 183: | ||
/discover/nobackup/aeichman/myexp42 | /discover/nobackup/aeichman/myexp42 | ||
This U.S. Government resource is for authorized users only. By accessing | |||
this system you are consenting to complete monitoring with no expectation | |||
of privacy. Unauthorized access or use may subject you to disciplinary | |||
action and criminal prosecution. | |||
This U.S. Government resource is for authorized users only. By accessing | |||
this system you are consenting to complete monitoring with no expectation | |||
of privacy. Unauthorized access or use may subject you to disciplinary | |||
action and criminal prosecution. | |||
Applications/GEOSgcm_App> | Applications/GEOSgcm_App> | ||
</pre> | </pre> | ||
The security boilerplate at the end is an artefact of the local copy of the model tag being compared via cvs to the same tag on the repository. If there are differences it will tell in which files they exist, giving you a change to update and recompile the model. Otherwise, the experiment is set up. After you copy initial condition files (aka restarts) to the experiment directory, you can submit your job. | |||
===Do not copy old experiments=== | ===Do not copy old experiments=== | ||
When creating related experiments, you will be tempted to copy the experiment directory tree of an older experiment. '''Do ''not'' copy old experiments, | When creating related experiments, you will be tempted to copy the experiment directory tree of an older experiment. '''Do ''not'' copy old experiments, clone them through <code>gcm_setup</code> instead.''' There are numerous instances where an experiment-specific directory is used in the run scripts created from templates by <code>gcm_setup</code> and they will wreak subtle and pervasive havoc if executed in an unexpected environment. This warning is especially true between model versions. A useful and relatively safe exception to this rule is to copy previously used examples of <code>HISTORY.rc</code>. However, you need to change the lines labeled <code>EXPID</code> and <code>EXPDSC</code> to the values in your automatically-generated <code>HISTORY.rc</code> or the plotting will fail. | ||
=== Using restart files === | === Using restart files === | ||
Line 266: | Line 277: | ||
The individual collection attributes are described below, but what users modify the most are the <code>fields</code> attribute. This determines which exports are saved in the collection. Each field record is a string with the name of an export from the model followed by a string with the name of the gridded component which exports it, separated by a comma. The entries with a third column determine the name by which that export in saved in the collection file when the name is different from that of the export. | The individual collection attributes are described below, but what users modify the most are the <code>fields</code> attribute. This determines which exports are saved in the collection. Each field record is a string with the name of an export from the model followed by a string with the name of the gridded component which exports it, separated by a comma. The entries with a third column determine the name by which that export in saved in the collection file when the name is different from that of the export. | ||
There is a good description of available collection options at Modeling Guru: https://modelingguru.nasa.gov/docs/DOC-1190 | |||
===What exports are available?=== | ===What exports are available?=== |