Quickstart (local machine)

1. Downloading:

Before downloading visualCaseGen, make sure that you have both git and svn libraries installed on your machine.

visualCaseGen is currently distributed with a CESM version based on cesm2_3_beta17_gui. To check out this CESM version and to download all of its components including visualCaseGen, run the following commands.

git clone https://github.com/alperaltuntas/cesm.git -b cesm2_3_beta17_gui cesm2_3_beta17_gui
cd cesm2_3_beta17_gui
./manage_externals/checkout_externals -o

2. Prerequisities:

• Operating system: Linux | OSX.
• conda: https://docs.conda.io/en/latest/
• All libraries required by CESM, including but not limited to git, git-lfs, svn, and xmllint.
• To be able create and run cases with (or without) visualCaseGen, you need to port CESM to your local machine. Follow the instructions on: https://esmci.github.io/cime/versions/master/html/users_guide/porting-cime.html

3. Installation:

If you have previously installed an older version of the visualCaseGen conda environment, remove the older version by running:

conda env remove -n visualCaseGen

Run the following commands inside your local copy of cesm2_3_beta17_gui for installing the visualCaseGen library:

cd visualCaseGen
conda env create -f environment.yml

The above command will install a new conda environment called visualCaseGen. Before each session, make sure to activate this environment by running:

conda activate visualCaseGen

4. Launching visualCaseGen

• If you are not there already, navigate to:

cesm2_3_beta17_gui/visualCaseGen

• Launch Jupyter Lab by running the following commands on a terminal:

conda activate visualCaseGen
jupyter notebook

• The above commands should launch jupytero on your browser. Find GUI.ipynb file and double click. When the GUI.ipynb notebook opens up, select the first cell ( from visualCaseGen import gui; gui) and hit shift+return. If all goes well, the GUI should appear.

5. Working with visualCaseGen

Step 1: Preliminaries

When the GUI is launched, the users are prompted to make a couple of preliminary choices: The CESM driver (nuopc or mct) and the Configuration mode:

• predefined configuration mode: Select from configurations predefined within CESM
• custom configuration mode: Build your own compset for a breakthrough CESM experiment.

After having made the preliminary choices, click on the Confirm button to move on the next step.

Step 2: Create Case

instructions coming soon