rivt is a lightweight, extensible open source Python tool for writing, organizing and sharing engineering documents. It compiles markup text in rivt files into formatted text, HTML or PDF documents.
There are four types of rivt and 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 markup.
| A rivt doc is the 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 report | rivt files organized and collated into a single text,
| PDF or HTML report file.
| A rivt book is an organized collection of rivt files with
rivt book | a common subject matter and organized for efficient selection
| and insertion into docs and reports.
For an overview of rivt see here. To get started see here. For rivt and AI see here. rivt works seamlessly with AI tools while maintaining user control of the final document content and appearance.
An interface for finding public rivt files on GitHub is here. A collection of open source models and documents, including rivt, is at Google Drive here .
rivt produces clear, organized engineering documents through a fast, user controlled process. A typical doc takes 1 to 2 seconds to compile. rivt markup formats documents using about 3 dozen commands and tags using reasonable, customizable defaults. If more format control is required for formal journal articles or books, Quarto is a better tool. Further discussion of available scientific and engineering document tools and their strengths, relative to the objectives of rivt, is here.
ver: 1.0.0a12 (Note: rivt is alpha sofware. Some features are incomplete and the user API may change.)