Further changes/updates towards getting sub-gridding example with GSSI 400 working.

gprMax/gprMax.py

@@ -37,6 +37,7 @@ def run(
     mpicomm=None,
     gpu=None,
     subgrid=None,
+    autotranslate=False,
     geometry_only=False,
     geometry_fixed=False,
     write_processed=False,
@@ -45,10 +46,13 @@ def run(
         programming interface (API). Run the simulation for the
         given list of scenes.
 
-    :param scenes: list of the scenes to run the model. Multiple scene objects can given in order to run multiple simulation runs. Each scene must contain the essential simulation objects
+    :param scenes: list of the scenes to run the model. Multiple scene objects
+                    can given in order to run multiple simulation runs. Each
+                    scene must contain the essential simulation objects
     :type scenes: list, optional
 
-    :param inputfile:  input file path. Can also run simulation by providing an input file.
+    :param inputfile:  input file path. Can also run simulation by providing an
+                        input file.
     :type inputfile: str, optional
 
     :param outputfile: file path to the output data file.
@@ -57,32 +61,54 @@ def run(
     :param n: number of required simulation runs.
     :type n: int, non-optional
 
-    :param task: task identifier (model number) when running simulation as a job array on open grid scheduler/grid engine. for further details see the parallel performance section of the user guide
+    :param task: task identifier (model number) when running simulation as a
+                    job array on open grid scheduler/grid engine. For further
+                    details see the parallel performance section of the User Guide.
     :type task: int, optional
 
-    :param restart: model number to start/restart simulation from. It would typically be used to restart a series of models from a specific model number, with the n argument, e.g. to restart from A-scan 45 when creating a B-scan with 60 traces
+    :param restart: model number to start/restart simulation from. It would
+                    typically be used to restart a series of models from a
+                    specific model number, with the n argument, e.g. to restart
+                    from A-scan 45 when creating a B-scan with 60 traces.
     :type restart: int, optional
 
-    :param mpi: number of Message Passing Interface (MPI) tasks, i.e. master + workers, for MPI task farm. This option is most usefully combined with n to allow individual models to be farmed out using a MPI task farm, e.g. to create a B-scan with 60 traces and use MPI to farm out each trace1. For further details see the parallel performance section of the User Guide
+    :param mpi: number of Message Passing Interface (MPI) tasks,
+                i.e. master + workers, for MPI task farm. This option is most
+                usefully combined with n to allow individual models to be farmed
+                out using a MPI task farm, e.g. to create a B-scan with 60 traces
+                and use MPI to farm out each trace1. For further details see the
+                parallel performance section of the User Guide.
     :type mpi: int, optional
 
-    :param mpi_no_spawn: flag to use MPI task farm without spawn mechanism. For further details see the parallel performance section of the User Guide.
+    :param mpi_no_spawn: flag to use MPI task farm without spawn mechanism.
+                            For further details see the parallel performance
+                            section of the User Guide.
     :type mpi_no_spawn: bool, optional
 
-    :param gpu: flag to use NVIDIA GPU or list of NVIDIA GPU device ID(s) for specific GPU card(s)
+    :param gpu: flag to use NVIDIA GPU or list of NVIDIA GPU device ID(s) for
+                specific GPU card(s).
     :type gpu: list or bool, optional
 
     :param subgrid: flag to use sub-gridding.
     :type subgrid: bool, optional
 
-    :param geometry_only: build a model and produce any geometry views but do not run the simulation.
+    :param autotranslate: for sub-gridding - auto translate objects with main grid
+                            coordinates to their equivalent local grid coordinate
+                            within the subgrid. If this option is off users must
+                            specify sub-grid object point within the global
+                            subgrid space.
+    :type autotranslate: bool, optional
+
+    :param geometry_only: build a model and produce any geometry views but do
+                            not run the simulation.
     :type geometry_only: bool, optional
 
-    :param geometry_fixed: build a model and produce any geometry views but do not run the simulation.
+    :param geometry_fixed: run a series of models where the geometry does not
+                            change between models.
     :type geometry_fixed: bool, optional
 
     :param write_processed: write another input file after any Python code and
-    in the original input file has been processed.
+                            in the original input file has been processed.
     :type write_processed: bool, optional
     """
 
@@ -101,7 +127,8 @@ def run(
     args.mpi_no_spawn = mpi_no_spawn
     args.mpicomm = mpicomm
     args.gpu = gpu
-    args.subgrid=subgrid
+    args.subgrid = subgrid
+    args.autotranslate = autotranslate
     args.geometry_only = geometry_only
     args.geometry_fixed = geometry_fixed
     args.write_processed = write_processed