Added more links and updated documentation.

pull/61/head
Christian T. Jacobs 2017-06-30 12:29:58 +01:00
rodzic b099111218
commit f3a7888183
4 zmienionych plików z 23 dodań i 27 usunięć

Wyświetl plik

@ -7,10 +7,10 @@ System requirements
It is recommended that users run PyQSO on the Linux operating system,
since all development and testing of PyQSO takes place there.
As the name suggests, PyQSO is written primarily in the Python
As the name suggests, PyQSO is written primarily in the `Python <https://www.python.org/>`_
programming language (version 3.x). The graphical user interface has been built using
the GTK+ library through the PyGObject bindings. PyQSO also uses an
SQLite embedded database to manage all the contacts an amateur radio
the `GTK+ library <https://www.gtk.org/>`_ through the `PyGObject bindings <https://pygobject.readthedocs.io>`_. PyQSO also uses an
`SQLite <https://www.sqlite.org/>`_ embedded database to manage all the contacts an amateur radio
operator makes. Users must therefore make sure that the Python
interpreter and any additional software dependencies are satisfied
before PyQSO can be run successfully. The list of software packages that
@ -87,7 +87,7 @@ Once the logbook has been opened, its name will appear in the status bar. All lo
.. figure:: images/logbook.png
:align: center
The PyQSO main window, showing the records in a log called ``SO50`` (for contacts via the amateur radio satellite SO-50), and the DX cluster tool in the toolbox below it.
The PyQSO main window, showing the records in a log called ``SO50`` (for contacts via the `amateur radio satellite <https://www.amsat.org/>`_ SO-50), and the DX cluster tool in the toolbox below it.
Closing a logbook
-----------------

Wyświetl plik

@ -10,8 +10,7 @@ about the contacts/QSOs they make with other operators on the air. All
information is stored in a light-weight SQL database. Other key features
include:
- Customisable interface (e.g. only show callsign and frequency
information).
- Customisable interface (e.g. only show callsign and frequency information).
- Import logs in `ADIF <http://www.adif.org/>`_ format, and export logs in ADIF or `Cabrillo <http://wwrof.org/cabrillo/>`_ format.
@ -27,14 +26,13 @@ include:
- Grey line plotter.
- Filter out QSOs based on the callsign field (e.g. only display
contacts with callsigns beginning with "M6").
- Filter QSOs based on callsign (e.g. only display contacts with callsigns beginning with "M6").
- Remove duplicate QSOs.
- Basic support for the `Hamlib <http://hamlib.sourceforge.net/>`_ library.
The source code for PyQSO, written in Python (version 3.x), is available for download from the `GitHub repository <https://github.com/ctjacobs/pyqso>`_.
The source code for PyQSO, written in `Python <https://www.python.org/>`_ (version 3.x), is available for download from the `GitHub repository <https://github.com/ctjacobs/pyqso>`_.
Data storage model
------------------

Wyświetl plik

