Installing the ACME Model on a cluster or HPC platform

These instructions assume the machine you're using has already installed all the necessary software such as fortran compilers, MPI libraries, netcdf libraries, pnetcdf libraries, etc.  See Configuration Management for a list of necessary software to build/run ACME.

Installing on a supported cluster.

These steps assume you are a member of the ACME project.   Check the Configuration Management page to see if your machine is supported.

1. Sign up for a free account at http://github.com
2. Add your github user name to the "About Me" section in your Confluence profile.

3. Email James Foucar (jgfouca@sandia.gov) and ask to be added to the ACME private organization on github.  Include your Confluence account name so he can verify you're a member of ACME. 

4. Log on to the platform on which you want to run ACME.  

5. Install an ssh key from that platform to your github account.  See these instructions and note you can skip step 2 if you already have an ssh key on your machine.
6. Clone the repository to your local account with:  git clone git@github.com:ACME-Climate/ACME.git  This will create a directory called "ACME" with the code.
7. cd to the ACME directory.
8. When running with an MPAS component: git submodule update --init  This will pull the code for MPAS components into their subdirectories, like components/mpas-o.
9. You are now ready to create a case, build and run following the CESM Instructions.   By default, you will be running the latest version of "master".

Installing on an un-supported cluster.

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 Quick Guide.

1. Add your machine to <ACME>/cime/machines-acme/config_machines.xml
   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 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>/cime/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 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
4. Add batch settings for your machine by editing <ACME>/cime/machines-acme/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>/cime/machines-acme/config_batch.xml
5. Verify the install is working by building and running a simple X case.
   1. ./create_newcase -case <yourcasename> -compset X -res f19_g16 -mach <yourmachine>
6. If the X case works, try more complex cases.
   
   1. ./create_newcase -case <yourcasename> -compset I1850CLM45CN -res f09_g16 -mach <yourmachine>
   2. ./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.

Related articles