Home#

rivt logo

rivt is an open source Python and Code-OSS project for writing and sharing live engineering documents with sources. Python knowledge isn’t necessary but custom integrated Python scripts can increase rivt capabilities. rivt includes both a portable desktop editor and a server driven browser editor. The table below provides links to the project programs and source code.

rivt_logo     rivtlib - Python library for processing rivt files ( rivtlib source )

studio_logo     rivtStudio - portable writing and publishing desktop application ( rivtStudio source )

remote_logo     rivtRemote - containerized rivtStudio for servers and browsers ( rivtRemote source )

rivtlib, rivtStudio and rivtRemote are distributed under the MIT open source license ( FAQ ).

There are six folder and file types that generate rivt documents and are designed for open source sharing. Two general methods are available for sharing: public repositories like GitHub provide version control and user interaction, or cloud databases like Google Drive that do not require an account. The table below provides a summary of the file types and distribution methods.

git_logo     GitHub search - find public rivt files on GitHub

open_logo     openModels - online database of shared model and document files including rivt

rivt-project_folder_name - The enclosing folder for a rivt project including interace repository settings

        rvreport-report_folder_name - The enclosing folder for a rivt report

        rvhandbk-handbook_folder_name - The enclosing folder for a rivt handbook

           rvDDSS-file_name.py - A file that generates a rivt doc - the basic unit of a rivt document report

           rvscript-file_name.py - A Pyhon file that extends rivt functionality

           rvtask-file_name.shelltype - A shell file that runs external programs

Examples of rivt files and docs include this user manual, which was written in rivt, and other demo files.

rivt was developed because there are many benefits to writing and freely sharing live, editable engineering documents. For questions and comments please send emails to questions@openmodels.engineering


ver: 1.0.0a20 - Note: rivt is currently alpha sofware. Some features are incomplete and the program structure and markup may change.