installation.html 5.03 KB
Newer Older
Andrew Senior's avatar
Andrew Senior committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
<html>
<head>
<title>Installation: EISCAT Heater ERP model</title>
<link rel="stylesheet" type="text/css" href="heatererp.css" />
</head>
<h1>Installation</h1>
<p>If the software was obtained from the <em>git</em> repository then it will
be located in the directory where it was put by <code>git clone</code> and
should contain the following directory structure
<pre>
<code>/some/path/doc -- this documentation</code>
<code>          /bin -- binary/executable/script files</code>
<code>          /octave -- Octave source files</code>
<code>          /nec-patch -- patch for Debian/Ubuntu nec package</code>
</pre>
where <code>/some/path</code> is the directory it was cloned into.</p>

<p>In the <code>bin</code> directory is a shell script, <code>erpmodel.sh</code>
, which is used to start the software. You should create a symbolic link to
this file somewhere on your shell's search path,
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 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>

<p>If you are running Debian or Ubuntu, first install the <code>nec</code>
 <em>source</em> package into a location of your choice by doing
<pre>
<code>cd /path/of/your/choice</code>
<code>apt-get source nec</code>
</pre>
This will install the NEC source in the directory
<code>/path/of/your/choice</code>. 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>

<p>You can now apply the patch in the following way
<pre>
<code>cd /path/of/your/choice/nec-2</code>
<code>patch -p1 &lt; /some/path/nec-patch/NEC-PATCH</code>
</pre>
where <code>/some/path</code> is the path where the ERP model software was
installed above. Finally, the NEC software should be built using
<pre>
<code>make</code>
</pre>
You may have to install the <code>f2c</code> package in order to build the
NEC code.</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
the transmitter logs, the antenna array model files, where plots and results
should be stored and the path to the NEC executable. These settings are stored
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>

66 67 68 69 70 71 72 73 74 75
<h3>Manual Configuration</h3>
<p>If you made a mistake during the setup process or you later need to change
the location where the software stores results, you can edit the configuration
file. The file is <code>$HOME/.config/heatererp/conf.m</code> where
<code>$HOME</code> is your home directory. The file is actually an Octave
script that sets the values of certain variables to indicate the path to the
NEC executable, where to find and store files, etc. For example, to change the
path to the NEC executable, edit the definition of the variable <code>
nec2_bin</code>.</p>

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
<h2>Testing</h2>
<p>To check that your installation is working, a sample log file containing a
synthetic test case is provided. This is located in the <code>testing</code>
subdirectory of the directory where you installed the model. The file is
called <code>1970-01-01_tx.log</code>.</p>

<p>Copy this file to (or make a symlink to it in) your log file directory which
you configured during the setup process. Then start the model by giving the
<code>erpmodel</code> command at the shell prompt (assuming you installed it
as described above). Then at the Octave prompt, give this command
<pre>
<code>erpmodel('01-Jan-1970 00:00:00')</code>
</pre>
This will run the model for a hypothetical case where all the transmitters
are used with identical power and perfect phasing to generate a vertical beam
on 5.423 MHz using Array 1.</p>

93 94 95 96 97 98 99 100 101
<p>A number of messages will appear in the Octave terminal window, the most
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>

102 103 104 105 106 107 108
<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
containing the full NEC-2 model output will be created in your "results"
directory.</p>

<hr>
<p><a href="index.html">Contents</a></p>
Andrew Senior's avatar
Andrew Senior committed
109 110 111 112
<body>
</body>
</html>