#2533: set default dev output path + clean up

src/primaite/__init__.py

@@ -122,20 +122,13 @@ class _PrimaitePaths:
 PRIMAITE_PATHS: Final[_PrimaitePaths] = _PrimaitePaths()
 
 
-def _host_primaite_config() -> None:
-    if not PRIMAITE_PATHS.app_config_file_path.exists():
-        pkg_config_path = Path(pkg_resources.resource_filename("primaite", "setup/_package_data/primaite_config.yaml"))
-        shutil.copy2(pkg_config_path, PRIMAITE_PATHS.app_config_file_path)
-
-
-_host_primaite_config()
-
-
 def _get_primaite_config() -> Dict:
     config_path = PRIMAITE_PATHS.app_config_file_path
     if not config_path.exists():
         # load from package if config does not exist
         config_path = Path(pkg_resources.resource_filename("primaite", "setup/_package_data/primaite_config.yaml"))
+        # generate app config
+        shutil.copy2(config_path, PRIMAITE_PATHS.app_config_file_path)
     with open(config_path, "r") as file:
         # load from config
         primaite_config = yaml.safe_load(file)

src/primaite/session/io.py

@@ -5,8 +5,9 @@ from typing import Dict, List, Optional
 
 from pydantic import BaseModel, ConfigDict
 
-from primaite import getLogger, PRIMAITE_PATHS
+from primaite import _PRIMAITE_ROOT, getLogger, PRIMAITE_PATHS
 from primaite.simulator import LogLevel, SIM_OUTPUT
+from primaite.utils.cli.primaite_config_utils import is_dev_mode
 
 _LOGGER = getLogger(__name__)
 
@@ -61,17 +62,13 @@ class PrimaiteIO:
         date_str = timestamp.strftime("%Y-%m-%d")
         time_str = timestamp.strftime("%H-%M-%S")
 
-        # check if running in dev mode
-        # if is_dev_mode():
-        #     # if dev mode, simulation output will be the repository root or whichever path is configured
-        #     app_config = get_primaite_config_dict()
-        #     if app_config["developer_mode"]["output_dir"] is not None:
-        #         session_path = app_config["developer_mode"]["output_dir"]
-        #     else:
-        #         session_path = _PRIMAITE_ROOT.parent.parent / "simulation_output" / date_str / time_str
-        # else:
         session_path = PRIMAITE_PATHS.user_sessions_path / date_str / time_str
 
+        # check if running in dev mode
+        if is_dev_mode():
+            # check if there is an output directory set in config
+            session_path = _PRIMAITE_ROOT.parent.parent / "sessions" / date_str / time_str
+
         session_path.mkdir(exist_ok=True, parents=True)
         return session_path
 

src/primaite/simulator/__init__.py

@@ -3,7 +3,7 @@ from datetime import datetime
 from enum import IntEnum
 from pathlib import Path
 
-from primaite import _PRIMAITE_ROOT, PRIMAITE_CONFIG
+from primaite import _PRIMAITE_ROOT, PRIMAITE_CONFIG, PRIMAITE_PATHS
 
 __all__ = ["SIM_OUTPUT"]
 
@@ -27,9 +27,17 @@ class LogLevel(IntEnum):
 
 class _SimOutput:
     def __init__(self):
-        self._path: Path = (
-            _PRIMAITE_ROOT.parent.parent / "simulation_output" / datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
-        )
+        date_str = datetime.now().strftime("%Y-%m-%d")
+        time_str = datetime.now().strftime("%H-%M-%S")
+
+        path = PRIMAITE_PATHS.user_sessions_path / date_str / time_str
+
+        if is_dev_mode():
+            # if dev mode is enabled, if output dir is not set, print to primaite repo root
+            path: Path = _PRIMAITE_ROOT.parent.parent / "sessions" / date_str / time_str / "simulation_output"
+            # otherwise print to output dir
+
+        self._path = path
         self._save_pcap_logs: bool = False
         self._save_sys_logs: bool = False
         self._write_sys_log_to_terminal: bool = False

src/primaite/utils/cli/dev_cli.py

@@ -15,7 +15,7 @@ PRODUCTION_MODE_MESSAGE = (
     " :monkey_face::monkey_face::monkey_face: [/green]\n"
 )
 
-DEVELOPMENT_MODE_MESSAGE = (
+DEVELOPER_MODE_MESSAGE = (
     "\n[yellow] :construction::construction::construction: "
     " PrimAITE is running in Development mode "
     " :construction::construction::construction: [/yellow]\n"
@@ -38,7 +38,7 @@ def dev_mode():
 def show():
     """Show if PrimAITE is in development mode or production mode."""
     # print if dev mode is enabled
-    print(DEVELOPMENT_MODE_MESSAGE if is_dev_mode() else PRODUCTION_MODE_MESSAGE)
+    print(DEVELOPER_MODE_MESSAGE if is_dev_mode() else PRODUCTION_MODE_MESSAGE)
     print("\nTo see available options, use [medium_turquoise]`primaite dev-mode --help`[/medium_turquoise]\n")
 
 
@@ -48,7 +48,7 @@ def enable():
     # enable dev mode
     PRIMAITE_CONFIG["developer_mode"]["enabled"] = True
     update_primaite_application_config()
-    print(DEVELOPMENT_MODE_MESSAGE)
+    print(DEVELOPER_MODE_MESSAGE)
 
 
 @dev.command()

src/primaite/utils/cli/primaite_config_utils.py

@@ -5,11 +5,7 @@ from primaite import PRIMAITE_CONFIG, PRIMAITE_PATHS
 
 def is_dev_mode() -> bool:
     """Returns True if PrimAITE is currently running in developer mode."""
-    return (
-        PRIMAITE_CONFIG["developer_mode"]["enabled"]
-        if (PRIMAITE_CONFIG.get("developer_mode", {}).get("enabled"))
-        else False
-    )
+    return PRIMAITE_CONFIG["developer_mode"]["enabled"]
 
 
 def update_primaite_application_config() -> None: