C.3 Files#

[1t] File Types#

rivt file

A rivt file provides the formatting instructions and content that generate rivt docs. Each rivt file has a doc number prefix that specifies the division and subdivision of the doc. rivt reports are assembled using doc numbers. The subdivision name is taken from the name that follows, unless over-ridden in the report script. Division names are specified in the report script.

The doc number prefix includes a single digit capital alphanumeric division label D, followed by a two digit subdivision number ss. For example:

[rvDss-]file-name.py

rvB02-Beam-Loads.py

where the default doc name is “Beam Loads” in subdivision 2 of division C. Hyphens are stripped from file name.

Run file

A run file is a shell or command script executed using the | RUN | command.

origin: author input

folder: src/ - or a user created subfolder of /src

API function: rv.R

Insert file

An insert file is an image, table or text file executed using the | IMAGE | , | TABLE | , or | TEXT | command.

origin: author input

folder: src/ - or a user created subfolder of /src

API function: rv.I

Value file

A value file is a csv file that defines variable values. It is imported using the | VALUE | command. Values defined by equations and a _[[VALUES]] block are written to a file with the name composed of the doc and section number. The file may be read by other rivt files.

Read

origin: author input

folder: src/Values - or a user created subfolder of /src

API function: rv.V

Write

origin: program output

folder: src/Values

API function: rv.V

Tool file

Tool files can be executed by | PYTHON | , | HTML | , | RST | or | LATEX | commands. They may be used for analysis and generation of text, tables, images and other formatted content. Executing a tool file may:

  • define functions and classes for use in the rivt file

  • generate images, tables and text for inclusion in the doc

  • insert markup text into the doc

    Read

    origin: author input

    folder: src/Tools or a user created subfolder of /src

    API function: rv.T

    Write

    origin: program output

    folder: src/Tools

    API function: rv.T

Doc file

Each rivt file outputs a doc file with the same doc name and number and the selected doc type suffix. Doc files are written to the publish folder as text, PDF or HTML files using | PUBLISH | command.

PDF files may be prepended or appended to the doc using the | APPEND | command.

origin: program output

folder: src/ - or a user created subfolder of /src

API function: rv.D

Report file

A report file is generated by the Python report script and is written to the designated publish subfolder. The report file name is taken from the report folder name unless specified in the rivt-report.py script.

origin: program output

folder: /publish/ subfolder

Report script

The report script is a Python file that assembles the report. It specifies the docs that should be included, whether the rivt files should be re-executed and other format settings.

origin: author input

folder: /publish

Public rivt file

origin: program output

folder: /public

A public rivt file is a copy of the rivt file that includes all of the sections marked as public in the header. It has the same name as the rivt file with an added hyphen between “rv” and the docnumber e.g. rv-Dss-filename.py

Log file

Log files are written to the log folder. They include:

  • a backup of the rivt file

  • a file listing the execution steps when processing the rivt file

  • a file listing each API function call with the header.

    origin: program output

    folder: /logs

Sections