Quickstart

Note: instructions here are for NCAR's Derecho and Casper supercomputers. For all other machines, see: Quickstart (local machines)

1. Downloading:

visualCaseGen is presently bundled with a CESM version based on cesm2_3_beta17_gui. To acquire this CESM version and obtain all of its components, including visualCaseGen, execute the following commands. It is advisable to download CESM in your home directory or create a symbolic link for easier access within Jupyter Hub.

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

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. 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 on derecho or casper.
• After the Jupyter service is launched, locate the File Browser panel on the left.
• Find your cesm2_3_beta17_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

instructions coming soon