From 778d123a03eb799da463e996c1a8255e1f5ea5ae Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Thu, 30 Mar 2023 10:54:50 +0100 Subject: [PATCH] Updated intro paras --- docs/source/input_api.rst | 6 ++---- docs/source/input_hash_cmds.rst | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/source/input_api.rst b/docs/source/input_api.rst index ec224e16..68f7a224 100644 --- a/docs/source/input_api.rst +++ b/docs/source/input_api.rst @@ -9,10 +9,8 @@ Introduction gprMax has a choice of two methods for building a model to simulate: -1. A **text-based (ASCII) input file**, which can be created with any text editor, and uses a series of gprMax commands which begin with the hash character (``#``). -2. A **Python API**, which includes all the functionality of method 1 as well as several more advanced features. - -Beginners and those not familiar with Python are encouraged to use method 1 (text-based input file) which is described in the :ref:`` section. +1. A **text-based (ASCII) input file**, which can be created with any text editor, and uses a series of gprMax commands which begin with the hash character (``#``). This method is recommended for beginners and those not familiar with Python, and is described in the :ref:`input_hash_cmds` section. +2. A **Python API**, which includes all the functionality of method 1 as well as several more advanced features. This method is recommended for those who prefer to use Python or need access to specific API-only advanced features, and is described in this section of the documentation. 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: diff --git a/docs/source/input_hash_cmds.rst b/docs/source/input_hash_cmds.rst index 7274cfa0..48034da0 100644 --- a/docs/source/input_hash_cmds.rst +++ b/docs/source/input_hash_cmds.rst @@ -9,10 +9,8 @@ Introduction gprMax has a choice of two methods for building a model to simulate: -1. A **text-based (ASCII) input file**, which can be created with any text editor, and uses a series of gprMax commands which begin with the hash character (``#``). -2. A **Python API**, which includes all the functionality of method 1 as well as several more advanced features. - -Beginners and those not familiar with Python are encouraged to use method 1 (text-based input file) which is described in this section of the documentation. For those who prefer to use Python or want to access some of the advanced features you will find those documented in the :ref:`` section. +1. A **text-based (ASCII) input file**, which can be created with any text editor, and uses a series of gprMax commands which begin with the hash character (``#``). This method is recommended for beginners and those not familiar with Python, and is described in this section of the documentation. +2. A **Python API**, which includes all the functionality of method 1 as well as several more advanced features. This method is recommended for those who prefer to use Python or need access to specific API-only advanced features. The Python API is documented in the :ref:`input_api` section. The general syntax of the hash commands is: