README.md 1.75 KB
Newer Older
AJ Fite's avatar
AJ Fite committed
1
2
# Solar Irradiance Microforecasting Control Panel

AJ Fite's avatar
AJ Fite committed
3
A QT and Python3 based graphical control panel for the Lepton-Grabber
AJ Fite's avatar
AJ Fite committed
4

5
6
## Installation

AJ Fite's avatar
AJ Fite committed
7
8
9
10
11
12
13
14
15
16
17
The application can be installed from pypi using pip:

    pip install SimfPythonGUI
    
On some systems you may need to specify Python 3's version of pip:

    pip3 install SimfPythonGUI
    
Package information can be found on the 
[pypi package page](https://pypi.org/project/SimfPythonGUI/) for the project.

AJ Fite's avatar
AJ Fite committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
### Dependencies

Dependencies should be managed automatically when installed with pip, but they
are provided here for reference:

* Python3
* PyQT5
* watchdog

The program relies on the following system utilities being installed or
suitably compatible replacements (configure the replacements using the
configuration menu):

* bash
* sudo

AJ Fite's avatar
AJ Fite committed
34
35
36
37
38
39
## Usage

The gui can be launched from the command line assuming your python package
path is set up properly using the command:

    simfgui
40

AJ Fite's avatar
AJ Fite committed
41
42
A configuration file is written by default to `~/.simfgui.ini`.  Running the
utility will require sudo permissions
43
44
45
46
47
48

## Contributing and Editing

The repository contains the files for editing with the JetBrains PyCharm IDE.
The .ui files can be editied with QT Designer (they were created using QT
Designer 5.11).  QT Designer can be obtained from the QT website or your
49
50
51
52
53
54
55
56
57
58
59
favorite package manager.

### Source Code

The code is hosted online in two locations and accepting pull requests:

* [Primary](https://git.nclf.net/SIMF/simf-python-gui)
* [Mirror (GitHub)](https://github.com/Goldman60/simf-python-gui)

## Questions, comments, issues?

AJ Fite's avatar
AJ Fite committed
60
61
62
Please use the contact information on [my website](https://ajfite.com).  For
my most recent contact info, I'm happy to help even though by the time you're 
reading this I'm long graduated, just shoot me an email.