From 0869010fc68caa6f6aac51eff6352782b0e81bf9 Mon Sep 17 00:00:00 2001
From: nmannall <n.mannall@epcc.ed.ac.uk>
Date: Mon, 9 Dec 2024 17:27:59 +0000
Subject: [PATCH] Move cmds_singleuse.py to new user_objects folder

---
 gprMax/__init__.py                          |  8 +++----
 gprMax/hash_cmds_singleuse.py               | 26 +++++++++++++++++----
 gprMax/scene.py                             |  2 +-
 gprMax/{ => user_objects}/cmds_singleuse.py |  4 ++--
 4 files changed, 28 insertions(+), 12 deletions(-)
 rename gprMax/{ => user_objects}/cmds_singleuse.py (96%)

diff --git a/gprMax/__init__.py b/gprMax/__init__.py
index b97fa2dc..28dfb434 100644
--- a/gprMax/__init__.py
+++ b/gprMax/__init__.py
@@ -46,7 +46,10 @@ from .cmds_multiuse import (
     VoltageSource,
     Waveform,
 )
-from .cmds_singleuse import (
+from .gprMax import run as run
+from .scene import Scene
+from .subgrids.user_objects import SubGridHSG
+from .user_objects.cmds_singleuse import (
     Discretisation,
     Domain,
     OMPThreads,
@@ -58,8 +61,5 @@ from .cmds_singleuse import (
     TimeWindow,
     Title,
 )
-from .gprMax import run as run
-from .scene import Scene
-from .subgrids.user_objects import SubGridHSG
 
 __name__ = "gprMax"
diff --git a/gprMax/hash_cmds_singleuse.py b/gprMax/hash_cmds_singleuse.py
index 2ff9eaf5..08b57b97 100644
--- a/gprMax/hash_cmds_singleuse.py
+++ b/gprMax/hash_cmds_singleuse.py
@@ -18,9 +18,18 @@
 
 import logging
 
-from .cmds_singleuse import (Discretisation, Domain, OMPThreads, OutputDir,
-                             PMLProps, RxSteps, SrcSteps,
-                             TimeStepStabilityFactor, TimeWindow, Title)
+from .user_objects.cmds_singleuse import (
+    Discretisation,
+    Domain,
+    OMPThreads,
+    OutputDir,
+    PMLProps,
+    RxSteps,
+    SrcSteps,
+    TimeStepStabilityFactor,
+    TimeWindow,
+    Title,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -54,7 +63,9 @@ def process_singlecmds(singlecmds):
     if singlecmds[cmd] is not None:
         tmp = tuple(int(x) for x in singlecmds[cmd].split())
         if len(tmp) != 1:
-            logger.exception(f"{cmd} requires exactly one parameter to specify the number of CPU OpenMP threads to use")
+            logger.exception(
+                f"{cmd} requires exactly one parameter to specify the number of CPU OpenMP threads to use"
+            )
             raise ValueError
 
         omp_threads = OMPThreads(n=tmp[0])
@@ -144,7 +155,12 @@ def process_singlecmds(singlecmds):
                 pml_props = PMLProps(thickness=int(tmp[0]))
             else:
                 pml_props = PMLProps(
-                    x0=int(tmp[0]), y0=int(tmp[1]), z0=int(tmp[2]), xmax=int(tmp[3]), ymax=int(tmp[4]), zmax=int(tmp[5])
+                    x0=int(tmp[0]),
+                    y0=int(tmp[1]),
+                    z0=int(tmp[2]),
+                    xmax=int(tmp[3]),
+                    ymax=int(tmp[4]),
+                    zmax=int(tmp[5]),
                 )
 
         scene_objects.append(pml_props)
diff --git a/gprMax/scene.py b/gprMax/scene.py
index 5ca94d95..ee81af3a 100644
--- a/gprMax/scene.py
+++ b/gprMax/scene.py
@@ -25,13 +25,13 @@ from gprMax.cmds_geometry.add_surface_water import AddSurfaceWater
 from gprMax.cmds_geometry.cmds_geometry import UserObjectGeometry
 from gprMax.cmds_geometry.fractal_box import FractalBox
 from gprMax.cmds_multiuse import UserObjectMulti
-from gprMax.cmds_singleuse import Discretisation, Domain, TimeWindow, UserObjectSingle
 from gprMax.grid.fdtd_grid import FDTDGrid
 from gprMax.materials import create_built_in_materials
 from gprMax.model import Model
 from gprMax.subgrids.grid import SubGridBaseGrid
 from gprMax.subgrids.user_objects import SubGridBase as SubGridUserBase
 from gprMax.user_inputs import MainGridUserInput, SubgridUserInput
+from gprMax.user_objects.cmds_singleuse import Discretisation, Domain, TimeWindow, UserObjectSingle
 
 logger = logging.getLogger(__name__)
 
diff --git a/gprMax/cmds_singleuse.py b/gprMax/user_objects/cmds_singleuse.py
similarity index 96%
rename from gprMax/cmds_singleuse.py
rename to gprMax/user_objects/cmds_singleuse.py
index e39bdf29..31611578 100644
--- a/gprMax/cmds_singleuse.py
+++ b/gprMax/user_objects/cmds_singleuse.py
@@ -25,8 +25,8 @@ from gprMax.grid.mpi_grid import MPIGrid
 from gprMax.model import Model
 from gprMax.user_inputs import MainGridUserInput
 
-from .pml import PML
-from .utilities.host_info import set_omp_threads
+from ..pml import PML
+from ..utilities.host_info import set_omp_threads
 
 logger = logging.getLogger(__name__)