Installation Guide

Datavzrd can be installed in several ways. We recommend Conda as the preferred method due to ease of setup and integration of dependencies. To install Conda check their installation guide.

Conda

To install Datavzrd via Conda, use one of the following commands:

conda install -c conda-forge datavzrd

or

mamba install -c conda-forge datavzrd

or

micromamba install -c conda-forge datavzrd

This installs Datavzrd along with all its dependencies.

Tip

To isolate Datavzrd in its own environment, you can create and activate a dedicated Conda environment:

conda create -n datavzrd -c conda-forge datavzrd
conda activate datavzrd

Cargo

If you prefer using Rust’s native package manager, you can install Datavzrd using Cargo. Please note that Datavzrd depends on Python packages via pyo3 and yte and also various JavaScript libraries via pnpm. Therefore you must have the following installed beforehand:

• Rust

• Python

• pnpm

• yte

Then install Datavzrd via Cargo:

cargo install datavzrd

---

Once installed, you can run datavzrd from the command line to generate interactive reports from tabular data.

From Source

To build Datavzrd from source, first clone the repository:

git clone https://github.com/datavzrd/datavzrd
cd datavzrd

Ensure all prequisites listed in the above Cargo section are installed an then build via:

cargo build

This will compile Datavzrd. To run it with the alredy included example material in the repository run:

cargo run .examples/example-config.yaml -o report