diff --git a/docs/source/input_api.rst b/docs/source/input_api.rst index 7f569f5a..4e7273f1 100644 --- a/docs/source/input_api.rst +++ b/docs/source/input_api.rst @@ -14,9 +14,9 @@ gprMax has a choice of two methods for building a model to simulate: The Python API in gprMax allows users to access to gprMax functions directly from Python through importing the gprMax module. There are several advantages to using the API: -1. Users can take advantage of the Python language - for instance, the structural elements of Python can be utilised more easily. -2. 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, complex targets can be imported from a separate module and combined with an antenna from another module. -3. The API can interface with other Python libraries. For example, the API could be used to create a parametric antenna and the external library Scipy could then be used to optimise its parameters. +* 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, complex targets can be imported from a separate module and combined with an antenna from another module. +* The API can interface with other Python libraries. For example, the API could be used to create a parametric antenna and the external library Scipy could then be used to optimise its parameters. The syntax of the API is generally more verbose than the input file (hash) command syntax. However, for input file commands where there are an undefined number of parameters, such as adding dispersive properties, the user may find the API more manageable.