D.3 Folders

<i>

[1] File Names

---

A rivt report is assembled from a set of docs. Reports are organized using doc numbers. If the rivt file names are:

rvA01-filename.py
rv105-filename.py

The report numbers used in the published report would be:

A.1
1.5
2.12

where leading zeroes are dropped and docs are sorted alpha-numerically into divisions and subdivisions in the report.

<i>

[2] Report Folders

---

Reports are organized under a single root report folder with the prefix rivt-. rivt files are stored in the root folder and rivt markup file paths are relative to the roo. Resource files are stored in four primary subfolders:

public

Includes rivt files written by rivtlib intended for upload to a public repository.

publish

Includes formatted docs and reports written by rivtlib.

src

Includes author provided content, style and generating files for docs and reports.

stored

Includes output files written by rivtlib including logs, values, hidden, and metadata and reports

An example report folder structure is shown below.

Folder Key

Required names or prefixes are shown in brackets [ ].

Folders (including subfolders) that contain author generated files are marked with a single vertical bar ( | ).

Folders (including subfolders) that contain rivtlib generated files are marked with double vertical bars ( || ).

Top Level Folders

[rivt]-Report-Label/                Report Folder Name
    ├── [rv101-]filename1.py        | rivt file
    ├── [rv102-]filename2.py        | rivt file
    ├── [rv201-]filename3.py        | rivt file
    ├── [rv202-]filename4.py        | rivt file

    ...

    ├── [public]/                   || public rivt files
    ├── [publish]/                  || doc and report files
    ├── [src]/                      |  source files from author
    ├── [stored]/                   || rivt stored files
    └── README.txt                  || searchable text report

Expanded Folders

[rivt]-Report-Label/                Report Folder Name
    ├── [rv101-]filename1.py               | rivt input files
    ├── [rv102-]filename2.py
    ├── [rv201-]filename3.py
    ├── [rv202-]filename4.py
    ├── [public]/                          || public rivt files
        ├── rv-101-filename1.py
        ├── rv-201-filename3.py
        └── rv-202-filename4.py
    ├── [publish]/                         || reports and docs
        ├── [html]/                              HTML site
            ├── [docs]/
                ├── _images/
                ├── _sources/
                ├── _static/
                ├── rv101-filename1.html
                ├── rv102-filename2.html
                ├── rv201-filename3.html
                ├── rv201-filename4.html
                └── index.html                   HTML site entry point
            ├── rv101-filename1.rst              intermediate rst files
            ├── rv102-filename2.rst
            ├── rv201-filename3.rst
            └── rv202-filename4.rst
        ├── [pdf]/                               PDF from rst2pdf
            ├── [src]/                           intermediate rst files
                ├── rv101-filename1.rst
                ├── rv102-filename2.rst
                ├── rv201-filename3.rst
                └── rv202-filename4.rst
            ├── rv101-filename1.pdf              PDF docs from rst2pdf
            ├── rv102-filename2.pdf
            ├── rv201-filename3.pdf
            ├── rv202-filename4.pdf
            └── Report-Label.pdf                 PDF report from rst2pdf
        ├── [pdftex]/                            PDF from LaTeX
            ├── [src]/                           intermediate rst files
                ├── rv101-filename1.rst
                ├── rv102-filename2.rst
                ├── rv201-filename3.rst
                └── rv202-filename4.rst
            ├── rv101-filename1.pdf              PDF docs from LaTeX
            ├── rv102-filename2.pdf
            ├── rv201-filename3.pdf
            ├── rv202-filename4.pdf
            └── Report-Label.pdf                 PDF report from LaTeX
        ├── [text]/                              text report
            ├── rv101-filename1.txt              text docs
            ├── rv102-filename2.txt
            ├── rv201-filename3.txt
            ├── rv202-filename4.txt
            └── README.txt                       searchable text report
    ├── [src]                              | source files from author
        ├── data/                               author created subfolder
            ├── data1.csv
            └── conc-vals.csv
        ├── image/                              author created subfolder
            ├── fig1.png
            └── fig2.jpg
        ├── output/                             author created subfolder
            ├── table1.csv
            ├── image1.png
            └── opensees1.txt
        ├── [gendoc]/
            ├── genhtml.cmd                     html generating script
            ├── genpdf.cmd                      pdf generating script
            ├── gentexpdf.cmd                   LaTeX generating script
            ├── rivt-report.py                   report generating script
            ├── new-units.py                     define new units
            └── [style]/                         style files for docs
                ├── [html]/                      html style files
                    ├── _locale/
                    ├── _static/
                    ├── _templates/
                    ├── conf.py
                    ├── genhtml.cmd
                    └── index.rst
                ├── [pdf]/                       rst2pdf style files
                    ├── fonts/
                    ├── style/
                    └── Report-Cover.pdf
                ├── [pdftex]/                    pdftex style files
                    ├── Report-cover.pdf
                    └── rivt.sty
                ├── [text]/                      text ini file
                    └── rv-text.ini
        ├── [py]/                                Python scripts and functions
                ├── plot.py
                └── loads.py
        └── [vals]/                              value files
            ├── steel-vals.csv
            └── plastic-vals.csv
    ├── [stored]/                          || stored files from rivt
        ├── [hide]/                              hidden
            ├── rv202-5d-Beams.txt
            ├── rv103-4t-Deflection.txt
            └── rv301-2r-OpenSees.txt
        ├── [logs]/                              log files
            ├── rv101-api.txt
            ├── rv101-log.txt
            └── rv102-log.txt
        ├── [meta]/                              meta data files
            ├── rv101-meta.txt
            └── rv102-meta.txt
        ├── [temp]/                              temp files
            └── rv101-standards.tex
        └── [vals]/                              stored value files
            ├── v101-2-bracket.csv
            └── v102-3-materials.csv
    └── README.txt                         || searchable text report