diff --git a/docs/source/index.rst b/docs/source/index.rst index bd054ef8..990e32b9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,6 +17,7 @@ gprMax User Guide :caption: Using gprMax input_hash_cmds + input_api output .. toctree:: @@ -30,7 +31,6 @@ gprMax User Guide :maxdepth: 2 :caption: Advanced topics - input_api python_scripting openmp_mpi gpu diff --git a/docs/source/input_api.rst b/docs/source/input_api.rst index 12303ab9..93c68c8c 100644 --- a/docs/source/input_api.rst +++ b/docs/source/input_api.rst @@ -1,11 +1,11 @@ .. _api: -******************* -API -******************* +**************** +Input file - API +**************** Introduction -================== +============ In additional to input file command interface gprMax can also be run using its API. The usage of the API differs from the use of the Python blocks syntax as follows. In the API gprMax functionality is called directly from any Python file via the gprMax module. Using the Python blocks syntax the Python code is executed within an embedded interpreter. The API has the advantage that it can be included within any Python file and can be included within any Python script. There are several advantages to using API. Firstly, users can take advantage of the Python language. For instance, the structural elements of Python can be utilised more easily. gprMax objects can be used directly within functions, classes, modules and packages. In this way collections of components can be defined, reused and modified. For example, multiple SMA type connectors can be imported as a module and combined with an antenna from another module. diff --git a/docs/source/input_hash_cmds.rst b/docs/source/input_hash_cmds.rst index b3646dc1..68de6a6e 100644 --- a/docs/source/input_hash_cmds.rst +++ b/docs/source/input_hash_cmds.rst @@ -1,8 +1,8 @@ .. _commands: -******************* -Input file commands -******************* +********************* +Input file - commands +********************* An input file has to be supplied to gprMax which should contain all the necessary information to run a GPR model. The input file is an ASCII text file which can be prepared with any text editor or word-processing program. In the input file the hash character (``#``) is reserved and is used to denote the beginning of a command which will be passed to gprMax. The general syntax of commands is: