horus-gui/README.md

# Project Horus Telemetry Decoder

Telemetry demodulator for the following modems in use by Project Horus
* Horus Binary Modes
  * v1 - Legacy 22 byte mode, Golay FEC
  * v2 - 16/32-byte modes, LDPC FEC (Still in development)
* RTTY (7N2 only, for now)

Written by Mark Jessop <vk5qi@rfhead.net>

**Note: This is very much a work in progress!**

![Screenshot](doc/horusgui_screenshot.png)


### TODO LIST - Important Stuff
* Stop decoded data pane from resizing on bad/long decodes - TODO
* Export of telemetry via Horus UDP
* Better build system 
* Windows binary

### TODO LIST - Extras
* UDP input from GQRX
* Waterfall Display  (? Need something GPU accelerated if possible...)

## Usage

### Build HorusLib

```console
$ git clone https://github.com/projecthorus/horusdemodlib.git
$ cd horusdemodlib && mkdir build && cd build
$ cmake ..
$ make
$ make install
```

### Grab this Repo
```console
$ git clone https://github.com/projecthorus/horus-gui.git
$ cd horus-gui
```

### (Optional) Create a Virtual Environment

Create a virtual environment and install dependencies.
```console
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip install pip -U       (Optional - this updates pip)
```

### Install Python Dependencies
```console
$ pip install -r requirements.txt
```

NOTE: If you get errors relating to pyaudio when trying to install into a venv, make sure that portaudio is installed (`libportaudio-dev` under Linux distros, or `portaudio` under Macports), and then install pyaudio pointing to the portaudio lib by running:
```
(Linux) $ pip install --global-option='build_ext' --global-option='-I/usr/include' --global-option='-L/usr/lib' pyaudio
(OSX)   $ pip install --global-option='build_ext' --global-option='-I/opt/local/include' --global-option='-L/opt/local/lib' pyaudio
```
You should then be able to re-run the install requirements command above.

### Install Package

Install package in a editable state. This type of installation allows a
developer to make changes to the source code while retaining the installation
entry points so it can be used like a normal install.

```console
(venv) $ pip install -e .
```

### Run
```console
$ python -m horusgui.gui
```
Fix typos! 2020-06-22 12:10:39 +00:00			`# Project Horus Telemetry Decoder`

			`Telemetry demodulator for the following modems in use by Project Horus`
			`* Horus Binary Modes`
			`* v1 - Legacy 22 byte mode, Golay FEC`
Initial integration of horuslib 2020-06-29 11:42:41 +00:00			`* v2 - 16/32-byte modes, LDPC FEC (Still in development)`
Add relative position displays. 2020-07-05 08:02:05 +00:00			`* RTTY (7N2 only, for now)`
Fix typos! 2020-06-22 12:10:39 +00:00
Initial commit 2020-06-22 11:36:55 +00:00			`Written by Mark Jessop <vk5qi@rfhead.net>`

Fix typos! 2020-06-22 12:10:39 +00:00			`Note: This is very much a work in progress!`

Add screenshots 2020-07-10 08:24:35 +00:00			`![Screenshot](doc/horusgui_screenshot.png)`

Initial commit 2020-06-22 11:36:55 +00:00
Update readme 2020-06-22 11:48:08 +00:00			`### TODO LIST - Important Stuff`
Add relative position displays. 2020-07-05 08:02:05 +00:00			`* Stop decoded data pane from resizing on bad/long decodes - TODO`
			`* Export of telemetry via Horus UDP`
			`* Better build system`
Fix typos! 2020-06-22 12:10:39 +00:00			`* Windows binary`
Update readme 2020-06-22 11:48:08 +00:00
			`### TODO LIST - Extras`
			`* UDP input from GQRX`
Add relative position displays. 2020-07-05 08:02:05 +00:00			`* Waterfall Display (? Need something GPU accelerated if possible...)`
Initial commit 2020-06-22 11:36:55 +00:00
			`## Usage`

Update Readme 2020-06-29 11:53:26 +00:00			`### Build HorusLib`

move to poetry package management, repoint to horusdemodlib 2020-07-04 11:30:14 +00:00			```console
			`$ git clone https://github.com/projecthorus/horusdemodlib.git`
			`$ cd horusdemodlib && mkdir build && cd build`
Update Readme 2020-06-29 11:53:26 +00:00			`$ cmake ..`
			`$ make`
move to poetry package management, repoint to horusdemodlib 2020-07-04 11:30:14 +00:00			`$ make install`
Update Readme 2020-06-29 11:53:26 +00:00			```

Add note about pyaudio within venvs... 2020-07-06 09:12:03 +00:00			`### Grab this Repo`
Initial commit 2020-06-22 11:36:55 +00:00			```console
move to poetry package management, repoint to horusdemodlib 2020-07-04 11:30:14 +00:00			`$ git clone https://github.com/projecthorus/horus-gui.git`
			`$ cd horus-gui`
Add note about pyaudio within venvs... 2020-07-06 09:12:03 +00:00			```

			`### (Optional) Create a Virtual Environment`

			`Create a virtual environment and install dependencies.`
			```console
Initial commit 2020-06-22 11:36:55 +00:00			`$ python3 -m venv venv`
			`$ source venv/bin/activate`
			`(venv) $ pip install pip -U (Optional - this updates pip)`
			```

Add note about pyaudio within venvs... 2020-07-06 09:12:03 +00:00			`### Install Python Dependencies`
			```console
			`$ pip install -r requirements.txt`
			```

			NOTE: If you get errors relating to pyaudio when trying to install into a venv, make sure that portaudio is installed (`libportaudio-dev` under Linux distros, or `portaudio` under Macports), and then install pyaudio pointing to the portaudio lib by running:
			```
			`(Linux) $ pip install --global-option='build_ext' --global-option='-I/usr/include' --global-option='-L/usr/lib' pyaudio`
			`(OSX) $ pip install --global-option='build_ext' --global-option='-I/opt/local/include' --global-option='-L/opt/local/lib' pyaudio`
			```
			`You should then be able to re-run the install requirements command above.`

Initial commit 2020-06-22 11:36:55 +00:00			`### Install Package`

			`Install package in a editable state. This type of installation allows a`
			`developer to make changes to the source code while retaining the installation`
			`entry points so it can be used like a normal install.`

			```console
			`(venv) $ pip install -e .`
			```

			`### Run`
move to poetry package management, repoint to horusdemodlib 2020-07-04 11:30:14 +00:00			```console
			`$ python -m horusgui.gui`
			```