Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jtruesdal authored Jan 16, 2025
1 parent 6f8e047 commit cd518ec
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,21 @@

CAM E3SM NH development code is stored in this repository on the stormspeed branch.

Please see the [CAM wiki](https://github.com/ESCOMP/CAM/wiki) for complete documentation on CAM, getting started with git and how to contribute to CAM's development.

This repository has been forked from ESCOMP cam and contains the following branches:
* main - contains this readme and the Code of Conduct information
* stormspeed - contains the development branch for the StormSPEED project which is based off CAM6_3_085

## How to checkout and use StormSPEED CAM:
## How to checkout and use StormSPEED CAM on the NCAR Izumi cluster:

The instructions below assume you have cloned this repository and are in the repository directory. For example:
Begin by cloning the StormSpeed repository and checking out the CAM code and externals
```
cd /scratch/cluster/$USER
git clone https://github.com/NCAR/StormSPEED
cd StormSPEED
git checkout stormspeed
./manage_externals/checkout_externals
```
To setup Izumi for configuring and compiling StormSPEED:
Setup the Izumi environment for configuring and compiling StormSPEED. For now, this will need to be done for each new terminal session. We are working on making this work out of the box for supported hardware.

```
module load compiler/intel/20.0.1 lang/python/3.11.5
Expand All @@ -26,18 +25,21 @@ setenv GCC_ROOT "/project/amp/jet/install_izumi/spack/opt/spack/linux-almalinux8
setenv USER_SLIBS "$Kokkos_ROOT/lib64/libkokkoscontainers.so.3.0.0 $Kokkos_ROOT/lib64/libkokkoscore.so.3.0.0 $GCC_ROOT/lib64/libstdc++.so.6.0.28"
setenv LD_LIBRARY_PATH "${LD_LIBRARY_PATH}:${Kokkos_ROOT}/lib64:${GCC_ROOT}/lib64"
```
To configure, build, and run a Kessler Simple physics test on Izumi using the theta-l dycore target.
Create a new case, set the dycore target to theta-l, configure run, setup, build, and run a Kessler Simple physics test on Izumi.

```
set CESMDIR=full_path_to_StormSPEED_sandbox_cloned_above
cd /scratch/cluster/$USER
set CESMDIR=/scratch/cluster/$USER/StormSPEED
$CESMDIR/cime/scripts/create_newcase --compset FKESSLER --res ne16_g37 --compiler intel --case FKESSLER_StormSPEED.01 --driver mct --walltime 24:00:00 --queue long --run-unsupported
cd FKESSLER_StormSPEED.01
./xmlchange CAM_TARGET=theta-l
./xmlchange STOP_OPTION=ndays,STOP_N=12,RESUBMIT=0
./xmlchange JOB_WALLCLOCK_TIME=24:00:00
./xmlchange DOUT_S='FALSE'
./xmlchange BFBFLAG=${BFBFLAG}
./xmlchange BFBFLAG=TRUE
./case.setup
./case.build
set RUNDIR=`./xmlquery -value RUNDIR`
mkdir -p $RUNDIR/timing/checkpoints
./case.submit
```
Expand Down

0 comments on commit cd518ec

Please sign in to comment.