Installation

Every ACME developer should be able to run the acme_developer test suite on at least one machine to which they have convenient access so that they can test their changes before submitting a pull request.

Step-by-step guide

1. Ensure you have the correct tools in your PATH
   1. A full list of software requirements can be found at the top of this page
   2. IF your machine is listed on that page, then most of the environment issues will be taken care of for you, however, you'll still need the following before you can even get started:
      1. git 1.7 or newer (so you can clone repository)
      2. Perl (5.16+), plus the following modules (so you can run ACME scripts):
         1. LibXML
         2. XML::SAX
         3. XML::SAX::Exception
         4. Switch (Switch.pm)
2. Clone the ACME repository
   1. If you are unsure how to do this, go here
3. Make sure the machine you want to test on is supported (should be listed here)
   
   1. If the machine is an institutional cluster or LCF, please contact the SE team and inform them of your needs
   2. If the machine is a personal machine, you'll need to setup configuration for it yourself, go here for help.
4. You'll need to set up your ACME scratch area
   1. Find the configuration for your machine
      1. Found here <ACME>/scripts/ccsm_utils/Machines/config_machines.xml
      2. Search for your machine
      3. Look for the CESMSCRATCHROOT element
   2. Make sure this directory exists and you have read/write access to it

You should now be ready to run tests.

Related articles