B.1 Install

[1i] rivt Project

---

rivt is an open source Python project that includes the rivtlib library and approximately two dozen Python packages. When rivt is installed, rivt files may be edited, and docs published, using a text editor. rivt is also designed to work with other open source programs and tools in an integrated framework that adds extends editing and analysis capabilities.

There are four installation methods for rivt and its framework, each with varying degrees of system and program integration.

1. rivtuv

uv is a Python package manager and installer that simplifies installing isolated Python environments. See rivtuv for procedure.

---

2. rivt system

rivt may be installed at the system level using standalone installers. See rivt system for procedure.

---

3. rivt framework

The rivt framework includes rivt and additional integrated programs and tools with their own installers. It includes important productivity 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.

See rivt framework for procedure.

---

4. rivtzip

rivtzip is a single folder, portable and isolated version of rivt that is integrated with VSCode.

See rivtzip for procedure.

[2i] Install rivtuv

---

Until rivt is uploaded to PyPI, the rivtuv installation method is recommended for most users.

Step 1. Install uv

Install uv.

The recommended method for installing uv is:

Windows:

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

macOS and Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2. Create a rivt environment and install rivtlib

After installing uv, download and run the following command or shell file. This installs an isolated rivt environment and example files in the users Home directory

Windows: rivtuv.cmd OSX: rivtuv.sh

Additional explanation for the install scripts can be found here.

[3i] 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.

[4i] Install rivt framework

---

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

[5i] Install rivtzip

---

rivtzip 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 installaion 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 software components cannot be individually updated. (New releases monthly)

2. Integration with other programs and tools may be more difficult.