Commit ecc71c5b authored by Andrew Senior's avatar Andrew Senior

Updated installation documentation to describe using nec2c.

parent 689d897f
......@@ -22,15 +22,42 @@ e.g. <code>/usr/local/bin/erpmodel</code>. The software can then be started
simply by typing <code>erpmodel</code> at the shell prompt.</p>
<h2>NEC installation</h2>
<p>The software uses NEC (Numerical Electromagnetics Code) as its model engine.
Two different versions of NEC are supported:
<ul>
<li>The Debian/Ubuntu version based on the original Fortran source</li>
<li>A C translation of the original known as <code>nec2c</code></li>
</ul>
You may choose which model engine is used during the setup procedure after
installation, as described below. It is possible to change between model engines
by editing the configuration file.</p>
<h3>nec2c (the easy way?)</h3>
<p>On Debian/Ubuntu systems, <code>nec2c</code> may be installed using the
system package manager in the normal way, e.g.
<pre>
<code>sudo apt-get install nec2c</code>
</pre>
Unlike the <code>nec2</code> package, <code>nec2c</code> does not require any
patching to work. This makes installation much easier. <strong>However, the
version of <code>nec2c</code> supplied with Ubuntu 14.04 runs very slowly
compared to the Fortran-based version </strong> (this may be due to an error in
the Debian package that means it is built without optimisation).
If this is a problem for you, you can build nec2c from source yourself and
point the ERP model software at the binary by editing the
<code>nec2c_bin</code> line in the configuration file.
Instructions on building nec2c are not included here.</p>
<h3>The Debian/Ubuntu NEC</h3>
<p>The software is designed to work with the version of NEC from the Debian/
Ubuntu <code>nec</code> package. Unfortunately the standard version of this
package does not permit enough sources to be applied to the antenna structure to
model the HF heating arrays. A patch is supplied in the <code>nec-patch</code>
subdirectory of the ERP model installation.</p>
<h3>Obtaining the NEC source code</h3>
<h4>Obtaining the NEC source code</h4>
<h4>Debian/Ubuntu-based systems</h4>
<h5>Debian/Ubuntu-based systems</h5>
<p>If you are running Debian or Ubuntu or a distribution derived from them,
first install the <code>nec</code> <em>source</em> package into a location of
......@@ -45,7 +72,7 @@ repositories before you can do this and you may need to install some other
packages so that <code>apt-get</code> can correctly set up the source (you
should receive a warning message if this is the case).</p>
<h4>Distributions lacking the <code>nec</code> package</h4>
<h5>Distributions lacking the <code>nec</code> package</h5>
<p>Recent Ubuntu distributions (e.g. 16.04) and non-Debian/Ubuntu based
distributions do not have the <code>nec</code> package or if they do it may not
......@@ -72,7 +99,7 @@ original source code and apply the Debian patch
You may see a warning from <code>patch</code> about patching a read-only file;
this is normal.<p>
<h3>Applying the patch</h3>
<h4>Applying the patch</h4>
<p>You can now apply the patch in the following way
<pre>
......@@ -92,6 +119,8 @@ do <code>make install</code> after running <code>make</code>. Indeed, doing so
would be inadvisable if you already have the <code>nec</code> package installed
for some other purpose.</p>
<h2>Setup</h2>
<p>After installation, the first time a user runs the software, they will be
prompted to configure it by specifying the location of various files such as
......@@ -102,6 +131,11 @@ individually for each user.</p>
<p>If you installed the NEC software according to the instructions above, the
path to the NEC excutable will be
<code>/path/of/your/choice/nec-2/nec/nec2</code></p>
<p>If you choose to use <code>nec2c</code>, it is assumed that the
<code>nec2c</code> executable is already on your search path (i.e. you can run
it by typing <code>nec2c</code> at the shell prompt). If this is not the case,
you must manually edit the configuration file (see below) and set the
<code>nec2c_bin</code> line appropriately.
<h3>Manual Configuration</h3>
<p>If you made a mistake during the setup process or you later need to change
......@@ -135,10 +169,13 @@ on 5.423 MHz using Array 1.</p>
important being <code>*** running NEC2 ***</code>. This message should be
followed some time later by the message
<code>*** NEC2 completed successfully ***</code>. This may take several minutes
depending on the speed of your computer. If you see an error message instead
then this probably means that something is wrong with your NEC installation.
Make sure that you set the correct path to the NEC executable during the
setup process. If necessary, edit the configuration file to change the path.</p>
depending on the speed of your computer and may be especially slow if you are
using <code>nec2c</code> which has been built without optimisation (e.g. it
takes about 9 minutes on an Intel Core i5 650 at 3.2 GHz!). If you see an error
message instead then this probably means that something is wrong with your NEC
installation. Make sure that you set the correct path to the NEC executable
during the setup process. If necessary, edit the configuration file to change
the path.</p>
<p>When the modelling is complete, a plot will appear on the screen. A PDF
file of the plot will be created in your "plots" directory and a ZIP file
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment