Installation

To get started, you first have to install ViRelAy on your system. The recommended and easiest way to install ViRelAy is to use pipx , which is a tool for installing Python applications from the Python package index (PyPI) in isolated environments:

$ pipx install virelay

You can then run ViRelAy using the following command:

$ virelay <project-file> [<project-file> ...]

Alternatively, you can also install ViRelAy using pip , although it is recommended to create a virtual environment to avoid conflicts with other Python packages:

$ python3 -m venv virelay-env
$ source virelay-env/bin/activate
$ pip install virelay
$ virelay <project-file> [<project-file> ...]

If you’d like to try out the bleeding-edge development version or experiment with the included examples, you can also clone the Git repository and install it manually. The project uses the Python package and project manager uv . You can find instructions on how to install and use uv in the official documentation . To install and run the development version of ViRelAy and run it, you can use the following commands:

$ git clone https://github.com/virelay/virelay.git
$ cd virelay
$ uv sync
$ uv run virelay <project-file> [<project-file> ...]