Quickstart

Note: instructions here are for NCAR's Cheyenne supercomputer. For all other machines, see: Quickstart (local machines)

1. Downloading:

Before downloading visualCaseGen, make sure that you have git, svn, and conda available.

visualCaseGen is currently distributed with a CESM version based on cesm2_3_beta16. To check out this CESM version and to download all of its components including visualCaseGen, run the following commands. (It is recommended to run the below commands in your home directory, since it make it easier to find visualCaseGen in Jupyter hub).

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

3. Installation:

Run the following commands inside your local copy of cesm2_3_beta16_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. You may activate this environment by running:

conda activate visualCaseGen

4. Launching visualCaseGen

• On a web browser, go to: https://jupyterhub.hpc.ucar.edu/
• Start a server by clicking on Production. Then click on Start button. You may then select Cheyenne login node as your cluster selection and hit Launch server.
• After the Jupyter service is launched, locate the File Browser panel on the left.
• Find your cesm2_3_beta16_gui copy and double click on it.
• Then, double click on the visualCaseGen directory. Within the visualCaseGen directory, find the GUI.ipynb notebook file and double click on it to launch the notebook.
• Before running the notebook cell, make sure that your Python kernel is set to visualCaseGen. The kernel selection is shown on top right corner next to a circle.
• Finally, click on the from visualCaseGen import gui; gui cell and hit shift+return.

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