Update pyproject.toml

.github/workflows/ci-tests.yml

@@ -29,7 +29,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: alperaltuntas/CESM
-          ref: cesm3_0_beta03_gui
+          ref: cesm3_0_beta06_gui
           path: CESM
           #submodules: recursive
 

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to visualCaseGen
+
+Thank you for your interest in contributing to visualCaseGen!
+
+We welcome contributions that fix bugs, introduce new features, and enhance the usability, robustness, or performance of the tool. Here's how you can get involved:
+
+## Getting Started
+
+Fork the repository and clone your fork.
+
+Follow the instructions in the visualCaseGen documentation to set up your local visualCaseGen environment: https://esmci.github.io/visualCaseGen/
+
+Create a new branch for your feature or bugfix.
+
+## What You Can Contribute
+
+- Bug fixes and issue resolutions
+- Enhancements to the GUI or core functionality
+- Improved documentation or examples
+- Code cleanup and test coverage
+
+## Guidelines
+
+- Follow the existing code style and structure.
+- Include clear commit messages.
+- Test your changes before submitting.
+- Add tests if you introduce new features.
+- Open a Pull Request with a short summary of your changes.
+- If addressing an open issue, mention it in your PR (e.g., Closes #42).
+
+## Reporting Issues
+
+Please use the GitHub Issues page to report bugs or suggest features. When reporting:
+
+- Include the version of visualCaseGen you used and details about your system environment.
+- Provide clear steps to reproduce the issue.
+- Include screenshots or logs if helpful.

ProConPy/config_var.py

@@ -334,6 +334,11 @@ def update_options_validities(self):
 
         return validities_changed
 
+    @property
+    def valid_options(self):
+        """Returns the list of valid options for this variable."""
+        return [opt for opt in self._options if self._options_validities.get(opt, False)]
+
     def _refresh_widget_options(self):
         """Refresh the widget options list based on information in the current self._options_validities."""
 

ProConPy/stage.py

@@ -352,7 +352,7 @@ def _proceed(self):
             return
 
         # Display the child stage and its siblings by appending them to the current stage's widget
-        if self.has_children():
+        if self.has_children() and next_stage.is_descendant_of(self):
             self._widget.add_child_stages(first_child=next_stage)
 
         # Proceed the csp solver before enabling the next stage
@@ -378,20 +378,24 @@ def get_next(self, full_dfs=False):
             The next stage to visit, if found. Otherwise, None.
         """
 
-        if self.has_children():
-            return self._get_child_to_enable(full_dfs)
-        elif self._right is not None:
+        # First try to get a child stage to enable
+        if (child_to_enable := self._get_child_to_enable(full_dfs)) is not None:
+            return child_to_enable
+
+        # No child stage to enable. Try to get the right sibling.
+        if self._right is not None:
             return self._right
-        else:  # Backtrack
-            ancestor = self._parent
-            while ancestor is not None:
-                if ancestor._right is not None and (
-                    full_dfs or not ancestor.has_condition()
-                ):
-                    return ancestor._right
-                else:
-                    ancestor = ancestor._parent
-            return None
+
+        # No child or right sibling. Backtrack to find the next stage.
+        ancestor = self._parent
+        while ancestor is not None:
+            if ancestor._right is not None and (
+                full_dfs or not ancestor.has_condition()
+            ):
+                return ancestor._right
+            else:
+                ancestor = ancestor._parent
+        return None
 
     def _get_child_to_enable(self, full_dfs):
         """Determine the child stage to activate.
@@ -401,6 +405,9 @@ def _get_child_to_enable(self, full_dfs):
         full_dfs : bool
             If True, visit all the stages in the stage tree. Otherwise, skip stages whose guards
             are not satisfied."""
+
+        if self.has_children() is False:
+            return None
 
         child_to_activate = None
 
@@ -412,18 +419,19 @@ def _get_child_to_enable(self, full_dfs):
                         child_to_activate is None
                     ), "Only one child stage can be activated at a time."
                     child_to_activate = child
+
+            if child_to_activate is None:
+                # No child guard's condition is satisfied.
+                # Let the caller handle this case (by backtracking).
+                return None
         else:
             # If children are not guards, the first child is activated.
             # Note the remaining children will be activated in sequence by their siblings.
             child_to_activate = self._children[0]
 
         # If the child to activate is a Guard, return it's first child
         if child_to_activate.has_condition():
-            return child_to_activate._children[0]
-
-        assert (
-            child_to_activate is not None
-        ), "At least one child stage must be activated."
+            child_to_activate = child_to_activate._children[0]
 
         return child_to_activate
 

environment.yml

@@ -6,7 +6,8 @@ channels:
 
 dependencies:
   - python>=3.11.10,<3.12
-  #- xesmf
+  - libxml2>=2.13,<2.14
+  - xesmf>=0.8.10,<0.9
   - pip
   - pip:
     - -e ./external/mom6_bathy/

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "visualCaseGen"
-version = "0.1.1"
+version = "0.1.3"
 authors = [
   { name = "Alper Altuntas, NCAR", email = "altuntas@ucar.edu" }
 ]
@@ -9,7 +9,7 @@ readme = "README.md"
 license = { file = "LICENSE.md" }
 classifiers = [
   "Intended Audience :: Science/Research",
-  "License :: OSI Approved :: LGPL",
+  "License :: OSI Approved :: Apache 2.0 License",
   "Programming Language :: Python",
   "Framework :: Jupyter"
 ]
@@ -35,4 +35,4 @@ requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
-packages = ["ProConPy", "visualCaseGen"]
+packages = ["ProConPy", "visualCaseGen"]

tests/1_unit/test_cores_case_creator.py

@@ -17,11 +17,11 @@ def test_calc_cores_based_on_grid_cases():
     assert CaseCreator._calc_cores_based_on_grid(33) == 1
 
     # Test ideal cores amount
-    assert CaseCreator._calc_cores_based_on_grid(800*128) == 128
+    assert CaseCreator._calc_cores_based_on_grid(300*128) == 128
 
-    assert CaseCreator._calc_cores_based_on_grid(800*32) == 128
+    assert CaseCreator._calc_cores_based_on_grid(300*32) == 128
 
-    assert CaseCreator._calc_cores_based_on_grid(740 * 780) == 768
+    assert CaseCreator._calc_cores_based_on_grid(740 * 780) == 2048
 
 
 

tests/3_system/test_custom_compset_std_grid.py

@@ -0,0 +1,107 @@
+#!/usr/bin/env python3
+
+import pytest
+import shutil
+import os
+from pathlib import Path
+import tempfile
+import time
+
+from ProConPy.config_var import ConfigVar, cvars
+from ProConPy.stage import Stage
+from ProConPy.csp_solver import csp
+from visualCaseGen.cime_interface import CIME_interface
+from visualCaseGen.initialize_configvars import initialize_configvars
+from visualCaseGen.initialize_widgets import initialize_widgets
+from visualCaseGen.initialize_stages import initialize_stages
+from visualCaseGen.specs.options import set_options
+from visualCaseGen.specs.relational_constraints import get_relational_constraints
+from visualCaseGen.custom_widget_types.mom6_bathy_launcher import MOM6BathyLauncher
+from visualCaseGen.custom_widget_types.case_creator_widget import CaseCreatorWidget
+from tests.utils import safe_create_case
+
+
+# do not show logger output
+import logging
+
+logger = logging.getLogger()
+logger.setLevel(logging.CRITICAL)
+
+base_temp_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "temp"))
+
+
+def test_custom_compset_std_grid():
+    """Configure a custom compset with a standard grid: 2000_DATM%JRA_SLND_CICE%PRES_MOM6_SROF_SGLC_WW3. Progress through the stages
+    until the launch stage is reached."""
+
+    ConfigVar.reboot()
+    Stage.reboot()
+    cime = CIME_interface()
+    initialize_configvars(cime)
+    initialize_widgets(cime)
+    initialize_stages(cime)
+    set_options(cime)
+    csp.initialize(cvars, get_relational_constraints(cvars), Stage.first())
+
+    # At initialization, the first stage should be enabled
+    assert Stage.first().enabled
+    cvars['COMPSET_MODE'].value = 'Custom'
+
+    # CCOMPSET_MODE is the only variable in the first stage, so assigning a value to it should disable the first stage
+    assert not Stage.first().enabled
+
+    # The next stge is Custom Component Set, whose first child is Model Time Period
+    assert Stage.active().title.startswith('Time Period')
+    cvars['INITTIME'].value = '1850'
+
+    cvars['COMP_OCN'].value = "mom"
+    cvars['COMP_ICE'].value = "sice"
+    cvars['COMP_ATM'].value = "cam"
+    cvars['COMP_ROF'].value = "mosart"
+    cvars['COMP_LND'].value = "clm"
+    cvars['COMP_WAV'].value = "swav"
+    cvars['COMP_GLC'].value = "sglc"
+
+
+    assert Stage.active().title.startswith('Component Physics')
+
+    cvars['COMP_ATM_PHYS'].value = "CAM60"
+    cvars['COMP_LND_PHYS'].value = "CLM60"
+
+    assert Stage.active().title.startswith('Component Options')
+
+    cvars['COMP_ATM_OPTION'].value = "1PCT"
+    cvars['COMP_LND_OPTION'].value = "BGC"
+    cvars['COMP_OCN_OPTION'].value = "(none)"
+    cvars['COMP_ICE_OPTION'].value = "(none)"
+    cvars['COMP_ROF_OPTION'].value = "(none)"
+
+    assert Stage.active().title.startswith('2. Grid')
+
+    cvars['GRID_MODE'].value = 'Standard'
+    cvars['GRID'].value = 'f09_t232'
+
+    assert Stage.active().title.startswith('3. Launch')
+    launch_stage = Stage.active()
+
+    with tempfile.TemporaryDirectory(dir=base_temp_dir) as temp_case_path:
+        pass    # immediately remove the random temporary directory,
+                # which will become the caseroot directory below
+
+    cvars["CASEROOT"].value = temp_case_path
+
+    case_creator = launch_stage._widget._main_body.children[-1]
+    assert isinstance(case_creator, CaseCreatorWidget)
+
+    cvars["PROJECT"].value = "12345"
+
+    # *Click* the create_case button
+    safe_create_case(cime.srcroot, case_creator)
+
+    # sleep for a bit to allow the case to be created
+    time.sleep(5)
+
+    # remove the caseroot directory
+    shutil.rmtree(temp_case_path)
+
+

tests/3_system/test_custom_mom6_grid.py

@@ -141,7 +141,10 @@ def test_custom_mom6_grid():
         assert Stage.active().title.startswith("Simple Initial Conditions")
         cvars["T_REF"].value = 10.0
 
-        # Since land grid gets set automatically, we should be in the Launch stage:
+        # Since land grid and runoff grid get set automatically, we should be in the runoff to ocn mapping:
+        assert Stage.active().title.startswith("Runoff to Ocean Mapping")
+        cvars["ROF_OCN_MAPPING_STATUS"].value = "skip"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()
 

tests/3_system/test_f2000_custom_grid.py

@@ -159,6 +159,9 @@ def construct_custom_res_from_std_grids(cime):
         assert Stage.active().title.startswith("Land Grid")
         cvars["CUSTOM_LND_GRID"].value = "0.9x1.25"
 
+        assert Stage.active().title.startswith("Runoff Grid")
+        cvars["CUSTOM_ROF_GRID"].value = "r05"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()
 
@@ -248,6 +251,9 @@ def construct_custom_res_from_modified_clm_grid(cime):
         # click the "Run Surface Data Modifier" button
         fsurdat_modifier_launcher._on_launch_clicked(b=None)
 
+        assert Stage.active().title.startswith("Runoff Grid")
+        cvars["CUSTOM_ROF_GRID"].value = "r05"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()
 
@@ -364,6 +370,9 @@ def construct_custom_res_from_new_mom6_grid_modified_clm_grid(cime):
         # click the "Run Surface Data Modifier" button
         fsurdat_modifier_launcher._on_launch_clicked(b=None)
 
+        assert Stage.active().title.startswith("Runoff Grid")
+        cvars["CUSTOM_ROF_GRID"].value = "r05"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()
 

tests/3_system/test_fhist_custom_grid.py

@@ -129,6 +129,9 @@ def construct_custom_res_from_std_grids(cime):
         assert Stage.active().title.startswith("Land Grid")
         cvars["CUSTOM_LND_GRID"].value = "0.9x1.25"
 
+        assert Stage.active().title.startswith("Runoff Grid")
+        cvars["CUSTOM_ROF_GRID"].value = "r05"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()
 
@@ -218,6 +221,9 @@ def construct_custom_res_from_modified_clm_grid(cime):
         # click the "Run Surface Data Modifier" button
         fsurdat_modifier_launcher._on_launch_clicked(b=None)
 
+        assert Stage.active().title.startswith("Runoff Grid")
+        cvars["CUSTOM_ROF_GRID"].value = "r05"
+
         assert Stage.active().title.startswith("3. Launch")
         launch_stage = Stage.active()