new start dialog for working dir and template settings

Author: lindakladivova

gui/wxpython/jupyter_notebook/dialogs.py

@@ -0,0 +1,115 @@
+"""
+@package jupyter_notebook.dialog
+
+@brief Integration of Jupyter Notebook to GUI.
+
+Classes:
+ - dialog::JupyterStartDialog
+
+(C) 2025 by the GRASS Development Team
+
+This program is free software under the GNU General Public License
+(>=v2). Read the file COPYING that comes with GRASS for details.
+
+@author Linda Karlovska <linda.karlovska seznam.cz>
+"""
+
+from pathlib import Path
+import grass.script as gs
+
+import wx
+
+
+class JupyterStartDialog(wx.Dialog):
+    """Dialog for selecting working directory and Jupyter startup options."""
+
+    def __init__(self, parent):
+        wx.Dialog.__init__(
+            self, parent, title=_("Start Jupyter Notebook"), size=(500, 300)
+        )
+        env = gs.gisenv()
+        mapset_path = Path(env["GISDBASE"]) / env["LOCATION_NAME"] / env["MAPSET"]
+        self.default_dir = mapset_path / "notebooks"
+
+        self.selected_dir = self.default_dir
+        self.create_template = True
+
+        sizer = wx.BoxSizer(wx.VERTICAL)
+
+        # Working directory section
+        dir_box = wx.StaticBox(self, label=_("Notebook working directory"))
+        dir_sizer = wx.StaticBoxSizer(dir_box, wx.VERTICAL)
+
+        self.radio_default = wx.RadioButton(
+            self,
+            label=_("Use default: {}").format(self.default_dir),
+            style=wx.RB_GROUP,
+        )
+        self.radio_custom = wx.RadioButton(self, label=_("Select another directory:"))
+
+        self.dir_picker = wx.DirPickerCtrl(
+            self,
+            message=_("Choose a working directory"),
+            style=wx.DIRP_USE_TEXTCTRL | wx.DIRP_DIR_MUST_EXIST,
+        )
+        self.dir_picker.Enable(False)
+
+        dir_sizer.Add(self.radio_default, 0, wx.ALL, 5)
+        dir_sizer.Add(self.radio_custom, 0, wx.ALL, 5)
+        dir_sizer.Add(self.dir_picker, 0, wx.EXPAND | wx.ALL, 5)
+        sizer.Add(dir_sizer, 0, wx.EXPAND | wx.ALL, 10)
+
+        # Jupyter startup section
+        options_box = wx.StaticBox(self, label=_("Options"))
+        options_sizer = wx.StaticBoxSizer(options_box, wx.VERTICAL)
+
+        self.checkbox_template = wx.CheckBox(self, label=_("Create example notebook"))
+        self.checkbox_template.SetValue(True)
+        self.checkbox_template.SetToolTip(
+            _(
+                "If selected, a welcome notebook (welcome.ipynb) will be created,\n"
+                "but only if the selected directory contains no .ipynb files."
+            )
+        )
+        options_sizer.Add(self.checkbox_template, 0, wx.ALL, 5)
+
+        info = wx.StaticText(
+            self,
+            label=_(
+                "Note: Template will be created only if the directory contains no .ipynb files."
+            ),
+        )
+
+        options_sizer.Add(info, 0, wx.LEFT | wx.RIGHT | wx.BOTTOM, 8)
+
+        sizer.Add(options_sizer, 0, wx.EXPAND | wx.LEFT | wx.RIGHT, 10)
+
+        # OK / Cancel buttons
+        btns = self.CreateSeparatedButtonSizer(wx.OK | wx.CANCEL)
+        sizer.Add(btns, 0, wx.EXPAND | wx.ALL, 10)
+
+        self.SetSizer(sizer)
+
+        self.radio_default.Bind(wx.EVT_RADIOBUTTON, self.OnRadioToggle)
+        self.radio_custom.Bind(wx.EVT_RADIOBUTTON, self.OnRadioToggle)
+
+        self.Fit()
+        self.Layout()
+        self.SetMinSize(self.GetSize())
+        self.CentreOnParent()
+
+    def OnRadioToggle(self, event):
+        """Enable/disable directory picker based on user choice."""
+        self.dir_picker.Enable(self.radio_custom.GetValue())
+
+    def GetValues(self):
+        """Return selected working directory and template preference."""
+        if self.radio_custom.GetValue():
+            self.selected_dir = Path(self.dir_picker.GetPath())
+        else:
+            self.selected_dir = self.default_dir
+
+        return {
+            "directory": self.selected_dir,
+            "create_template": self.checkbox_template.GetValue(),
+        }

