switch USE_PORTAL to be false by default

Signed-off-by: Lance-Drane <Lance-Drane@users.noreply.github.com>

Author: Lance-Drane

doc/user_guides/portal_guides.rst

@@ -21,14 +21,14 @@ To use the portal on your local cluster, include the following variables in your
 
 .. code-block:: text
 
+   # make sure to set this if you actually want to use the portal
+   USE_PORTAL = true
    # stable version
    PORTAL_URL = http://lb.ipsportal.production.svc.spin.nersc.org
    # or, for the latest version
    # PORTAL_URL = http://lb.ipsportal.development.svc.spin.nersc.org
    # The API key is required for certain interactions with the portal, and will eventually become mandatory. This key should generally be set as an environment variable, and not saved to version control.
    PORTAL_API_KEY = "YOUR_PORTAL_API_KEY"  # change this
-   # To disable the portal even if PORTAL_URL is set, uncomment the next line.
-   # USE_PORTAL = false
 
 NOTE: On shared clusters, i.e. Perlmutter, there will generally be specific files that you can source in Slurm scripts which will automatically configure the Portal credentials for you, so you can skip settings these variables yourself. Please see the appropriate project documentation for information on how to configure this.
 

ipsframework/configurationManager.py

@@ -357,14 +357,15 @@ def _initialize_fwk_components(self):
         self.fwk_components.append(runspace_component_id)
 
         # SIMYAN: set up The Portal bridge, allowing for an absence of a portal
-        use_portal = True
-        # If users explicitly disable the Portal via 'USE_PORTAL=false', or do not include a PORTAL_URL, assume the no-portal workflow.
-        # Otherwise, always initialize the Portal workflow
+        use_portal = False
+        # Users must set USE_PORTAL and include a PORTAL_URL in order to enable the portal
         if 'PORTAL_URL' not in self.sim_map[self.fwk_sim_name].sim_conf:
             use_portal = False
         elif 'USE_PORTAL' in self.sim_map[self.fwk_sim_name].sim_conf:
             use_portal = self.sim_map[self.fwk_sim_name].sim_conf['USE_PORTAL']
-            if use_portal.lower() == 'false':
+            if isinstance(use_portal, str) and use_portal.lower().strip() == 'true':
+                use_portal = True
+            else:
                 use_portal = False
 
         fwk_components = [('local_logging_bridge', 'LocalLoggingBridge', lambda _config: None)]

ipsframework/services.py

@@ -1927,8 +1927,21 @@ def setMonitorURL(self, url: str = '') -> None:
         self.monitor_url = url
         self._send_monitor_event(eventType='IPS_SET_MONITOR_URL', comment='SUCCESS')
 
-    def _get_jupyter_runid(self) -> int:
-        """Get the runid Jupyter will associate with this run.
+    def _should_use_portal(self) -> bool:
+        """Return True if we want to use the portal, False if not"""
+        use_portal_config = self.get_config_param('USE_PORTAL', silent=True)
+
+        if isinstance(use_portal_config, str):
+             return use_portal_config.strip().lower() == 'true'
+        elif use_portal_config is None:
+            return False
+        else:
+            # Because USE_PORTAL was not set in config file, or was mistakenly set as a dictionary.
+            self.warning('Unusual value for USE_PORTAL: %s', use_portal_config)
+            return False
+
+    def _get_portal_runid(self) -> int:
+        """Get the runid Jupyter and the Portal will associate with this run.
         Generally this will be the runid that the portal emits, but we will try to allow for fallbacks in certain cases.
 
         If value is < 0, we were unable to get the portal runid.
@@ -1943,8 +1956,7 @@ def _get_jupyter_runid(self) -> int:
             return -2
 
         # first, check to see if we even want to use the portal
-        use_portal = self.get_config_param('USE_PORTAL', silent=True)
-        if use_portal and use_portal.lower() == 'false':
+        if not self._should_use_portal():
             self.warning('web portal disabled')
             self._portal_runid = -2
             return -2
@@ -2000,7 +2012,7 @@ def initialize_jupyter_notebook(
         :param source_notebook_path: location you want to load the source notebook from. This can be either an absolute path, or an IPS-appropriate relative path.
         :param dest_notebook_name: (optional, default None) filename of the notebook to use when saving it to the IPS Portal. If not provided, this will defauly to the filename of the source notebook.
         """
-        portal_runid = self._get_jupyter_runid()
+        portal_runid = self._get_portal_runid()
         if portal_runid < 0:
             return
 
@@ -2038,7 +2050,7 @@ def add_analysis_data_files(self, current_data_file_paths: list[str], timestamp:
         :param replace: If True, replace the last data file added with the new data file. If False, simply append the new data file. (default: False)
               Note that if replace is not True but you attempt to overwrite it, a ValueError will be thrown.
         """
-        portal_runid = self._get_jupyter_runid()
+        portal_runid = self._get_portal_runid()
         if portal_runid < 0:
             return
 
@@ -2396,15 +2408,7 @@ def run_ensemble(
         # ensemble
         portal_ensemble_id = str(uuid.uuid4())
 
-        # (get_config_param() will return a string of a whatever the user set
-        # or None)
-        use_portal = self.get_config_param('USE_PORTAL', silent=True)
-
-        if use_portal is None:
-            # Because USE_PORTAL was not set in config file.
-            use_portal = False
-        elif type(use_portal) == str:
-            use_portal = "true" == use_portal.strip().lower()
+        use_portal = self._should_use_portal()
 
         self.debug(f'use portal = {use_portal!s}')
 
@@ -2573,7 +2577,7 @@ def send_ensemble_instance_to_portal(ensemble_name: str, data_path: Path) -> Non
                 return
 
             # ensure that the portal is initialized
-            portal_runid = self._get_jupyter_runid()
+            portal_runid = self._get_portal_runid()
             if portal_runid < 0:
                 return