Page Comparison

...

Follow steps 1-6 above.   If you want to make it supported, treat the steps as code development (done on a branch) following the Development Getting Started Guide.

1. Add your machine to <ACME><E3SM>/cime/config/e3sm/machines-acme/config_machines.xml where <E3SM> refers to the repository root.
   
   1. The easiest approach is probably to copy the configuration for some other machine and then replace all the values
   2. Choose a directory to serve as the inputdata store called DIN_LOC_ROOT in config_machines.xml.   Ideally, this should be readable by all ACME E3SM developers on your platform.
   3. Most of the values should be obvious. You can look at the "userdefined" block to see which items are required and to see documentation on each item.
2. Add compiler-specific information for each compiler supported by your machine to <ACME><E3SM>/cime/config/e3sm/machines-acme/config_compilers.xml
   
   1. Here, for each compiler you want to support, you'll need to create a block <compiler COMPILER="<toolset>" MACH="<machine>">
   2. This block will inherit the properties of the primary block for that toolset and allow you to add/override values for your machine.
      1. The most common thing you'll need to do is add link flags with the ADD_SLIBS item.
      2. You may also need to define NETCDF_PATH and PNETCDF_PATH
3. Add environment batch settings for your machine by creating this file: <ACME>editing <E3SM>/cime/machines-acme/env_mach_specific.<machine>
   1. This is a csh script that, once sourced, should setup your environment for running ACME
   2. Common actions here are loading modules, setting PATH and LD_LIBRARY_PATH
   3. You may need indirection in this file if your machine supports multiple compilers, e.g: if ($COMPILER == "intel") then; module load intel; else; module load gcc; endif
   Add batch settings for your machine by editing <ACME>/cime/machines-acmeconfig/e3sm/machines/config_machines.xml
   1. Machines with similar batch systems should serve a good example of what to add.
   2. If you need a batch system that doesn't exit or special settings, you may have to edit <ACME><E3SM>/cime/config/e3sm/machines-acme/config_batch.xml
   3. You may need to add a machine specific section in config_batch.xml that inherits from the global section for a specified batch system (e.g., pbs).
4. In certain special cases, you may wish to add/edit <E3SM>/cime/config/e3sm/machines/Depends.<platform>.<compiler> to tweak compilation options for specific files.
5. Verify the install is working by building and running a simple X case.
   1. <ACME><E3SM>/cime/scripts/create_newcase --case <yourcasename> --compset X --res f19_g16 --mach <yourmachine>
6. If the X case works, try more complex cases.
   
   1. <ACME><E3SM>/cime/scripts/create_newcase --case <yourcasename> --compset I1850CLM45CN --res f09_g16 --mach <yourmachine>
   2. <ACME><E3SM>/cime/scripts/create_newcase --case <yourcasename> --compset FC5 --res ne30_ne30 --mach <yourmachine>
      
      1. If you have more then one compiler, add -compiler <compiler> to the above.
      2. The above should run for 5 days successfully.
7. OBSOLETE: Will delete old Step 3 below unless there are objections. This functionality is currently handled in config_machines.xml etc.
   Add environment settings for your machine by creating this file: <ACME>/cime/machines-acme/env_mach_specific.<machine>
   
   1. This is a csh script that, once sourced, should setup your environment for running ACME
   2. Common actions here are loading modules, setting PATH and LD_LIBRARY_PATH
   3. You may need indirection in this file if your machine supports multiple compilers, e.g: if ($COMPILER == "intel") then; module load intel; else; module load gcc; endif

Related articles

...