rivt is an open source Python tool for writing and publishing engineering documents, with a focus on controlled reuse. Python knowledge is not required but rivt capabilities are extended with Python scripts that access scientific and engineering libraries.
There are four types of rivt document 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 doc | rivt file. A doc is a formatted text,
| PDF or HTML output file compiled from
| the same rivt file.
| A rivt report is the published output
rivt report | from rivt files collated into a single
| text, PDF or HTML report file.
| Each doc is a chapter in the report.
| A rivt book is a collection of rivt files
rivt book | with a commonsubject matter that are
| organized for efficient selection and
| inclusionin docs and reports.
For an overview of rivt see here. To get started using rivt see here. For rivt and AI see here.
The rivtlib Python package formats and compiles a rivt file to a text, PDF or HTML document ( docs ) in about a second. rivt file sections may be interactively executed in an IDE, similar to a Jupyter notebook. Mulitple rivt files may be compiled into a collated rivt report. This website is an example of an HTML rivt report.
A convenient interface for searching public rivt files on GitHub is here. Open source engineering models, documents and examples, including rivt, may be downloaded from Google Drive.
rivt produces clear, organized engineering documents from active calculations using reasonable defaults. Use cases are listed here. Document tools like Quarto are likely better tools for static, formatted documents including journal articles and books that do not need recalculation. A brief discussion of 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 and commands* may change.)