rivt is an extensible, open-source program for writing and assembling calculation documents with a focus on reuse [1]. It provides a markup language that facilitates conversion to live calculation documents from any PDF or text. Python knowledge is not required but rivt capabilities can be extended using Python scientific and engineering libraries and scripts.
There are four types of rivt files:
| A rivt file is the basic input file that
rivt file | compiles to a text, PDF or HTML document.
| It is a Python file (.py) that imports the
| rivtlib Python package.
| A rivt doc is the published output of a rivt
rivt doc | file. A doc may be formatted as text, PDF
| or HTML from the same rivt file.
| A rivtbook is a collection of rivt files with
rivtbook | common subject matter and a folder structure
| that makes it easy to select files with related
| resources for inclusion in documents and reports.
| A rivt report is the collated output of multiple
| docs into a single text file, PDF file or HTML
rivt report | site. Docs are linked and grouped into divisions
| using doc file naming conventions.
For an overview of rivt see here. To get started with running examples see install. For rivt and AI see here. Examples of a rivt file with text, PDF, and HTML output docs are provided in this tutorial. Other documents and examples may be downloaded from Google Drive.
The rivtlib Python package formats and compiles a rivt file to a text, PDF or HTML document (doc) in a few seconds. rivt file sections may be interactively executed in an IDE. Multiple rivt files may be compiled into a collated rivt report. rivt files may be organized into rivtbooks, collections around a common subject matter and organized for efficient selection and inclusion in reports. This website is an example of an HTML rivt report. A convenient interface for searching and downloading public rivt files on GitHub is here.
rivt produces organized, formatted engineering documents from active calculation files using reasonable defaults. Use cases are listed here. Document tools like Quarto are likely better tools for static documents including journal articles and books that do not need recalculation. A brief discussion of current engineering document tools and their strengths relative to the objectives of rivt is here.
ver: 1.0.0a12 (Note: rivt is currently alpha sofware. Some features are incomplete and markup tags, commands and assignments may change.)