Make geophires_monte_carlo callable with CLI with path correction. Includes example usage in MC user manual

Author: softwareengineerprogrammer

docs/Monte-Carlo-User-Guide.md

@@ -109,6 +109,12 @@ bin edges: [-43.34   -43.2258 -43.1116 -42.9974 -42.8832 -42.769  -42.6548 -42.5
 
 ```
 
+You may also run from the command line:
+
+```
+python -mgeophires_monte_carlo GEOPHIRESv3.py GEOPHIRES-example1.txt MC_GEOPHIRES_Settings_file.txt MC_GEOPHIRES_Result.txt
+```
+
 ## Documentation
 
 See [module documentation](reference/geophires_monte_carlo.html)

src/geophires_monte_carlo/MC_GeoPHIRES3.py

@@ -240,11 +240,6 @@ def main(command_line_args=None):
     # keep track of execution time
     tic = time.time()
 
-    # set the starting directory to be the directory that this file is in
-    working_dir = os.path.dirname(os.path.abspath(__file__))
-    os.chdir(working_dir)
-    working_dir = working_dir + os.sep
-
     # get the values off the command line
     parser = argparse.ArgumentParser()
     parser.add_argument('Code_File', help='Code File')
@@ -268,7 +263,11 @@ def main(command_line_args=None):
     inputs = []
     outputs = []
     iterations = 0
-    output_file = args.MC_OUTPUT_FILE if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None else ''
+    output_file = (
+        args.MC_OUTPUT_FILE
+        if 'MC_OUTPUT_FILE' in args and args.MC_OUTPUT_FILE is not None
+        else str(Path(Path(args.Input_file).parent, 'MC_Result.txt').absolute())
+    )
     python_path = 'python'
 
     for line in flist:
@@ -312,6 +311,11 @@ def main(command_line_args=None):
     with open(output_file, 'w') as f:
         f.write(s)
 
+    # set the starting directory to be the directory that this file is in
+    working_dir = os.path.dirname(os.path.abspath(__file__))
+    os.chdir(working_dir)
+    working_dir = working_dir + os.sep
+
     # build the args list
     pass_list = [inputs, outputs, args, output_file, working_dir, python_path]  # this list never changes
 

src/geophires_monte_carlo/__main__.py

@@ -0,0 +1,29 @@
+import os
+import sys
+from pathlib import Path
+
+from geophires_monte_carlo import MC_GeoPHIRES3
+from geophires_monte_carlo import common
+
+if __name__ == '__main__':
+    log = common._get_logger()
+    stash_cwd = Path.cwd()
+
+    try:
+        command_line_args = []
+        for i in range(len(sys.argv[1:])):
+            arg = sys.argv[i + 1]
+            if Path(arg).exists():
+                arg = str(Path(arg).absolute())
+                log.info(f'Converted arg to absolute path: {arg}')
+
+            command_line_args.append(arg)
+
+        MC_GeoPHIRES3.main(command_line_args=command_line_args)
+    except Exception as e:
+        raise RuntimeError(f'Monte Carlo encountered an exception: {e!s}') from e
+    except SystemExit:
+        raise RuntimeError('Monte Carlo exited without giving a reason') from None
+    finally:
+        # Undo MC internal global settings changes
+        os.chdir(stash_cwd)

tests/.gitignore

@@ -1,2 +1,5 @@
 HIP.out
 *.log
+MC_Result.json
+MC_Result.txt
+*.png