Installation Guide
Datavzrd can be installed in several ways. We recommend Pixi or Conda as the preferred methods due to ease of setup and integration of dependencies.
To install Pixi check their installation guide. Then, install Datavzrd via:
pixi global install datavzrd
This installs Datavzrd along with all its dependencies and makes the datavzrd command available on your system.
Tip
Datavzrd comes with YTE for templating configuration files (see the advanced tutorial).
To use the yte command yourself, install it via:
pixi global install yte
To install Conda check their installation guide. Then, install Datavzrd via 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
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:
Then install Datavzrd via Cargo:
cargo install datavzrd
To build Datavzrd from source, first clone the repository:
git clone https://github.com/datavzrd/datavzrd
cd datavzrd
Ensure all prerequisites listed in the Cargo tab are installed and then build via:
cargo build
This will compile Datavzrd. To run it with the already included example material in the repository run:
cargo run -- .examples/example.datavzrd.yaml -o report
Once installed, you can run datavzrd from the command line to generate interactive reports from tabular data.