rivt is an open source Python tool for writing and sharing engineering documents, with a focus on document reuse and privacy controls. Python knowledge is not needed to use rivt but Python scripts can provide access and automation for the large collection of scientific and engineering libraries.
There are four types of rivt document files:
| A rivt file is the basic input file that produces a publication
rivt file | document. It is a Python file (.py) that imports the rivtlib
| Python package and includes plain text content and rivt markup.
| A rivt doc is the basic published output of a rivt file. A doc
rivt doc | is a formatted text, PDF or HTML output file compiled from
| a rivt file. The same rivt file produces each type of doc.
| A rivt report is the published output from a group of rivt files
rivt report | organized and 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 with a common
rivt book | subject matter organized for efficient selection and inclusion
| in docs and reports.
For an overview of rivt see here. To get started using rivt see here. For ideas on using AI with rivt see here.
A convenient interface for searching public rivt files on GitHub is here. A collection of donwloadable open source models and documents on Google Drive, including rivt, is here.
rivt produces clear, organized engineering documents through a fast compilation process that takes a second or two for a complete doc and can be interactively executed section by section in and IDE, similar to a Jupyter notebook.
rivt markup formats documents using about 3 dozen commands and tags with reasonble defaults. If more control is needed to publish formal journal articles or books, Quarto will likely be a better tool. A brief discussion of other 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.)