SatDump

(โ˜… 2,084)

A generic satellite data processing software.

Showing a partial file list โ€” download the zip above to see everything.

  • .clang-format
  • .clang-format-ignore
  • .clangd
  • .dockerignore
  • .gitignore
  • .gitmodules
  • cli-init.png
  • cli_example.png
  • CMakeLists.txt
  • docker-compose.yml
  • Dockerfile
  • Doxyfile.in
  • gui-live-source.png
  • gui-menu.png
  • gui-processing.png
  • gui_recording.png
  • icon.png
  • LICENSE
  • packages.builder
  • packages.runner
  • README.md
  • satdump.appdata.xml
  • satdump.desktop
  • SatDump.yml
  • satdump_cfg.json

# Installation Guide

1. Get the code
git clone https://github.com/SatDump/SatDump

Downloads the entire project code from GitHub to your computer.

cd SatDump

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
brew install cmake dylibbundler libtool autoconf automake meson orc libxml2 zlib portaudio boost libusb nng volk libjpeg-turbo libtiff libomp libpng glfw3 libusb fftw libxml2 portaudio jemalloc nng zstd armadillo hdf5 sqlite3

Installs the pre-built package via Homebrew โ€” no source build required.

sudo apt install git build-essential cmake g++ pkgconf libfftw3-dev libpng-dev \

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install libvolk-dev # If this package is not found, use libvolk2-dev or libvolk1-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt install libnng-dev # If this package is not found, follow build instructions below for NNG

Installs directly from the APT package repository (Debian/Ubuntu-based).

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose build --build-arg CMAKE_BUILD_PARALLEL_LEVEL=8

Runs the command against the services defined in the compose file.

docker compose run --rm -it satdump

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ ์ปดํŒŒ์ผ๋Ÿฌ Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
brew install cmake dylibbundler libtool autoconf automake meson orc libxml2 zlib portaudio boost libusb nng volk libjpeg-turbo libtiff libomp libpng glfw3 libusb fftw libxml2 portaudio jemalloc nng zstd armadillo hdf5 sqlite3

Installs the pre-built package via Homebrew โ€” no source build required.

cmake -DCMAKE_BUILD_TYPE=Release .. # If you want to bundle the app, you must also add -DBUNDLING_MODE=ON, that makes the binary usable in a bundle

Type this command into your terminal and run it.

sudo apt install git build-essential cmake g++ pkgconf libfftw3-dev libpng-dev \

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo dnf install git cmake g++ fftw-devel volk-devel libpng-devel jemalloc-devel \

Type this command into your terminal and run it.

sudo dnf install git cmake g++ fftw-devel volk-devel libpng-devel jemalloc-devel hdf5-devel \

Type this command into your terminal and run it.

โœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

5. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
cd android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.
// repository documentation