-
Notifications
You must be signed in to change notification settings - Fork 0
Quickstart
visualCaseGen is currently distributed with a CESM version based on cesm2_3_beta06. To check out this CESM version and to download all of its components including visualCaseGen, run the following commands. Note that, on cheyenne, this command needs to be run on your home directory so that the GUI notebook can be accesible from the Jupyter Hub.
git clone --recursive https://github.com/alperaltuntas/cesm.git -b cesm2_3_beta06_gui_211021 cesm2_3_beta06_gui_211021
cd cesm2_3_beta06_gui_211021
./manage_externals/checkout_externals -o
(Skip to Section 3 if you are running on cheyenne.)
-
Operating system: Linux | OSX.
-
If your machine is not supported by default, you need to port CESM. Follow the instructions on: https://esmci.github.io/cime/versions/master/html/users_guide/porting-cime.html
-
Make sure that the
xmllint
tool is available on your machine. -
visualCaseGen tool currently requires the following Python Libraries:
- jupyterlab, ipywidgets, PyYAML
-
To obtain the above libraries and install visualCaseGen, run the following commands: (Not needed on Cheyenne)
cd visualCaseGen pip install -e .
Note to developers: pip install
needs to be run on editable mode (-e
) to ensure that the CIME library is accessible from visualCaseGen, since there is not a CIME setup configuration that places CIME to site-packages.
- On a web browser, go to:
https://jupyterhub.hpc.ucar.edu/
- Start a server by clicking on
Production
. Then click onStart my server
button. You may then selectCheyenne login node
as your cluster selection and hitLaunch server
. - After the Jupyter service is launched, find the
cesm2_3_beta06_gui_211021
directory and double click on it on left panel. Note that the directory will appear there only if you have downloaded CESM on your home directory. In the same panel double click onvisualCaseGen
. Then, double click onGUI.ipynb
notebook. - Before running the notebook cell, make sure that your Python kernel is set to
NPL-3.9.7
. The kernel selection is shown on top right corner next to a circle. - Finally, click on the
import visualCaseGen
cell and hitshift
+return
.
-
Launch Jupyter Lab by running the following command on a terminal:
jupyter lab
-
Create a new notebook. To launch the GUI, type in the following statement in a cell:
import visualCaseGen
container instructions coming soon
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.
instructions coming soon