Install & launch — NOESISReader User Guide

Install NOESISReader on Windows or Linux, open your first NOESIS session and learn the launch options.

Install#

Run a prebuilt copy#

Open the build folder and run noesisreader.exe. The command-line tool noesisreader-cli.exe sits beside it.

Build from source#

Install Visual Studio Build Tools with Desktop development with C++, Qt 6.8 or newer for MSVC 64-bit (with Qt Multimedia and Qt Shader Tools) and vcpkg.

In an x64 Native Tools Command Prompt:

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo ^
      -DCMAKE_PREFIX_PATH=C:\Qt\6.8.3\msvc2022_64 ^
      -DCMAKE_TOOLCHAIN_FILE=C:\vcpkg\scripts\buildsystems\vcpkg.cmake
cmake --build build

vcpkg fetches SQLite and FFmpeg automatically. Without FFmpeg, add -DNR_WITH_FFMPEG=OFF; everything except video export still works.

Deploy the Qt runtime next to the program:

C:\Qt\6.8.3\msvc2022_64\bin\windeployqt.exe --qmldir qml build\noesisreader.exe

Prebuilt package (Linux Mint / Ubuntu, x86-64)#

Unzip NoesisReader-0.1.0-linux-x86_64.zip anywhere.
Run ./NoesisReader from the unpacked folder. The CLI is ./noesisreader-cli.
Optional: run ./install-desktop-entry.sh to add NOESISReader to the applications menu.

Build from source#

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=$HOME/Qt/6.8.3/gcc_64
cmake --build build

Requires a C++20 compiler, Qt 6.8+ (Quick, Multimedia, ShaderTools), SQLite and FFmpeg development packages.

Launch#

Start NOESISReader and open a session from the welcome screen, or pass the session folder directly:

noesisreader "D:\recordings\session-1791404921802059900"

Launch options#

Option	Effect
`session`	NOESIS session folder to open.
`--seek <s>`	Initial cursor position in seconds.
`--view <name>`	Initial centre view: `video`, `fullscreen`, `constellation`, `loom`, `resonance`, `shockwave`, `lens`, `fingerprint`, `spectrum`, `histogram`, `rf`, `synthesis`, `composition`.
`--tab <n>`	Initial tab inside the RF / Radio or Synthesis workspace.
`--layers <ids>`	Comma-separated layers to enable, for example `em-fog,plumb-line,hud`.
`--screenshot <png>`	Render, save a PNG of the window and exit.
`--render-video <mp4>`	Render the viewer (with active layers) to a video and exit. Use with `--from <s>` and `--to <s>`.
`-v`, `--version` / `-h`, `--help`	Version / usage.

noesisreader SESSION --seek 5 --view loom
noesisreader SESSION --layers em-fog,hud --render-video clip.mp4 --from 4 --to 9

Next steps#

Orientation

Interface tour

Menus, transport, viewer, docks and timeline.

Data

Sessions & projects

Opening sessions and saving your work.

Navigate

Playback & shortcuts

Every transport control and key.