2017-03-20 13:06:01 +00:00
Copyright (C) 2013-2017 Christian Thomas Jacobs.
2013-10-04 14:16:57 +00:00
This file is part of PyQSO.
PyQSO is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
PyQSO is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
2013-10-04 14:18:52 +00:00
along with PyQSO. If not, see < http: / / www . gnu . org / licenses / > .
2013-10-04 14:16:57 +00:00
2013-10-04 14:18:52 +00:00
PyQSO
2013-10-04 13:55:57 +00:00
=====
2013-10-04 18:32:14 +00:00
PyQSO is a contact logging tool for amateur radio operators.
2013-10-04 14:16:57 +00:00
2015-02-08 01:21:51 +00:00
[](https://travis-ci.org/ctjacobs/pyqso)
2015-02-08 12:47:24 +00:00
[](https://readthedocs.org/projects/pyqso/?badge=latest)
2015-02-08 01:21:51 +00:00
2013-10-04 14:52:00 +00:00
Installation and running
------------------------
2013-10-04 14:16:57 +00:00
Assuming that the current working directory is PyQSO's base directory (the directory that the Makefile is in), PyQSO can be installed via the terminal with the following command:
`make install`
2013-10-04 14:42:53 +00:00
Note: 'sudo' may be needed for this. Once installed, the following command will run PyQSO:
2013-10-04 14:16:57 +00:00
2013-10-04 16:06:26 +00:00
`pyqso`
2013-10-04 14:16:57 +00:00
2013-10-04 19:23:24 +00:00
Alternatively, PyQSO can be run (without installing) with:
2013-10-04 14:16:57 +00:00
2016-05-28 13:19:28 +00:00
`python3 bin/pyqso`
2013-10-04 14:16:57 +00:00
from PyQSO's base directory.
2013-10-04 14:52:00 +00:00
Documentation
-------------
2015-02-08 12:56:37 +00:00
The PyQSO documentation is stored in the `docs` directory. It can be built with the following command:
2013-10-04 14:16:57 +00:00
2015-02-08 12:56:37 +00:00
`make docs`
2013-10-04 14:16:57 +00:00
2015-02-08 15:50:46 +00:00
which will produce an HTML version of the documentation in `docs/build/html` that can be opened in a web browser.
2015-02-08 12:56:37 +00:00
2016-05-28 13:19:28 +00:00
Alternatively, a ready-built version of the PyQSO documentation can be found on [Read the Docs ](http://pyqso.readthedocs.io/ ).
2013-10-04 14:16:57 +00:00
Dependencies
------------
2013-10-04 18:32:14 +00:00
PyQSO depends on the following Debian packages:
2013-10-04 14:16:57 +00:00
* gir1.2-gtk-3.0
2015-10-12 00:23:37 +00:00
* python3
* python3-gi-cairo (for log printing purposes)
2013-10-04 18:32:14 +00:00
2017-02-10 18:50:34 +00:00
The following extra packages are necessary to fully enable the grey line tool and the plotting of logbook statistics:
2013-10-04 18:32:14 +00:00
2016-05-28 14:10:58 +00:00
* python3-matplotlib (version 1.3.0 or later)
2015-10-12 00:23:37 +00:00
* python3-mpltoolkits.basemap
* python3-numpy
* libxcb-render0-dev
* python3-cairocffi
2017-02-10 18:50:34 +00:00
* [geocoder ](https://pypi.python.org/pypi/geocoder ) (installable via `pip` and used for QTH lookups)
2013-10-04 18:32:14 +00:00
2015-02-08 12:37:05 +00:00
The following extra package is necessary to build the documentation:
2015-10-12 00:23:37 +00:00
* python3-sphinx
There currently does not exist a Python 3-compatible Debian package for [Hamlib ](http://www.hamlib.org ). This library must be built manually to enable Hamlib support.
2015-02-08 12:37:05 +00:00
2015-02-08 03:03:38 +00:00
Contact
-------
2017-04-01 14:20:33 +00:00
If you have any comments or questions about PyQSO please send them via email to Christian Jacobs, M0UOS, at < christian @ christianjacobs . uk > .
