folder path for output files and folders

Author: psauvan

docs/users_guide/execution_settings/cad2csg/python_cadtocsg_api_usage.rst

@@ -39,6 +39,7 @@ The following example shows a usage with every attributes specified.
     )
 
     my_settings = geouned.Settings(
+        outPath=".",
         matFile="",
         voidGen=True,
         debug=False,

src/geouned/GEOUNED/core.py

@@ -11,6 +11,7 @@
 from tqdm import tqdm
 
 from .code_version import *
+from .utils.log_utils import setup_logger
 from .conversion import cell_definition as Conv
 from .cuboid.translate import translate
 from .decompose import decom_one as Decom
@@ -23,8 +24,6 @@
 from .write.write_files import write_geometry
 
 logger = logging.getLogger("general_logger")
-logger.info(f"GEOUNED version {version('geouned')}")
-logger.info(f"FreeCAD version {'.'.join(FreeCAD.Version()[:3])}")
 
 
 class CadToCsg:
@@ -67,6 +66,14 @@ def __init__(
         self.filename = None
         self.skip_solids = []
 
+        log_path = Path(self.settings.outPath) / "log_files"
+        log_path.mkdir(parents=True, exist_ok=True)
+        setup_logger("general_logger", log_path / "geouned_general.log")
+        setup_logger("fuzzy_logger", log_path / "geouned_fuzzy.log")
+        setup_logger("solids_logger", log_path / "geouned_solids.log")
+        logger.info(f"GEOUNED version {version('geouned')}")
+        logger.info(f"FreeCAD version {'.'.join(FreeCAD.Version()[:3])}")
+
     @property
     def options(self):
         return self._options
@@ -598,9 +605,9 @@ def _decompose_solids(self, meta: bool):
                 continue
             logger.info(f"Decomposing solid: {i + 1}/{totsolid}")
             if self.settings.debug:
-                debug_output_folder = Path("debug")
-                logger.info(m.Comments)
+                debug_output_folder = Path(self.settings.outPath) / "debug"
                 debug_output_folder.mkdir(parents=True, exist_ok=True)
+                logger.info(m.Comments)
                 if m.IsEnclosure:
                     m.Solids[0].exportStep(str(debug_output_folder / f"origEnclosure_{i}.stp"))
                 else:
@@ -615,7 +622,7 @@ def _decompose_solids(self, meta: bool):
             )
 
             if err != 0:
-                sus_output_folder = Path("suspicious_solids")
+                sus_output_folder = Path(self.settings.outPath) / "suspicious_solids"
                 sus_output_folder.mkdir(parents=True, exist_ok=True)
                 if m.IsEnclosure:
                     Part.CompSolid(m.Solids).exportStep(str(sus_output_folder / f"Enclosure_original_{i}.stp"))

src/geouned/GEOUNED/utils/basic_functions_part2.py

@@ -4,11 +4,7 @@
 import logging
 import math
 
-import FreeCAD
-
 from .basic_functions_part1 import (
-    is_in_line,
-    is_in_plane,
     is_in_tolerance,
     is_opposite,
     is_parallel,

src/geouned/GEOUNED/utils/data_classes.py

@@ -594,7 +594,11 @@ class Settings:
     """Settings for changing the way the CAD to CSG conversion is done
 
     Args:
-        matFile (str, optional): _description_. Defaults to "".
+        outPath (str, optional): Path to folder where output file will be
+            written. If folder doesn't exist it will be created. Defaults
+            to ".".
+        matFile (str, optional): Name of the file in which the material
+            information is provided. Defaults to "".
         voidGen (bool, optional): Generate voids of the geometry. Defaults
             to True.
         debug (bool, optional): Write step files of original and decomposed
@@ -638,6 +642,7 @@ class Settings:
 
     def __init__(
         self,
+        outPath: str = ".",
         matFile: str = "",
         voidGen: bool = True,
         debug: bool = False,
@@ -653,7 +658,7 @@ def __init__(
         startSurf: int = 1,
         sort_enclosure: bool = False,
     ):
-
+        self.outPath = outPath
         self.matFile = matFile
         self.voidGen = voidGen
         self.debug = debug
@@ -669,6 +674,16 @@ def __init__(
         self.startSurf = startSurf
         self.sort_enclosure = sort_enclosure
 
+    @property
+    def outPath(self):
+        return self._outPath
+
+    @outPath.setter
+    def outPath(self, outPath: str):
+        if not isinstance(outPath, str):
+            raise TypeError(f"geouned.Settings.outPath should be a str, not a {type(outPath)}")
+        self._outPath = outPath
+
     @property
     def matFile(self):
         return self._matFile

src/geouned/GEOUNED/write/additional_files.py

@@ -1,19 +1,23 @@
 from pathlib import Path
 
 
-def comments_write(name, MetaList):
+def comments_write(name_path, MetaList):
     """Function to write in an independent file the comment strings"""
 
-    Path(name).parent.mkdir(parents=True, exist_ok=True)
+    Path(name_path).parent.mkdir(parents=True, exist_ok=True)
+    name = name_path.parent.absolute() / (name_path.name + "_summary.txt")
+
     with open(file=name + "_comments.txt", mode="w", encoding="utf-8") as outfile:
         for m in MetaList:
             outfile.write(m.Comments + "\n")
 
 
-def summary_write(name, MetaList):
+def summary_write(name_path, MetaList):
+
+    Path(name_path).parent.mkdir(parents=True, exist_ok=True)
+    name = name_path.parent.absolute() / (name_path.name + "_summary.txt")
 
-    Path(name).parent.mkdir(parents=True, exist_ok=True)
-    with open(file=name + "_summary.txt", mode="w", encoding="utf-8") as outfile:
+    with open(file=name, mode="w", encoding="utf-8") as outfile:
         header = f"  Cell Id{'':5s}Mat Id{'':6s}Density{'':7s}Volume{'':5s}Comments\n"
         outfile.write(header)
 

src/geouned/GEOUNED/write/write_files.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from . import additional_files as OutFiles
 from .mcnp_format import McnpInput
 from .openmc_format import OpenmcInput
@@ -31,14 +32,17 @@ def write_geometry(
             msg = f"outFormat {out_format} not in supported MC codes ({supported_mc_codes})"
             raise ValueError(msg)
 
+    filePath = Path(settings.outPath)
+    pathName = filePath / geometryName
+
     # write cells comments in file
     if cellCommentFile:
-        OutFiles.comments_write(geometryName, MetaList)
+        OutFiles.comments_write(pathName, MetaList)
     if cellSummaryFile:
-        OutFiles.summary_write(geometryName, MetaList)
+        OutFiles.summary_write(pathName, MetaList)
 
     if "mcnp" in outFormat:
-        mcnpFilename = geometryName + ".mcnp"
+        mcnpFilename = filePath / (geometryName + ".mcnp")
         outBox = (
             UniverseBox.XMin,
             UniverseBox.XMax,
@@ -72,15 +76,15 @@ def write_geometry(
         OMCFile = OpenmcInput(MetaList, Surfaces, options, tolerances, numeric_format)
 
     if "openmc_xml" in outFormat:
-        omcFilename = geometryName + ".xml"
+        omcFilename = filePath / (geometryName + ".xml")
         OMCFile.write_xml(omcFilename)
 
     if "openmc_py" in outFormat:
-        omcFilename = geometryName + ".py"
+        omcFilename = filePath / (geometryName + ".py")
         OMCFile.write_py(omcFilename)
 
     if "serpent" in outFormat:
-        serpentFilename = geometryName + ".serp"
+        serpentFilename = filePath / (geometryName + ".serp")
         outBox = (
             UniverseBox.XMin,
             UniverseBox.XMax,
@@ -111,7 +115,7 @@ def write_geometry(
         Serpentfile.write_input(serpentFilename)
 
     if "phits" in outFormat:
-        phitsFilename = geometryName + ".inp"
+        phitsFilename = filePath / (geometryName + ".inp")
         PHITS_outBox = (
             UniverseBox.XMin,
             UniverseBox.XMax,

src/geouned/__init__.py

@@ -11,12 +11,6 @@
 
 from .GEOReverse import *
 from .GEOUNED import *
-from .GEOUNED.utils.log_utils import setup_logger
-
-setup_logger("general_logger", "geouned_general_log.log")
-setup_logger("fuzzy_logger", "geouned_fuzzy_log.log")
-setup_logger("solids_logger", "geouned_solids_log.log")
-
 
 __version__ = version("geouned")