diff --git a/docs/source/user_libs_antenna_patterns.rst b/docs/source/user_libs_antenna_patterns.rst index f8afea69..538fb0f0 100644 --- a/docs/source/user_libs_antenna_patterns.rst +++ b/docs/source/user_libs_antenna_patterns.rst @@ -38,7 +38,7 @@ The package has been designed to work with input files that follow the following How to use the module ===================== -* Firstly you should familiarise yourself with the example model. Edit the input file as desired and run one of the simulations (either for a E-plane or H-plane pattern). +* Firstly you should familiarise yourself with the example model input file. Edit the input file as desired and run one of the simulations for either E-plane or H-plane patterns. * Whilst the simulation is running edit the 'user configurable paramters' sections of the ``initial_save.py`` and ``plot_fields.py`` modules to match the setup of the simulation. * Once the simulation has completed, run the ``initial_save.py`` module on the output file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.initial_save antenna_like_GSSI_1500_patterns_E.out``. This will produce a Numpy file containing the field pattern data. * Plot the field pattern data by running the ``plot_fields.py`` module on the Numpy file, e.g. for the E-plane ``python -m user_libs.antenna_patterns.plot_fields antenna_like_GSSI_1500_patterns_E.npy`` @@ -48,7 +48,7 @@ How to use the module If you want to create different plots you just need to edit and re-run the ``plot_fields.py`` module on the Numpy file, i.e. you don't have to re-process the output file. -.. figure:: images/user_libs/antenna_like_GSSI_1500_pattern_E_Er5.png +.. figure:: images/user_libs/antenna_like_GSSI_1500_patterns_E_Er5.png :width: 600 px Example of the E-plane pattern from a simulation containing an antenna model similar to a GSSI 1.5 GHz antenna over a homogeneous, lossless half-space with a relative permittivity of five. \ No newline at end of file