gammasimtools 0.5.1__py3-none-any.whl → 0.6.1__py3-none-any.whl

simtools/{io_handler.py → io_operations/io_handler.py}

@@ -1,10 +1,15 @@
 import datetime
 import logging
+import re
 from pathlib import Path
 
 __all__ = ["IOHandlerSingleton", "IOHandler"]
 
 
+class IncompleteIOHandlerInit(Exception):
+    """Exception raised when IOHandler is not initialized"""
+
+
 class IOHandlerSingleton(type):
     """
     Singleton base class
@@ -45,11 +50,11 @@ class IOHandler(metaclass=IOHandlerSingleton):
         Parameters
         ----------
         output_path: str or Path
-            Parent path of the output files created by this class.
+            Path pointing to the output directory.
         data_path: str or Path
-            Parent path of the data files.
+            Path pointing to the data files (e.g., CORSIKA or sim_telarray output).
         model_path: str or Path
-            Parent path of the output files created by this class.
+            Path pointing to the model file directory.
         use_plain_output_path: bool
             Use plain output path without adding tool name and date
 
@@ -59,18 +64,22 @@ class IOHandler(metaclass=IOHandlerSingleton):
         self.data_path = data_path
         self.model_path = model_path
 
-    def get_output_directory(self, label=None, dir_type=None, test=False):
+    def get_output_directory(self, label=None, sub_dir=None, dir_type="simtools"):
         """
-        Get the output directory for the directory type dir_type
+        Return path to output directory
 
         Parameters
         ----------
         label: str
             Instance label.
-        dir_type: str
+        sub_dir: str
             Name of the subdirectory (ray-tracing, model etc)
-        test: bool
-            If true, return test output location
+        dir_type: str
+            The type of directory (e.g., 'simtools', 'test', 'simtools-result').
+            If 'simtools-result' is used, the output directory will be returned
+            without appending a subdirectory string when using the
+            use_plain_output_path option. For the cause of not using use_plain_output_path,
+            output paths appended by 'simtools-output'.
 
         Returns
         -------
@@ -80,21 +89,30 @@ class IOHandler(metaclass=IOHandlerSingleton):
         ------
         FileNotFoundError
             if error creating directory
+        TypeError
+            raised for errors while creating directory name
         """
 
         if self.use_plain_output_path:
             path = Path(self.output_path)
         else:
-            if test:
-                output_directory_prefix = Path(self.output_path).joinpath("test-output")
+            if str(self.output_path).endswith("-output"):
+                output_directory_prefix = Path(self.output_path)
             else:
-                output_directory_prefix = Path(self.output_path).joinpath("simtools-output")
-
-            today = datetime.date.today()
-            label_dir = label if label is not None else "d-" + str(today)
+                try:
+                    output_directory_prefix = Path(self.output_path).joinpath(
+                        re.sub(r"\-result$", "", dir_type) + "-output"
+                    )
+                except TypeError:
+                    self._logger.error(f"Error creating output directory name from {dir_type}")
+                    raise
+            label_dir = label if label is not None else "d-" + str(datetime.date.today())
             path = output_directory_prefix.joinpath(label_dir)
-            if dir_type is not None:
-                path = path.joinpath(dir_type)
+        if sub_dir is not None:
+            if not self.use_plain_output_path:
+                path = path.joinpath(sub_dir)
+            elif dir_type != "simtools-result":
+                path = path.joinpath(sub_dir)
 
         try:
             path.mkdir(parents=True, exist_ok=True)
@@ -104,7 +122,7 @@ class IOHandler(metaclass=IOHandlerSingleton):
 
         return path.absolute()
 
-    def get_output_file(self, file_name, label=None, dir_type=None, test=False):
+    def get_output_file(self, file_name, label=None, sub_dir=None, dir_type="simtools"):
         """
         Get path of an output file.
 
@@ -114,17 +132,20 @@ class IOHandler(metaclass=IOHandlerSingleton):
             File name.
         label: str
             Instance label.
-        dir_type: str
+        sub_dir: str
             Name of the subdirectory (ray-tracing, model etc)
-        test: bool
-            If true, return test output location
+        dir_type: str
+            Directory type (e.g., 'simtools', 'test', 'simtools-result')
+            If 'simtools-result' is used, the output directory will be returned
+            without appending a subdirectory string when using the
+            use_plain_output_path option.
 
         Returns
         -------
         Path
         """
         return (
-            self.get_output_directory(label=label, dir_type=dir_type, test=test)
+            self.get_output_directory(label=label, sub_dir=sub_dir, dir_type=dir_type)
             .joinpath(file_name)
             .absolute()
         )
@@ -145,10 +166,18 @@ class IOHandler(metaclass=IOHandlerSingleton):
         Returns
         -------
         Path
+
+        Raises
+        ------
+        IncompleteIOHandlerInit
+            if data_path is not set
+
         """
 
         if test:
             file_prefix = Path("tests/resources/")
-        else:
+        elif self.data_path is not None:
             file_prefix = Path(self.data_path).joinpath(parent_dir)
+        else:
+            raise IncompleteIOHandlerInit
         return file_prefix.joinpath(file_name).absolute()

simtools/job_execution/job_manager.py

@@ -81,7 +81,7 @@ class JobManager:
         Parameters
         ----------
         run_script: str
-            Shell script descring the job to be submitted.
+            Shell script describing the job to be submitted.
         run_out_file: str or Path
             Redirect output/error/job stream to this file (out,err,job suffix).
         log_file: str or Path