From bdfb8c71fa35e3672c6edf2ca3b9cd56e92a4983 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Tue, 17 May 2016 17:54:52 +0100 Subject: [PATCH] Added some more comments. --- gprMax/gprMax.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/gprMax/gprMax.py b/gprMax/gprMax.py index 6365f41e..5747f66a 100644 --- a/gprMax/gprMax.py +++ b/gprMax/gprMax.py @@ -67,7 +67,8 @@ def main(): def api(inputfile, n=1, mpi=False, benchmark=False, geometry_only=False, geometry_fixed=False, write_processed=False, opt_taguchi=False): - """If you have installed gprMax as a module this is the entry point""" + """If installed as a module this is the entry point.""" + class ImportArguments: pass @@ -86,7 +87,12 @@ def api(inputfile, n=1, mpi=False, benchmark=False, geometry_only=False, geometr def run_main(args): - + """Top-level function that controls what mode of simulation (standard/optimsation/benchmark etc...) is run. + + Args: + args (dict): Namespace with input arguments from command line or api. + """ + numbermodelruns = args.n inputdirectory = os.path.dirname(os.path.abspath(args.inputfile)) inputfile = os.path.abspath(os.path.join(inputdirectory, os.path.basename(args.inputfile)))