2. Installation

[01] Installation types

---

rivt

rivt is a Python project that includes rivtlib and other Python packages. When rivt is installed, rivt docs and reports may be edited and published using a text editor.

See rivt-uv for uv install

See rivt-system for system install

---

rivt framework

The rivt framework includes rivt and additional programs installed separately. It includes important productiviy tools for editing, document control and diagramming.

1. VSCode and extensions for editing and collaboration.

2. Git and GitHub for version control and document sharing.

3. LaTeX for precise typesetting.

4. QCAD for diagramming.

---

rivt.zip

A single folder, portable version of rivt integrated with VSCode.

---

[02] Install rivt-uv

---

This method for installing rivt is recommended for most users. The procedure for Windows is shown below. Other OS installs are similar.

Step 1. Install uv

Install uv. The recommended method for installing uv on Windows is:

winget install --id=astral-sh.uv  -e

Step 2. Create rivt environment and install rivtlib

After installing uv, run the following commands to set up and activate an isolated rivt environment in the users Home directory (omit the explanatory REM lines). The commands execute the following steps:

1. names the uv environment in the first SET command

2. changes to the %HOMEPATH% (User) folder

3. removes any prior existing environment, cache and folders.

4. downloads the rivt install file.

5. creates a new environment and activates it.

6. installs rivt in the uv environment.

7. creates an example1 folder

8. downloads a rivt file and sources into the example1 folder

The commands may be downloaded and run from the command file rivt-uv.cmd.

@echo on
REM (1) clear any existing project, (2) create new venv
REM (3) install rivt, (4) download example
REM set rivt folder
SET rvfolder=rivt-doc1
REM go to home directory
cd %HOMEPATH%
REM double check deactivation
uv deactivate
REM double check that old project is deleted
rmdir /s /q %rvfolder%
REM (1) clean cache
uv cache clean
REM set up venv
mkdir %rvfolder%
REM change directory
cd %rvfolder%
REM (2) make venv
uv venv
REM activate venv
call .venv/scripts/activate
REM (3) install rivt from GitHub
uv pip install git+https://github.com/rivtlib-dev/rivtlib.git@main
REM (4) download example project into new folder
mkdir example1
cd example1
curl https://raw.githubusercontent.com/rivt-info/rivt-simple-single-doc/refs/heads/main/rv0000-simple-single-doc.py -O
curl https://github.com/rivt-info/rivt-simple-single-doc/blob/main/beam.png?raw=true -O -L
REM run example with (no quotes) "python rv0000-simple-single-doc.py"
cmd /k

Within the example1 folder run the rivt file:

python rv0000-simple-single-doc.py

[03] Install rivt-system

---

Use Python installers and pip to install packages from PyPI. The requirements.txt file is here.

[04] Install rivt framework

---

The rivt framework includes installation of the following programs:

1. VSCode and VSCode extensions.

2. Git and set up a GitHub

3. LaTeX

4. QCAD

[04] Install rivt.zip

rivt.zip is a portable, single folder version of rivt and VSCode including libraries and extensions. It can be downloaded here.

The advantages of this installation method include:

1. No steps - just unzip and use.

2. Can be moved anywhere as a unified folder.

3. Ensures compatiblity and integration between libraries.

Disadvantages include:

1. The installation itself cannot be updated. New releases are planned monthly.

2. Integration with other programs can be more difficult.