When installing the ACME model for the first time.
Installing on a supported machine.
If you intend to do ACME development, you should instead follow steps 1-12 in the Development Quick Guide and return to step 7 here.
These steps assume you are a member of the ACME project. Check the Configuration Management page to see if your machine is supported.
- Sign up for a free account at http://github.com
- Add your github user name to the "About Me" section in your Confluence profile.
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.
Log on to the platform on which you want to run ACME.
- 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.
- 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.
- cd to the ACME directory.
- 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 machine
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.
- Add your machine to <ACME>/scripts/ccsm_utils/Machines/config_machines.xml
- The easiest approach is probably to copy the configuration for some other machine and then replace all the values
- Choose a directory to serve as the inputdata store called DIN_LOC_ROOT in config_machines.xml. This should be readable by all ACME developers on your platform.
- 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.
- Add compiler-specific information for each compiler supported by your machine to <ACME>/scripts/ccsm_utils/Machines/config_compilers.xml
- Here, for each compiler you want to support, you'll need to create a block <compiler COMPILER="<toolset>" MACH="<machine>">
- This block will inherit the properties of the primary block for that toolset and allow you to add/override values for your machine.
- The most common thing you'll need to do is add link flags with the ADD_SLIBS item.
- You may also need to define NETCDF_PATH and PNETCDF_PATH
- Add environment settings for your machine by creating this file: <ACME>/scripts/ccsm_utils/Machines/env_mach_specific.<machine>
- This is a csh script that, once sourced, should setup your environment for running ACME
- Common actions here are loading modules, setting PATH and LD_LIBRARY_PATH
- 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 creating this file: <ACME>/scripts/ccsm_utils/Machines/mkbatch.<machine>
- It will be much easier to start by copying mkbatch.userdefined and then editing
- Machines with similar batch systems should serve a good example of what to put in your file
- Verify the install is working by running 2 cases:
- /create_newcase -case <yourcasename> -compset B1850C5CN -res ne30_g16 -mach <yourmachine>
- ./create_newcase -case <yourcasename> -compset ICLM45BGC -res ne30_g16 -mach <yourmachine>
- If you have more then one compiler, add -compiler <compiler> to the above.
- The above should run for 5 days successfully.
Related articles