4. Reports#

The assembly and organization of a rivt report is inferred from:

  1. The rivt file and doc name

  2. The project folder names

Files and Docs

A rivt file name has a doc number prefix:

[rvddss-]file-name.py

where dd and ss are a two digit division and subdivision numbers respectively. e.g., rv0203-loads.py is rivt file 3 in division folder 2. Each rivt file outputs a doc file with the same doc number prefix. The doc number and project folder structure are used to assemble and organize reports.

Project Folders

rivt project folders organize files used to generate docs and reports. The files include rivt files, external source documents, settings, and public/private files. The top level structure is shown below. The full structure is shown here

[rivt]-Project-Label/             Project Folder
    ├── [dv01-]divlabel/          division folder
    ├── [dv02-]divlabel/          division folder

    ...

    ├── [public]/                 public rivt files
    ├── [reports]/                reports and docs
    ├── [source]/                 source files
    └── README.txt                text report

A rivt file may also generate a single doc that reads from and writes to the local rivt file folder, independent of the project folders.