FARIS / Documentation

FARIS documentation

The FARIS handbook covers FARIS 0.2.0: the download, a tour of each step, uncertainty, computed maintenance, files and the command line, and how to read the numbers.

Start here

FARIS 0.2.0 is a deliberately narrow demo, complete for one study. It runs on Linux (glibc 2.35 or newer: Ubuntu 22.04 or later, Debian 12 or later), Windows and macOS. Every platform’s programs are built by CI from the release commit. New in 0.2.0: replacement outages computed from decay heat. The handbook covers the download and its checks, then a tour of the recorded study.

The five steps

The workspace has five steps: Design, Simulate, Operate, Compare and Evidence. The top bar has one button for each, and the keys 1 to 5 switch between them.

Uncertainty

An ensemble carries the Monte Carlo sampling uncertainty of the transport through the 30-year history. Each continuous output shows its nominal value beside the median and the 5 to 95 per cent range.

Computed maintenance durations

New in 0.2.0: replacement outages worked out from the decay heat of the parts around each replaced component, through ACTINV, and compared with the fixed durations design by design. The download includes a recorded result; computing a new one needs ACTINV and your own transport runs.

Files and the command line

A .faris file is one saved study. An export is a folder a colleague can read without FARIS. The package also holds faris, the command line, which needs no graphics, Python, OpenMC or Avila Core, except for the commands marked in the handbook.

Reading the results

Every value in FARIS carries a badge that says what kind of number it is. FARIS never leaves a bare unknown: every value that is not evaluated says why and what the next step is.

FARIS 0.2.0 is research-screening software. Its results are not a licensing, safety or design basis.

Releases and roadmap

FARIS follows semantic versioning from 0.1.0. The next steps build on the same study.