B.1 Install#

<i>

[1] rivt Project#

rivt is a Python project that includes rivtlib and about two dozen Python packages. After rivt is installed docs and reports may be edited and published using a text editor.

rivt is also designed to work with other open source programs and tools in an integrated framework that adds editing and analysis capabilities. There are four installation methods with varying degrees of system and program integration.

<i>

[2] Install rivt-uv#

This rivt-uv installation method 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 may be downloaded and run from the command file rivt-uv.cmd.

They execute the following steps:

  1. name the uv environment in the first SET command

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

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

  4. download the rivt install file.

  5. create a new environment and activates it.

  6. install rivt in the uv environment.

  7. create an example1 folder

  8. download an example rivt file and sources into the example1 folder

 1@echo on
 2REM Windows 10 and above - cmd file
 3REM (1) clear any existing project, (2) create new venv
 4REM (3) install rivt, (4) download example
 5REM set rivt folder
 6SET rvfolder=rivt-doc1
 7REM go to home directory
 8cd %HOMEPATH%
 9REM double check deactivation
10uv deactivate
11REM double check that old project is deleted
12rmdir /s /q %rvfolder%
13REM (1) clean cache
14uv cache clean
15REM set up venv
16mkdir %rvfolder%
17REM change directory
18cd %rvfolder%
19REM (2) make venv
20uv venv
21REM activate venv
22call .venv/scripts/activate
23REM (3) install rivt from GitHub
24uv pip install git+https://github.com/rivtlib-dev/rivtlib.git@main
25REM (4) download example project into new folder
26mkdir example1
27cd example1
28curl https://raw.githubusercontent.com/rivt-info/rivt-simple-doc/refs/heads/main/rv000-simple-doc.py -O
29curl https://github.com/rivt-info/rivt-simple-doc/blob/main/beam.png?raw=true -O -L
30curl https://github.com/rivt-info/rivt-simple-doc/blob/main/beam1-v.csv?raw=true -O -L
31REM run example (no quotes) "python rv000-simple-doc.py"
32cmd /k

Within the example1 folder run the rivt file:

python rv000-simple-doc.py

<i>

[3] Install rivt-system#

rivt may be installed at the system level.

  1. Install Python using Python installers

  2. Install rivtlib and dependencies using pip

A list of the dependencies and requirements.txt file is here.

<i>

[4] Install rivt-framework#

The rivt-framework includes installation of the following programs:

  1. VSCode and VSCode extensions. rivt extensions and snippets are here.

  2. Git and set up a GitHub

  3. LaTeX

  4. QCAD

<i>

[5] 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.