rivtlib 1.0.0a2

a package for editing and formatting engineering documents

rivt is an open source software project that simplifies sharing and reuse of engineering documents. This has always been a challenge because engineering documents are complex. They include text, images, tables, calculations, models and computer code organized into reports.

The primary use case for rivt is producing engineering documents that lie somewhere between back of envelope notes and calculations, and formal journal publications. In other words, it produces formatted, organized documents that are easy to edit.

The second use case is when flexibilty is needed to produce documents in a variety of formats including text, PDF or HTML.

A rivt file publishes a formatted rivt doc as a text, PDF or HTML file. A rivt file is a Python file (.py) that imports the rivtlib Python package and includes rivt markup. A collection of rivt docs may be linked and collated as a rivt report. The rivt user manual is here.

rivt files can function as a front and back end for:

1. software control

2. visualization

3. instrumentation

rivt docs can be used for:

1. internal communication

2. research documentation

3. government permits

4. technical reports

5. funding applications

Because rivt is compatible with collaborative tools it may be used in:

1. teaching

2. for presentations

3. real time collaboration