Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 /wiki/spaces/ED/pages/1867951 for Hardware/Software Configuration for a list of necessary software to build/run ACMEE3SM.

Table of Contents

Installing on a supported cluster.

...

These steps assume you are a member of the E3SM project.   Check the the (staff only) /wiki/spaces/ED/pages/1867951 page to see if your machine is supported.

  1. Sign up for a free account at http://github.com
  2. Submit a ticket to the SE/CG Testing & CI Support Help Desk and ask to be added to the E3SM private organization on github.  Include your Confluence account name so we can verify you're a member of E3SM.      OR   "fork" the model to your own github account.
  3. Log on to the platform on which you want to run E3SM.  

  4. 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.
  5. Clone the repository to your local account with:  git clone  --recursive git@github.com:E3SM-Project/E3SM.git  This will create a directory called "E3SM" with the code.
  6. cd to the E3SM/cime/scripts directory.
  7. You are now ready to create a case, build and run following the CIME quick guide.   By default, you will be running the latest version of "master".

Installing on an un-supported cluster or machine.

Follow steps 1-6 above to get access to the code.  

If you don't want to do a complete port of E3SM to your machine, you can use a "container" which has everything you need to develop and run.   We have development containers for docker and singularity.

Follow steps 1-6 above to get access to the code.

To port your machine, you first have to describe it to the CIME Case Control System.  Complete instructions are in CIME Porting Guide and summarized here.  The best way is to copy the entries for a machine similar to yours and then modify.

...