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

...

Info

If you intend to do E3SM development, you should instead follow steps 1-12 in the Development Getting Started Guide and return to step 7 here.

These steps assume you are a member of the E3SM project.   Check the Configuration Management /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. Email James Foucar (jgfouca@sandia.gov) and 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 he we can verify you're a member of ACMEE3SM    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 directory.
  7. OPTIONAL When running with an MPAS component: Currently (until a better solution is found), it's useful to go into the components/mpas-source/src/core_ocean directory and run the two scripts get_cvmix.sh and get_BGC.sh to download those libraries so they are later replicated by the case creation process below. It's not required, but will bypass some credential entry during later builds.
  8. 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".

...

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.   You first have to tell the CIME case control system about your machine.  Complete instructions are in CIME Porting Guide and summarized here.

...