F.1 Quick Ref#

[1t] API Summary#

API functions

Function	Name	Purpose
rv.R (rS)	Run	Run shell commands
rv.I (rS)	Insert	Insert static sources
rv.V (rS)	Values	Calculate values
rv.T (rS)	Tools	Python and markup scripts
rv.D (rS)	Doc	Publish docs
rv.S (rS)	Skip	Skip section (comments and debugging)
rv.X (rS)	Exit	Exit rivt (debugging)

where rS is a rivt string. The first line of a rivt string (rS) is the header substring.

rv.I("""A New Section | private, doc, section

    Content text
    ...

    """)

The default setting for each API is listed in bold in the table below. Default settings in the header substring do not need to be specified.

API	private;public	doc;stored	section;merge
rv.R	private;public	stored;doc	merge;section
rv.I	private;public	doc;stored	section;merge
rv.V	private;public	doc;stored	section;merge
rv.T	private;public	stored;doc	merge;section
rv.S	private;public	stored	merge
rv.D	public	stored	merge
rv.X

[2t] Line Tags#

Format a line of text

API Scope	Line Tag	Description
rv.I	text _[C]	[2t] Center text
rv.I	text _[R]	[3t] Right justify text
rv.I	text math _[M]	[4t] Text math
rv.I	LaTeX math _[L]	[5t] LaTeX math
rv.I	text _[#] text	[6t] Endnote number
rv.I	text _[G] glossary term \| text	[7t] Glossary link
rv.I	text _[S] label, section \| text	[8t] Section link
rv.I	text _[D] label, file name \| text	[9t] Doc link
rv.I	text _[U] label, url \| text	[10t] URL link
rv.V, I	text _[V] var_name \| text	[11t] Variable value
rv.V, I	text _[E]	[12t] Equation number
rv.V, I	title _[T]	[13t] Table number
rv.V, I	caption _[F]	[14t] Figure number
rv.V, I	_[P]	[15t] New Page
rv.V, I	## text	nonprinting comment

[3t] Block Tags#

Format a block of text

API Scope	Block Tag	Description
rv.R	_[[SHELL]] process parameters	[2t] Shell script
rv.I	_[[INDENT]] spaces (4 default)	[3t] Indent text
rv.I	_[[ITALIC]] spaces (4 default)	[4t] Indent italic
rv.I	_[[ENDNOTES]] optional label	[5t] Endnotes
rv.I	_[[TEXT]] optional language	[6t] Text
rv.I	_[[TOPIC]] topic	[7t] Topic
rv.I	_[[BOX]] label	[8t] Box
rv.V, T	_[[PYTHON]] namespace	[9t] Python
rv.D	_[[METADATA]] label	[11t] Metadata
rv.D	_[[LAYOUT]] label	[12t] Layout block
all	_[[END]]	[13t] End block

[4t] Command Summary#

format files and calculations

API Scope	Command	Description
rv.R	SHELL \| rel path \| os, wait	[2t] Shell file
rv.I	TEXT \| rel path \| language	[3t] Text file
rv.V, I	TABLE \| rel path \| title,width,rows,align,head,num	[4t] Table file
rv.V, I	IMAGE \| rel path \| caption, scale, number	[5t] Image file
rv.V, I	IMAGE2 \| rel pth1, rel pth2 \| cap1,cap2,sca1,sca2,num	[6t] Adjacent images
rv.V	VALTABLE \| rel path \| title, rows, number	[7t] Valtable file
rv.V	a ==: 1*IN \| unit1, unit2, decimal \| label	[8t] Define value
rv.V	c <=: expression \| unit1, unit2, decimal \| label, number	[9t] Assign value
rv.V	c :=: expression \| unit1, unit2, decimal \| label, number	[9t] Function value
rv.V	a < c \| decimal \| text1, text2, color1, color2	[10t] Compare values
rv.V, T	PYTHON \| rel path \| namespace	[11t] Python file
rv.T	MARKUP \| rel path \| type	[12t] Markup file
rv.D	ATTACHPDF \| rel path \| place, title	[13t] Attach PDF
rv.D	PUBLISH \| doc title \| type	[14t] Publish doc

default paths for single docs

See here for the folder structure. If files are in the default path only the file name needs to be provided.

Command	Default Path
\| SHELL \|	folder root
\| TEXT \|	folder root
\| TABLE \|	folder root
\| IMAGE \|	folder root
\| IMAGE2 \|	folder root
\| VALTABLE \|	folder root
\| PYTHON \|	folder root
\| MARKUP \|	folder root
\| ATTACHPDF \|	folder root
\| PUBLISH \|	folder root

Default command paths for report

See here for the folder structure. If files are in the default path only the file name needs to be provided.

Command	Default Path
\| SHELL \|	/Files/Scripts/
\| TEXT \|	/Files/Data/
\| TABLE \|	/Files/Data/
\| IMAGE \|	/Files/Image/
\| IMAGE2 \|	/Files/Image/
\| VALTABLE \|	/Files/Data/ [1]
\| PYTHON \|	/Files/Scripts/
\| MARKUP \|	/Files/Scripts/
\| ATTACHPDF \|	/Files/Attach/
\| PUBLISH \|	depends on file type

[1] use /stored/data/filename to read values defined in the rivt file

[5t] Folders#

[rivt-]Report-Label/                  Report Folder Name
     ├── [.vscode]/                       optional VSCode settings
     ├── [rv101-]filename1.py             rivt file
     ├── [rv102-]filename2.py             rivt file
     ├── [rv201-]filename3.py             rivt file
     ├── [rv202-]filename4.py             rivt file
     ├── [_public]/                       public rivt files
         ├── rv_101-filename1.py
         ├── rv_102-filename1.py
         ├── rv_201-filename3.py
         └── rv_202-filename4.py
     ├── [_publish]/                      published docs and reports
         ├── [docs]/                      html output
             ├── _images/
             ├── _sources/
             ├── _static/
             ├── process folders/
             ├── site folders/
             ├── rv101-filename1.html
             ├── rv102-filename2.html
             ├── rv201-filename3.html
             ├── rv202-filename4.html
         ├── [pdfdocs]/                   pdf doc output
             ├── process folders/
             ├── rv-101-filename1.pdf
             ├── rv-102-filename1.pdf
             ├── rv-201-filename3.pdf
             └── rv-202-filename4.pdf
         └── [txtdocs]/                   text output
             ├── rv-101-filename1.txt
             ├── rv-102-filename1.txt
             ├── rv-201-filename3.txt
             └── rv-202-filename4.txt
     ├── [_stored]/                       stored files from rivt
         ├── [Logs]/                      log files
             ├── rv101-log.txt
             └── rv102-log.txt
         ├── [Sect]/                      stored sections
             ├── rv202-5d.txt
             ├── rv103-4t.txt
             └── rv301-2r.txt
         ├── [Temp]/                      temp files
             └── rv101-label3.tex
         └── [Vals]/                      stored value files
             ├── v101-2.csv
             └── v102-3.csv
     ├── [Rst_docs]/                      restructured text files
         ├── _downloads/
         ├── _static/
         ├── _locale/
         ├── _templates/
         ├── rv101-filename1.rst
         ├── rv102-filename2.rst
         ├── rv201-filename3.rst
         ├── rv202-filename4.rst
         ├── gen-html.cmd                 html generating script
         ├── gen-pdf.cmd                  pdf generating script
         ├── gen-pdftex.cmd               LaTeX generating script
         ├── rivt-report.py               report generating script
         ├── new-units.py                 define new units
         ├── coverpage.rst                cover page template
         ├── logoname.png                 cover page logo
         └── conf.py                      style paths and settings
             ├── [Src]                            source files from author
         ├── data/                        author created subfolder
             ├── data1.csv
             ├── opensees1.txt
             └── conc-vals.csv
         ├── image/                       author created subfolder
             ├── fig1.png
             └── fig2.jpg
         ├── [Run]/                       OS commands
                 ├── run1_win.cmd
                 └── run1_linux.sh
         ├── [Tools]/                     scripts and functions
                 ├── plot.py
                 └── loads.py
         └── [Vals]/                      value files
             ├── steel-vals.csv
             └── plastic-vals.csv
     └── README.txt                       searchable text report

[6t] Project requirements#

The minimum Python version is 3.14. A rivt project installation includes Python packages for:

document formatting
numerical analysis
symbolic processing
visualization

Dependency	description
“pyzo>=4.20.0”	lightweight IDE
“pyside6>=6.10.1”	QT bindings
“fastcore>=1.8.16”	code simplification
“tabulate>=0.9.0”	format tables
“pillow>=11.2.1”	image processing
“matplotlib>=3.10.1”	data visualization
“sympy>=1.13.3”	symbolic analysis
“numpy>=2.2.5”	numerical analysis
“scipy>=1.16.3”	numerical analysis
“pandas>=2.2.3”	data analysis
“docutils>=0.21.2”	reStructuredText processing
“ipython>=8.16.2”	interactive Python shell
“ipykernel>=6.28.1”	Jupyter kernel for Python
“reportlab>=4.4.0”	PDF generation without LaTeX
“rst2pdf>=0.103.1”	PDF generation without LaTeX
“pypdf>=1.0.3”	PDF manipulation
“Sphinx>=8.2.3”	HTML generation
“pydata-sphinx-theme>=0.16.1”	HTML generation
“sphinx-copybutton>=0.5.2”	HTML generation
“sphinx_design>=0.6.1”	HTML generation
“sphinx-favicon>=1.0.1”	HTML generation
“sphinx-togglebutton>=0.3.2”	HTML generation
“sphinxcontrib-applehelp>=2.0.0”	HTML generation
“sphinxcontrib-devhelp>=2.0.0”	HTML generation
“sphinxcontrib-email>=0.3.6”	HTML generation
“sphinxcontrib-htmlhelp>=2.1.0”	HTML generation
“sphinxcontrib-jquery>=4.1”	HTML generation
“sphinxcontrib-jsmath>=1.0.1”	HTML generation
“sphinxcontrib-qthelp>=2.0.0”	HTML generation
“sphinxcontrib-serializinghtml>=2.0.0”	HTML generation

[7t] VSCode settings#

Workspace extension and other settings are stored in the .vscode folder and can be included and moved as part of a rivt report. Settings that affect the rivt environment incldue:

rivt.code-snippets

settings.json (extension settings)

tasks.json

launch.json

Global settings can be exported and imported using VSCode Profiles. VSCode rivt extensions and settings may be installed from this link.

Extensions	description
BUTTONS	—
tombonnike.vscode-status-bar-format-toggle	format button
gsppvo.vscode-commandbar	command buttons
AdamAnand.adamstool	command buttons
nanlei.save-all	save all button
Ho-Wan.setting-toggle	toggle settings
yasukotelin.toggle-panel	toggle panel
fabiospampinato.vscode-commands	user command buttons
jerrygoyal.shortcut-menu-bar	menu bar
EDITING	—
henryclayton.context-menu-toggle-comments	toggle comments
TroelsDamgaard.reflow-paragraph	wrap paragraph
streetsidesoftware.code-spell-checker	spell check
jmviz.quote-list	quote elements in a list
njpwerner.autodocstring	insert doc string
oijaz.unicode-latex	unicode symbols from latex
jsynowiec.vscode-insertdatestring	insert date string
janisdd.vscode-edit-csv	csv editor
VIEWS	—
GrapeCity.gc-excelviewer	excel viewer
SimonSiefke.svg-preview	svg viewer
tomoki1207.pdf	pdf viewer
RandomFractalsInc.vscode-data-preview	data viewing tools
Fr43nk.seito-openfile	open file from path
vikyd.vscode-fold-level	line folding tool
file-icons.file-icons	icon library
tintinweb.vscode-inline-bookmarks	inline bookmarks
MANAGEMENT	—
alefragnani.project-manager	folder, project management
Anjali.clipboard-history	clipboard history
dionmunk.vscode-notes	notepad
hbenl.vscode-test-explorer	test explorer
mightycoco.fsdeploy	save file to second location
lyzerk.linecounter	count lines in files
sandcastle.vscode-open	open files in default app
zjffun.snippetsmanager	snippet manager
spmeesseman.vscode-taskexplorer	task explorer
GITHUB	—
GitHub.codespaces	run files in codespaces
GitHub.remotehub	run remote files
ettoreciprian.vscode-websearch	search github within VSCode
donjayamanne.githistory	git history
MichaelCurrin.auto-commit-msg	git auto commit message
github.vscode-github-actions	github actions
GitHub.vscode-pull-request-github	github pull request
k9982874.github-gist-explorer	gist explorer
vsls-contrib.gistfs	gist tools
PYTHON	—
ms-python.autopep8	python pep8 formatting
ms-python.isort	python sort imports
donjayamanne.python-environment-manager	python library list
ms-python.python	python tools
ms-python.vscode-pylance	python language server
ms-toolsai.jupyter	jupyter tools
ms-toolsai.jupyter-keymap	jupyter tools
ms-toolsai.jupyter-renderers	jupyter tools
ms-toolsai.vscode-jupyter-cell-tags	jupyter tools
ms-toolsai.vscode-jupyter-slideshow	jupyter tools
LANGUAGES	—
qwtel.sqlite-viewer	sqlite tools
RDebugger.r-debugger	R tools
REditorSupport.r	R tools
ms-vscode-remote.remote-wsl	windows linux tools
James-Yu.latex-workshop	latex tools
lextudio.restructuredtext	restructured text tools
trond-snekvik.simple-rst	restructured syntax
yzane.markdown-pdf	markdown to pdf
yzhang.markdown-all-in-one	markdown tools

Snippets/Keys	description
run	API Run function
ins	API Insert function
val	API Values function
too	API Tools function
wri	API Write function
alt+q	rewrap paragraph with hard line feeds (80 default)
alt+p	open file under cursor
alt+.	select correct spelling under cursor
alt+8	insert date
alt+9	insert time
ctl+1	focus on first editor
ctl+2	focus on next editor
ctl+3	focus on previous editor
ctl+8	focus on explorer pane
ctl+9	focus on github pane
ctl+alt+x	reload window
ctl+alt+[	reload window
ctl+alt+]	unfold all code
ctl+alt+u	unfold all code
ctl+alt+f	fold code level 2 (rivt sections visible)
ctl+alt+a	fold code - all levels
ctl+alt+t	toggle local fold
ctl+alt+e	toggle explorer sort order
ctl+alt+s	toggle spell check
ctl+alt+g	next editor group
ctl+shift+u	open URL under cursor in browser
ctl+shift+s	open GitHub README search for rivt
ctl+shift+a	commit all
ctl+shift+z	commit the current editor
ctl+shift+x	post to remote

Keystroke	Description
alt+q	rewrap paragraph with hard line feeds (80 default)
alt+p	open file under cursor
alt+.	select correct spelling under cursor
alt+8	insert date
alt+9	insert time
ctl+1	focus on first editor
ctl+2	focus on next editor
ctl+3	focus on previous editor
ctl+8	focus on explorer pane
ctl+9	focus on github pane
ctl+alt+x	reload window
ctl+alt+u	unfold all code
ctl+alt+f	fold code level 2 (rivt sections visible)
ctl+alt+a	fold code - all levels
ctl+alt+t	toggle local fold
ctl+alt+e	toggle explorer sort order
ctl+alt+s	toggle spell check
ctl+alt+g	next editor group
ctl+shift+u	open URL under cursor in browser
ctl+shift+s	open GitHub rivt README search
ctl+shift+a	commit all
ctl+shift+z	commit current editor
ctl+shift+x	post to remote