gui/wxpython/jupyter_notebook/panel.py

@@ -35,6 +35,8 @@ def __init__(
         title=_("Jupyter Notebook"),
         statusbar=None,
         dockable=False,
+        workdir=None,
+        create_template=False,
         **kwargs,
     ):
         """Jupyter main panel."""
@@ -44,11 +46,13 @@ def __init__(
         self.parent = parent
         self._giface = giface
         self.statusbar = statusbar
+        self.workdir = workdir
 
         self.SetName("Jupyter")
 
-        self.directory_manager = JupyterDirectoryManager()
-        self.workdir = self.directory_manager.workdir
+        self.directory_manager = JupyterDirectoryManager(
+            workdir=self.workdir, create_template=create_template
+        )
         self.server_manager = JupyterServerInstance(workdir=self.workdir)
 
         self.toolbar = JupyterToolbar(parent=self)

gui/wxpython/main_window/frame.py

@@ -909,9 +909,28 @@ def OnGModeler(self, event=None, cmd=None):
     def OnJupyterNotebook(self, event=None, cmd=None):
         """Launch Jupyter Notebook page. See OnJupyterNotebook documentation"""
         from jupyter_notebook.panel import JupyterPanel
+        from jupyter_notebook.dialogs import JupyterStartDialog
+
+        dlg = JupyterStartDialog(parent=self)
+        result = dlg.ShowModal()
+
+        if result != wx.ID_OK:
+            dlg.Destroy()
+            return
+
+        values = dlg.GetValues()
+        dlg.Destroy()
+
+        workdir = values["directory"]
+        create_template = values["create_template"]
 
         jupyter_panel = JupyterPanel(
-            parent=self, giface=self._giface, statusbar=self.statusbar, dockable=True
+            parent=self,
+            giface=self._giface,
+            statusbar=self.statusbar,
+            dockable=True,
+            workdir=workdir,
+            create_template=create_template,
         )
         jupyter_panel.SetUpPage(self, self.mainnotebook)
         jupyter_panel.SetUpNotebookInterface()

python/grass/workflows/directory.py

@@ -33,10 +33,17 @@
 class JupyterDirectoryManager:
     """Manage a directory of Jupyter notebooks tied to the current GRASS mapset."""
 
-    def __init__(self):
-        """Initialize the Jupyter notebook directory and load existing files."""
-        self._workdir = self._get_workdir()
-        self._files = None
+    def __init__(self, workdir=None, create_template=False):
+        """Initialize the Jupyter notebook directory and load existing files.
+
+        :param workdir: Optional custom working directory (Path). If not provided,
+                        the default MAPSET notebooks directory is used.
+        :param create_template: If True, create a welcome notebook if the directory is empty.
+        """
+        self._workdir = workdir or self._get_workdir()
+        self._workdir.mkdir(parents=True, exist_ok=True)
+        self._files = []
+        self._create_template = create_template
 
     @property
     def workdir(self):
@@ -54,7 +61,7 @@ def files(self):
 
     def _get_workdir(self):
         """
-        :return: Path to working directory, it is created if it does not exist (Path).
+        :return: Path to default working directory, it is created if it does not exist (Path).
         """
         env = gs.gisenv()
         mapset_path = "{gisdbase}/{location}/{mapset}".format(
@@ -67,6 +74,19 @@ def _get_workdir(self):
         workdir.mkdir(parents=True, exist_ok=True)
         return workdir
 
+    def prepare_files(self):
+        """
+        Populate the list of files in the working directory.
+        """
+        # Find all .ipynb files in the notebooks directory
+
+        self._files = [
+            f for f in Path(self._workdir).iterdir() if str(f).endswith(".ipynb")
+        ]
+
+        if self._create_template and not self._files:
+            self.create_welcome_notebook()
+
     def import_file(self, source_path, new_name=None, overwrite=False):
         """Import an existing notebook file to the working directory.
 
@@ -201,16 +221,3 @@ def create_new_notebook(self, new_name, template_name="new.ipynb"):
         self._files.append(target_path)
 
         return target_path
-
-    def prepare_files(self):
-        """
-        Populate the list of files in the working directory.
-        Creates a welcome template if does not exist.
-        """
-        # Find all .ipynb files in the notebooks directory
-        self._files = [
-            f for f in Path(self._workdir).iterdir() if str(f).endswith(".ipynb")
-        ]
-        if not self._files:
-            # If no .ipynb files are found, create a welcome ipynb file
-            self.create_welcome_notebook()