Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Volume Data Suite

Development

VDS is written in Rust and shaders are written in WGSL.

Make sure you are using the latest version of stable rust by running rustup update. VDS requires a proper graphics driver that provides at least one of the supported graphics APIs.

Building from Source for Native

Run it locally with cargo run --release.

On Linux you need to first run:

sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev

On Fedora Rawhide you need to run:

dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel

Building for Web

The website build compiles VDS to WebAssembly, generates its browser module, builds the documentation, and bundles the React site:

  1. Install wasm-bindgen-cli and mdbook at the versions used by CI.
  2. Run npm install in website/.
  3. Run npm run build for a production build or npm run dev for a local server.