Skip to content

docs: add guide for user-space flatpak installation and execution #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nerdCopter wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add guide for user-space flatpak installation and execution #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions README_flatpak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Running PIDscope via GNU Octave Flatpak (User-space / No-Sudo)

This guide explains how to install GNU Octave and its required packages in user-space using Flatpak, allowing you to run PIDscope without administrative (`sudo`) privileges.

---

## 1. Prerequisites
Ensure `flatpak` is installed on your Linux system. (If not, install it using your system's package manager).

## 2. Install GNU Octave (User-space)
To install Octave without administrative privileges, add the Flathub repository to your user configuration and install GNU Octave:

```bash
# Add Flathub repository for the user
flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo

# Install GNU Octave
flatpak install --user -y flathub org.octave.Octave
```

## 3. Install Octave Forge Packages
PIDscope requires several Octave packages. When installing from Octave Forge, they must be compiled in a specific sequence due to inter-package dependencies. Run the following commands in order:

```bash
# 1. Install 'control' (required by signal)
flatpak run org.octave.Octave --no-gui --eval "pkg install -forge control"

# 2. Install 'signal'
flatpak run org.octave.Octave --no-gui --eval "pkg install -forge signal"

# 3. Install 'datatypes' (required by statistics)
flatpak run org.octave.Octave --no-gui --eval "pkg install -forge datatypes"

# 4. Install 'statistics' and 'image'
flatpak run org.octave.Octave --no-gui --eval "pkg install -forge statistics image"
```

To verify the installation, you can list the installed packages:
```bash
flatpak run org.octave.Octave --no-gui --eval "pkg list"
```

## 4. Setup Log Decoders
PIDscope requires `blackbox_decode` and `blackbox_decode_INAV` binaries to be present in the project root directory.

If you already have pre-compiled decoders, copy them into the PIDscope project directory:
```bash
cp /path/to/your/blackbox_decode /path/to/PIDscope/blackbox_decode
cp /path/to/your/blackbox_decode /path/to/PIDscope/blackbox_decode_INAV

# Ensure they are executable
chmod +x /path/to/PIDscope/blackbox_decode /path/to/PIDscope/blackbox_decode_INAV
```
*(Alternatively, you can compile them from source by running `make fetch-blackbox` if you have build dependencies installed.)*

## 5. Verify Installation (Optional)
Run the test suite to ensure everything is set up correctly:
```bash
flatpak run org.octave.Octave --no-gui --eval "addpath(genpath('src')); addpath('tests'); run_tests"
```

## 6. Execute PIDscope
Run the following command to start the PIDscope graphical interface:

```bash
flatpak run org.octave.Octave --gui --persist --eval "cd('/path/to/PIDscope'); PIDscope"
```
*(Replace `/path/to/PIDscope` with the actual path where the repository is cloned on your system).*