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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
|
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appversion "0.22">
<!ENTITY manrevision "0.2">
<!ENTITY date "February 2016">
<!ENTITY app "<application>voacapgui</application>">
<!ENTITY appname "voacapgui">
]>
<!--
Maintained by the GNOME Documentation Project
http://live.gnome.org/DocumentationProject
Template version: 3.0 beta
Template last modified 2006-11-21
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<articleinfo>
<title>&app; Manual</title>
<abstract role="description">
<para>&app; provides a Graphical User Interface to the VOACAP
HF propagation prediction application.</para>
</abstract>
<copyright>
<year>2014-2020</year>
<holder>J.Watson</holder>
</copyright>
<!-- An address can be added to the publisher information. -->
<publisher role="maintainer">
<publishername>J.Watson</publishername>
</publisher>
<!-- <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> -->
<!-- The file legal.xml contains link to license for the documentation,
and other legal stuff such as "NO WARRANTY" statement.
Please do not change any of this. -->
&legal;
<authorgroup>
<author role="maintainer">
<firstname>James</firstname>
<surname>Watson</surname>
</author>
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
<!-- Remember to remove the &manrevision; entity from the revision entries other
-->
<!-- than the current revision. -->
<!-- The revision numbering system for GNOME manuals is as follows: -->
<!-- * the revision number consists of two components -->
<!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
<!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
<!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
<!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
<!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
<!-- to V3.0, and so on. -->
<revhistory>
<revision>
<revnumber>v&manrevision;</revnumber>
<date>2016-02-01</date>
<revdescription>
<para role="author">J.Watson
<email>jwatson@neomailbox.ch</email>
</para>
<!--<para role="publisher">GNOME Documentation Project</para>-->
</revdescription>
</revision>
</revhistory>
<releaseinfo>This manual describes version &appversion; of &app;.
</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>To report a bug or make a suggestion regarding &app; application or
this manual, please contact the author.
</para>
<!-- Translators may also add here feedback address for translations -->
</legalnotice>
</articleinfo>
<indexterm zone="index">
<primary>voacapgui</primary>
</indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<!-- Use the Introduction section to give a brief overview of what
the application is and what it does. -->
<sect1 id="introduction">
<title>Introduction</title>
<para>&app; is a front end to the VOACAP engine and may be used to;</para>
<itemizedlist>
<listitem>
<para>Produce HF propagation predictions between two fixed locations (Point-to-Point / P2P mode).</para>
</listitem>
<listitem>
<para>Produce HF propagation plots over a user defined area from a fixed transmit site (Area Mode).</para>
</listitem>
</itemizedlist>
<note>
<para>voacapgui requires a working copy of the VOACAP engine installed
on the host machine. Installation of VOACAP is beyond the scope of
this manual.</para>
</note>
</sect1>
<sect1 id="installation">
<title>Installation</title>
<sect2>
<title>Desktop File</title>
<para>Run the update-desktop-database application to rebuild the desktop
file database.</para>
</sect2>
<sect2>
<title>Icon</title>
<para>The Gnome desktop looks for icons in the selected theme directory of
/usr/share/icons/. Copy the the icon into /usr/share/icons/hicolor/48x48/apps/.
</para>
<para>Run gtk-update-icon-cache to update the icon database.</para>
</sect2>
</sect1>
<!-- =========== Getting Started ============================== -->
<!-- Use the Getting Started section to describe the steps required
to start the application and to describe the user interface components
of the application. If there is other information that it is important
for readers to know before they start using the application, you should
also include this information here.
If the information about how to get started is very short, you can
include it in the Introduction and omit this section. -->
<sect1 id="voacapgui-getting-started">
<title>Getting Started</title>
<sect2 id="voacapgui-start">
<title>Starting &app;</title>
<para>You can start &app; in the following ways:
</para>
<variablelist>
<varlistentry>
<term><guimenu>Applications</guimenu> menu</term>
<listitem>
<para>Choose
<menuchoice>
<guisubmenu>Submenu Name </guisubmenu>
<guimenuitem>&app;</guimenuitem>
</menuchoice>. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command line</term>
<listitem>
<para>To start &app; from a command line, type the following
command, then press <keycap>Return</keycap>:</para>
<para>
<command>&app;</command>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="voacapgui-when-start">
<title>When You Start &app;</title>
<para>When you start &app;, the following window is displayed.</para>
<!-- ==== Figure ==== -->
<figure id="mainwindow-fig">
<title>&app; Start Up Window</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/main_window.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
<!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
<para>The &app; window contains the following elements:
</para>
<variablelist>
<varlistentry>
<term>Menubar</term>
<listitem>
<para>The menu contains submenus alowing users to quit the
application and access the help documentation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tabbed Notebook</term>
<listitem>
<para> The tabs are divided into functional sections and most
users will enter the required input data working left to
right along the tabs.
<variablelist>
<varlistentry>
<term><guimenu>Applications</guimenu> Tab</term>
<listitem>
<para>Used to define the geographic location of sites and
associated properties (transmitter power, antennas etc.).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Applications</guimenu> Tab</term>
<listitem>
<para>Used to define the geographic location of sites and
associated properties (transmitter power, antennas etc.).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>P2P</guimenu> Tab</term>
<listitem>
<para>Used to define parameters unique to Point-to-Point
predictions.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Area</guimenu> Tab</term>
<listitem>
<para>Used to define parameters unique to Area
predictions.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>System</guimenu> Tab</term>
<listitem>
<para>Used to define the common system parameters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>SSN</guimenu> Tab</term>
<listitem>
<para>Used to define the Sun Spot Numbers (SSN) used
by the VOACAP prediction engine.
</para>
</listitem>
</varlistentry>
</variablelist> </para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<!-- ================ Usage ================================ -->
<!-- Use this section to describe how to use the application to perform the tasks for which the application is designed.
If this section runs to more than a few screens in Yelp, consider splitting it into several top-level sections.
-->
<sect1 id="voacapgui-usage">
<title>Usage</title>
<para>You can use the &app; application to
perform the following tasks:
<itemizedlist>
<listitem>
<para>
Produce Point-to-Point Predictions <xref linkend="voacapgui-p2p"/></para>
</listitem>
<listitem>
<para>
Produce Area Plots <xref linkend="voacapgui-area"/></para>
</listitem>
</itemizedlist> </para>
<!-- ================ Usage Subsection ================================ -->
<sect2 id="voacapgui-p2p">
<title>VOACAP Point-to-Point Predictions</title>
<para>To perform a P2P prediction, select the
<guimenu>Site</guimenu> tab in the notebook and click the
<guibutton>Site</guibutton> button in the
<guilabel>Tx. Site</guilabel>
panel to open the Site Chooser dialog window.</para>
<!-- ==== Figure ==== -->
<figure id="fig-site-chooser">
<title>&app; Site Chooser</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/site_chooser.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>Sites may be defined
by either;
<itemizedlist>
<listitem><para>Clicking on the map.</para></listitem>
<listitem><para>Using the Locator combo boxes.</para></listitem>
<listitem><para>Entering latitude and longitude directly into the
<guilabel>Lat:</guilabel> and <guilabel>Lon:</guilabel> text entry
fields.</para></listitem>
<listitem><para>Selecting from a list of predefined sites acessed by
clicking the <guilabel>Select From File</guilabel> expander.</para></listitem>
</itemizedlist>
Once the required site information has been entered, click the
<guibutton>OK</guibutton> to close the Site Chooser dialog and
return to the main window.
</para>
<para>Antenna Selection is made by clicking the
<guibutton>Antenna</guibutton> button to open the Antenna Chooser
dialog window.</para>
<!-- ==== Figure ==== -->
<figure id="fig-antenna-chooser">
<title>&app; Antenna Chooser</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/antenna_chooser.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>Specific antenna models may be selected by browsing
through the available models by clicking on the expander buttons in
the left panel. Click the <guibutton>OK</guibutton> button to accept
the selected antenna and return to the main window.
</para>
<para>The bearing of the antenna is defined in the bearing text entry
and may be either entered directly or directed to the Rx. Site by
clicking the <guibutton>Bearing</guibutton> button.
</para>
<para>The transmitter power (in Watts) is then entered using the
<guilabel>Power (W)</guilabel> entry field.
</para>
<para>Site data for the receive site may then be entered in the
<guilabel>Rx. Site</guilabel> panel.
</para>
<tip><para>After entering the receive site coordinate, it may be
necessary to click the <guibutton>Bearing</guibutton> button
in the <guilabel>Tx. Site</guilabel> panel to redirect the
transmit antenna to the newly defined receive site.</para>
</tip>
<para>Click the <guimenu>P2P</guimenu> tab to move to the
Point-to-Point panel to define the predictions to be
performed.</para>
<!-- ==== Figure ==== -->
<figure id="fig-p2p-tab">
<title>&app; P2P Notebook Tab</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/p2p_tab.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>Define the time for the prediction by specifying a year and
month in the <guilabel>Year</guilabel> and <guilabel>Month</guilabel>
entry fields respectively. If required, a day may also be specified
by selecting the <guilabel>Use Day</guilabel> checkbox and entering a
day value in the <guilabel>Day</guilabel> entry field.</para>
<caution><para>Enabling the Days value will force the VOACAP engine
to use the URSI88 coefficients instead of the preferred CCIR
values.</para></caution>
<sect3>
<title>Cicuit Calculations</title>
<para>The default behavior of voacapgui is to produce graphical
output showing the performance of frequencies in the range
2-30MHz over a 24 hour period. While this may be useful for
most applications, text based 'cicuit' predictions may be
used when an analysis of performance at spot frequencies
is required</para>
<para>To enable circuit predictions, click the
<guilabel>Circuit</guilabel> checkbox and use the
<guilabel>Frequency</guilabel> entry panel and associated
<guibutton>Add</guibutton> button to populate the frequency
table</para>
</sect3>
<para>Select the method from the <guilabel>Method</guilabel> combo
box at the bottom of the entry panel</para>
<tip><para>Most users will want to select method 30, 'Complete
System Performance'</para></tip>
</sect2>
<sect2>
<title>Displaying the results</title>
<para>Results of circuit mode calculations are displayed directly in
a text dialog.</para>
<para>In the case of graphical reults, the
<guilabel>Plot Control</guilabel> opens and offers the following
selections;
<!-- ==== Figure ==== -->
<figure id="p2p-plotconfig">
<title>&app; P2P Plot Configuration</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/p2p_plot_configure.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<variablelist>
<varlistentry>
<term><guilabel>Plot Type</guilabel></term>
<listitem><para>Specify the
data to be displayed behind the MUF / FOT curves. Available
data sets are Reliability, MUFday, DBW, SNR and none.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Group</guilabel></term>
<listitem><para>Specify the SSN groups to plot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Timezone</guilabel></term>
<listitem><para>Specify a timezone to shift the plotted data
to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>colour Map</guilabel></term>
<listitem><para>Specify the colour map to use for plotting the
background data set.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>Click the <guibutton>OK</guibutton> button to open the image
file.</para>
</sect2>
<!-- ================ Usage Subsection ================================ -->
<sect2 id="voacapgui-area">
<title>VOACAP Area Predictions</title>
<para>To perform an area prediction, select the
<guimenu>Site</guimenu> tab in the notebook and click the
<guibutton>Site</guibutton> in the <guilabel>Tx. Site</guilabel>
panel to open the Site Chooser dialog window.</para>
<para> Sites may be defined by either;
<itemizedlist>
<listitem><para>Clicking on the map.</para></listitem>
<listitem><para>Using the Locator combo boxes.</para></listitem>
<listitem><para>Entering latitude and longitude directly into the
<guilabel>Lat:</guilabel> and <guilabel>Lon:</guilabel> text entry
fields.</para></listitem>
<listitem><para>Selecting from a list of predefined sites acessed by
clicking the <guilabel>Select From File</guilabel> expander.</para></listitem>
</itemizedlist>
Once the required site information has been entered, click the
<guibutton>OK</guibutton> to close the Site Chooser dialog and
return to the main window.
</para>
<para>Antenna Selection is made by clicking the
<guibutton>Antenna</guibutton> button to open the Antenna Chooser
dialog window. Specific antenna models may be selected by browsing
through the available models by clicking on the expander buttons in
the left panel. Click the <guibutton>OK</guibutton> button to accept
the selected antenna and return to the main window.
</para>
<para>The bearing of the antenna is defined in the bearing text entry
and may be either entered directly or directed to the Rx. Site by
clicking the <guibutton>Bearing</guibutton> button.
</para>
<para>The transmitter power (in Watts) is then entered using the
<guilabel>Power (W)</guilabel> entry field.
</para>
<para>Details of the receive antenna then be entered in the
<guilabel>Rx. Site</guilabel> panel.
</para>
<note>When performing area calculations only the receive site
antenna definition is used. All other information in the
<guilabel>Rx Site</guilabel> is ignored.
</note>
<para>Click the <guimenu>Area</guimenu> tab to move to the
<guilabel>Area</guilabel> panel to define the predictions to be
performed.</para>
<!-- ==== Figure ==== -->
<figure id="fig-area-tab">
<title>&app; Area Tab</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/area_tab.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>Define the time for the prediction by specifying a year and
month in the <guilabel>Year</guilabel> and <guilabel>Month</guilabel>
entry fields respectively.</para>
<para>Define the frequency of operation for the prediction in the
<guilabel>Freq</guilabel> text entry then click the
<guibutton>Add</guibutton> button to add the selected values to the
main panel. Additional plots may be defined by selecting required
<guilabel>Year</guilabel>, <guilabel>Month</guilabel>
<guilabel>UTC</guilabel> and <guilabel>Freq</guilabel> values and
adding them to the main panel with the <guibutton>Add</guibutton>.
</para>
<para>Click the <guibutton>Area</guibutton> button to open the
<guilabel>Area Chooser</guilabel> dialog panel which supports
defining the receive area in two ways;
<itemizedlist>
<listitem>
<para>Dragging the cursor across the map.</para>
</listitem>
<listitem>
<para>Entering values for the North East corner and South
West corners directly into the entry fields.</para>
</listitem>
</itemizedlist>
Click the <guibutton>OK</guibutton> to accept the displayed values
and return to the main window.
</para>
<para>Select the required grid size from the
<guilabel>Gridsize</guilabel> entry and start the prediction by
clicking the <guibutton>Execute</guibutton> button.
</para>
<tip>
<para>The VOACAP <code>GRID</code> parameter specifies a grid overlayed
onto the specifed coverage area. Predictions are performed
at each intersection within the grid. Large <code>GRID</code> values
are used to produce print quality plots but at teh expennse of
computing time. Users amy find it better to specify a small grid
size for initial runs to check that the inputs are correct prior
to setting higher values for final printing.
</para>
</tip>
</sect2>
<sect2>
<title>Displaying the Area Results</title>
<para>The <guilabel>Plot Control</guilabel> dialog is opened
as soon as the prediction calculations are complete and
offers the following
selections;
<!-- ==== Figure ==== -->
<figure id="area-plotconfig">
<title>&app; Area Plot Configuration</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/area_plot_configure.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<variablelist>
<varlistentry>
<term><guilabel>Plot Type</guilabel></term>
<listitem><para>Specify the
data to be displayed behind the MUF / FOT curves. Available
data sets are Reliability, MUFday, DBW, SNR and none.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Group</guilabel></term>
<listitem><para>Specify the SSN groups to plot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Timezone</guilabel></term>
<listitem><para>Specify a timezone to shift the plotted data
to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Colour Map</guilabel></term>
<listitem><para>Specify the colour map to use for plotting the
background data set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Contours</guilabel></term>
<listitem><para>Produces a filled contour plot.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Greyline</guilabel></term>
<listitem><para>Controls the plotting of a greyline on the area
map.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Parallels</guilabel></term>
<listitem><para>Controls the plotting of paralells on the area
map.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Meridians</guilabel></term>
<listitem><para>Controls the plotting of meridians on the area
map.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>Prediction data may be stored in a '.vgz' file; a zip file
containing the source .voa file along with the output .vg_ files.
These files may be saved and retreived using the File Open VGA File
menu item.</para>
<para>Click the <guibutton>OK</guibutton> button to open the area plot
image.</para>
</sect2>
</sect1>
<!-- ============= Customization ============================= -->
<!-- Use this section to describe how to customize the application. -->
<sect1 id="voacapgui-prefs">
<title>System Settings</title>
<itemizedlist>
<listitem>
<para>
<xref linkend="voacapgui-system"/>System</para>
</listitem>
<listitem>
<para>
<xref linkend="voacapgui-ssn"/>SSN</para>
</listitem>
</itemizedlist>
<!-- =============== Customization Subsection ================ -->
<!-- Use a new section to describe different tabbed sections on the Preferences
dialog. -->
<sect2 id="voacapgui-system">
<title>System Settings</title>
The <guilabel>System</guilabel> Notebook Tab is used to define
a number of system side VOACAP parameters.
<!-- ==== Figure ==== -->
<figure id="system-tab">
<title>&app; System Tab</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/system_tab.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<variablelist>
<varlistentry>
<term><guilabel>Man-Made Noise</guilabel></term>
<listitem>
<para>This is an important parameter, used to characterise
the level of man-made noise at the receive location.</para>
<para>Valid values are in the range 100-200 -dBw/Hz</para>
<informaltable frame='none' rowsep='0' colsep='0'>
<tgroup cols='2'>
<colspec colwidth='15mm'/>
<colspec colwidth='60mm'/>
<thead>
<row>
<entry>dBW/Hz</entry><entry>Environment</entry>
</row>
</thead>
<tbody>
<row><entry>-164.1</entry><entry>Remote</entry></row>
<row><entry>-152.7</entry><entry>Quiet</entry></row>
<row><entry>-150.0</entry><entry>Rural</entry></row>
<row><entry>-144.7</entry><entry>Residential</entry></row>
<row><entry>-140.4</entry><entry>Industrial</entry></row>
<row><entry>-138.7</entry><entry>Noisy</entry></row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Min. Take-Off Angle</guilabel></term>
<listitem>
<para>This value is normally very small unless antenna performance
is anticipated to be so poor at low angles that these angles
should not be used in the estimation of upper useful frequencies,
or if the horizon is so obstructed that low take off angles and
reception angles appear unlikely.</para>
<para>Valid values are in the rangle 0.1 - 90.0 degrees</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Reliability</guilabel></term>
<listitem>
<para>An estimate of the percent of days within a month that the
signal quality will meet the level defined by the
<guilabel>Required SNR</guilabel> parameter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Required SNR (dB/Hz)</guilabel></term>
<listitem>
<para>An important parameter used to specify the required
Signal-to-Noise ratio of the hourly median power relative
to the hourly median noise in a 1Hz bandwidth.</para>
<para>Typical values of Required SNR are;</para>
<informaltable frame='none' border='none' colsep='0' rowsep='0'>
<tgroup cols='2'>
<colspec colwidth='15mm'/>
<colspec colwidth='60mm'/>
<thead>
<row>
<entry>dB/Hz</entry><entry>Traffic</entry>
</row>
</thead>
<tbody>
<row><entry>45.0</entry><entry>Voice / 600bps Data</entry></row>
<row><entry>47.0</entry><entry>Voice / 1200bps Data</entry></row>
<row><entry>49.0</entry><entry>Voice / 2400bps Data</entry></row>
<row><entry>52.0</entry><entry>4800 bps MIL-STD-110B Data</entry></row>
<row><entry>63.0</entry><entry>9600 bps MIL-STD-110B Data</entry></row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Multipath Tolerance</guilabel></term>
<listitem>
<para>Specifies the maximum difference in power between the
sky-wave modes to permit satisfactory system peformance
in the presence of multiple signals. Modes weaker than the
specified level are not considered multipath problems.</para>
<para>The valid range is 0-40dB (Default = 3.dB)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Max Delay (mS)</guilabel></term>
<listitem>
<para>Specifies the maximum tolerable delay in between sky-wave
modes to permit satisfactory system performance in the
presence of multiple signals. Modes within the specified linit
are not considered multipath problems.</para>
<para>The valid range is 0-99.99 mSec (Default = 10.00 mSec)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Ionospheric Variables foE, foF1, foF2, foEs</guilabel></term>
<listitem>
<para>Multipliers that adjust the predicted critical frequency
for the associated layer.</para>
<para>Default values for foE, foF1 & foF2 are 1.0,
foEs = 0.0</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Model</guilabel></term>
<listitem>
<para>Define the coefficients used for the calculations</para>
<para>Default is CCIR</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Path</guilabel></term>
<listitem>
<para>Specifies if a long or short path calaculation should
be performed.</para>
<para>Default: Short</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<!-- ============= Customization Subsection ===================== -->
<!-- Another tabbed section on the Preferences dialog. -->
<sect2 id="voacapgui-ssn">
<title>Sun Spot Numbers (SSN)</title>
<para>This tab is used to display the Sun Spot Numers (SSN) read by
voacapgui and passed to VOACAP.</para>
<!-- ==== Figure ==== -->
<figure id="fig-ssn-tab">
<title>&app; SSN Tab</title>
<screenshot>
<mediaobject>
<imageobject><imagedata
fileref="figures/ssn_tab.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Shows &app; main window. Contains titlebar,
menubar, tabbed area, Settings, and
Help menus. </phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<!-- ==== End of Figure ==== -->
<para>The information is derived from data
published by NOAA and made available at <ulink url="ftp://ftp.ngdc.noaa.gov/STP/space-weather/solar-data/solar-indices/sunspot-numbers/predicted/table_international-sunspot-numbers_monthly-predicted.txt" type="ftp">
ftp://ftp.ngdc.noaa.gov/STP/space-weather/solar-data/solar-indices/sunspot-numbers/predicted/table_international-sunspot-numbers_monthly-predicted.txt </ulink>. </para>
<para>The <guibutton>Web Update</guibutton> may be used to updated the
table (requires an Internet connection). Alternatively, a copy of the
<filename>table_international-sunspot-numbers_monthly-predicted.txt</filename>
file can be placed in the user's <filename>~/.voacapgui</filename> directory.
</para>
</sect2>
</sect1>
<sect1 id="templates">
<title>Templates</title>
<para>Voacapgui supports the use of templates to facilte the prepation
of repeated input data. </para>
<para>Each file must implement only one class named "templates" which
can implement one or more templates.</para>
<para> The "templates" class has to define the following methods:</para>
<variablelist>
<varlistentry>
<term>__init__(self, parent)</term>
<listitem>
<para>parent is the parent window in case a dialog has to be
used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>get_names(self)</term>
<listitem>return a list of the names of the templates</listitem>
</varlistentry>
<varlistentry>
<term>get_params(self)</term>
<listitem>Return a list of strings with properties the caller
should set on the object. For example, for getting the parent
property "prop" set in the templates object scope, this
function must return ['prop'].
</listitem>
</varlistentry>
<varlistentry>
<term>load(self)</term>
<listitem>This is the last step performed by the caller prior
to read the names of the templates implemented. This method
should do the minimum amount of work because is always called
in program start, not upon template usage.
</listitem>
</varlistentry>
<varlistentry>
<term>set_ini(self, model)</term>
<listitem>The argument this method gets is the TreeModel object
of the area plot tab as is at the moment the method is invoked.
This method is called once before calling run(), so the model
is actualized.
</listitem>
</varlistentry>
<varlistentry>
<term>run(self)</term>
<listitem>This method is called upon the object to let it build
the template values. It should put the result in the
self.ret_templates dict, where the caller will retrieve the
values. If a non zero value is returned to the caller, the
procedure will be canceled, i.e. the template values will not
be added to the model.
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- ============= Bugs ================================== -->
<!-- This section is optional and is commented out by default.
You can use it to describe known bugs and limitations of the
program if there are any - please be frank and list all
problems you know of.-->
<sect1 id="voacap-bugs">
<title>Known Bugs and Limitations</title>
<para>Apart from when starting the application for the very first time,
&app; does not check for updated SSN values. The user is responsible
for periodically checking / updating the SSN values using the
<guibutton>Web Update</guibutton> button on the SSN tab. </para>
</sect1>
<!-- ============= About ================================== -->
<!-- This section contains info about the program (not docs), such as
author's name(s), web page, license, feedback address. This
section is optional: primary place for this info is "About.." box of
the program. However, if you do wish to include this info in the
manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
<sect1 id="voacapgui-about">
<title>About &app;</title>
<para> &app; was written by J.Watson(M0DNS / HZ1JW) and
Fernado Maresca (LU2DFM)
(<email>jwatson@neomailbox.ch</email>). To find more information about
&app;, please visit the
<ulink url="http://www.qsl.net/hz1jw/pythonprop/index.html" type="http">
pythonprop homepage</ulink>. </para>
<para>
To report a bug or make a suggestion regarding this application or
this manual, please contact the author at the email address provided
above.
</para>
<para> This program is distributed under the terms of the GNU
General Public license as published by the Free Software
Foundation; either version 2 of the License, or (at your option)
any later version. A
<ulink url="ghelp:gpl" type="help">copy of this license</ulink>
is included with this documentation; another can be found in the file
COPYING included with the source code of this program. </para>
</sect1>
</article>
|