@ -46,7 +46,7 @@ While PyQSO stores logbooks in SQL format, it is possible to export
individual logs in the well-known `ADIF <http://www.adif.org/>`_ and `Cabrillo <http://wwrof.org/cabrillo/>`_ formats. Select the log to export,
and click ``Export Log as ADIF...`` or ``Export Log as Cabrillo...`` in the ``Logbook`` menu.
**Note for contesters:** Cabrillo records typically require contest QSO information in the form ``CALL RST EXCH``, where ``EXCH`` denotes exchange information (e.g. a serial number or US state). No dedicated field exists in PyQSO to store exchange information so the RST fields should be used to store both the RST report *and* exchange information, separated by a space. The ``RST Sent`` field should therefore contain the RST and exchange information that you give to the other station, and the ``RST Received`` field should contain the RST and exchange information that the other station gives you. The export process asks for your callsign (this should be the callsign used during the contest) and the contest's name which can be selected from a drop-down list. If the contest name does not appear in this list, you may enter its name manually.
**Note for contesters:** Cabrillo records typically require contest QSO information in the form ``CALL RST EXCH``, where ``EXCH`` denotes exchange information (e.g. a serial number or US state). No dedicated field exists in PyQSO to store exchange information so the RST fields should be used to store both the RST report *and* exchange information, separated by a space. The ``RST Sent`` field should therefore contain the RST and exchange information that you give to the other station (e.g. 59 001), and the ``RST Received`` field should contain the RST and exchange information that the other station gives you (e.g. 57 029). The export process asks for your callsign (this should be the callsign used during the contest) and the contest's name which can be selected from a drop-down list. If the contest name does not appear in this list, you may enter its name manually.
Importing a log
---------------
@ -56,14 +56,12 @@ users can choose to store the records in a new log, or append them to an
existing log in the logbook. To import, click ``Import Log...`` in the
``Logbook`` menu.
Note that all data being imported must conform to the ADIF standard, otherwise it will
be ignored.
Note that each QSO record being imported must conform to the ADIF standard, otherwise the record will be ignored.
Printing a log
--------------
Due to restrictions on the page width, only a selection of field names
will be printed: callsign, date, time, frequency, and mode.
The log that is currently selected can be printed out on paper or printed to a PDF file by clicking ``Print Log...`` in the ``Logbook`` menu. Each page uses a landscape orientation to maximise the amount of QSO information per line. The following data is included: Index, Callsign, Date, Time, Frequency, Mode, RST Sent, and RST Received.
Filtering by callsign
---------------------
@ -75,7 +73,7 @@ contain ``xyz``.
Sorting by field
----------------
To sort a log by a particular field name, left-click the column header
To sort a log by a particular field name, click the column header
that contains that field name. By default, it is the ``Index`` field
that is sorted in ascending order.

Wyświetl plik

@ -9,15 +9,15 @@ General
Under the ``General`` tab, the user can choose to:
- always show the toolbox (see the `Toolbox <toolbox.html>`_ section) when PyQSO is started
- Always show the toolbox (see the `Toolbox <toolbox.html>`_ section) when PyQSO is started.
- display yearly logbook statistics on the Summary page when a logbook is opened (see figure:summary_)
- Display annual logbook statistics on the Summary page when a logbook is opened (see figure:summary_).
- open a default logbook file
- Open a default logbook file.
- keep the ``Add Record`` dialog window open after a new QSO is added, in preparation for the next QSO
- Keep the ``Add Record`` dialog window open after a new QSO is added, in preparation for the next QSO.
- pin-point the user's QTH on the grey line map by specifying the latitude-longitude coordinates (or looking them up based on the QTH's name, e.g. city name)
- Pin-point the user's QTH on the grey line map by specifying the latitude-longitude coordinates (or looking them up based on the QTH's name, e.g. city name).
.. _figure:summary:
.. figure:: images/summary.png
@ -28,22 +28,22 @@ Under the ``General`` tab, the user can choose to:
View
----
Not all the available fields have to be displayed in the logbook. The user can choose to hide a subset of them by unchecking them in the ``View`` tab. PyQSO must be restarted in order for any changes to take effect.
Not all the available fields have to be displayed in the logbook. The user can choose to hide a subset by unchecking them in the ``View`` tab. PyQSO must be restarted in order for any changes to take effect.
Records
-------
The records tab comprises options concerning the Add/Edit Record dialog window. It allows users to:
- use the UTC timezone when autocompleting the date and time fields
- Use the UTC timezone when autocompleting the date and time fields.
- choose whether the band should be automatically determined from the frequency field
- Choose whether the band should be automatically determined from the frequency field.
- specify default values for the Power, Mode, and Submode fields
- Specify default values for the Power, Mode, and Submode fields.
- enter the QSO's frequency in a unit other than MHz (note that the frequency will always be presented in MHz in the main window, regardless of this preference)
- Enter the QSO's frequency in a unit other than MHz (note that the frequency will always be presented in MHz in the main window, regardless of this preference).
- specify the callsign lookup settings
- Specify the callsign lookup settings.
Callsign lookup
~~~~~~~~~~~~~~~
@ -60,7 +60,7 @@ PyQSO currently supports the ``NOTES`` field in the ADIF specification, but not
Hamlib support
--------------
PyQSO features rudimentary support for the Hamlib library. The name and
PyQSO features rudimentary support for the `Hamlib <http://hamlib.sourceforge.net/>`_ library. The name and
path of the radio device connected to the user's computer can be
specified in the ``Hamlib`` tab of the preferences dialog. Upon adding a
new record to the log, PyQSO will use Hamlib to retrieve the current