pyqso/docs/source/introduction.rst

85 wiersze
3.0 KiB
ReStructuredText
Czysty Wina Historia

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

Introduction
============
Overview
--------
PyQSO is a logging tool for amateur radio operators. It provides a
simple graphical interface through which users can manage information
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).
- Import and export logs in ADIF format.
- Perform callsign lookups and auto-fill data fields using the qrz.com
database.
- Sort the logs by individual fields.
- Print a hard-copy of logs, or print to PDF.
- Connect to Telnet-based DX clusters.
- Progress tracker for the DXCC award.
- Grey line plotter.
- Filter out QSOs based on the callsign field (e.g. only display
contacts with callsigns beginning with "M6").
- Remove duplicate QSOs.
- Basic support for the Hamlib library.
The source code for PyQSO is available for download at:
``https://github.com/ctjacobs/pyqso``
Data storage model
------------------
Many amateur radio operators choose to store all the contacts they ever
make in a single *logbook*, whereas others keep a separate logbook for
each year, for example. Each logbook may be divided up to form multiple
distinct *logs*, perhaps one for casual repeater contacts and another
for DXing. Finally, each log can contain multiple *records*. PyQSO is
based around this three-tier model for data storage, going from logbooks
at the top to individual records at the bottom.
Rather than storing each log in a separate file, a single database can
hold several logs together; in PyQSO, a database is therefore analogous
to a logbook. Within a database the user can create multiple tables
which are analogous to the logs. Within each table the user can
create/modify/delete records which are analogous to the records in each
log.
Licensing
---------
PyQSO is free software, released under the GNU General Public License.
Please see the file called COPYING for more information.
Structure of this manual
------------------------
The structure of this manual is as follows. Chapter
[chap:getting:sub:`s`\ tarted] is all about getting started with PyQSO –
from the installation process through to creating a new logbook (or
opening an existing one). Chapter [chap:log:sub:`m`\ anagement] explains
how to create a log in the logbook, as well as the basic operations that
users can perform with existing logs, such as printing, importing
from/exporting to ADIF format, and sorting. Chapter
[chap:record:sub:`m`\ anagement] deals with the bottom layer of the
three-tier model – the creation, deletion, and modification of QSO
records in a log. Chapter [chap:toolbox] introduces the PyQSO toolbox
which contains three tools that are useful to amateur radio operators: a
DX cluster, a grey line plotter, and an awards progress tracker.
Finally, Chapter [chap:preferences] explains how users can set up Hamlib
support and show/hide various fields in a log, along with several other
user preferences that can be set via the Preferences dialog window.