Running PVade

This page shows how to launch PVade simulations from the repository root.

Requirements

  • A working PVade environment

  • A valid YAML input file

  • ParaView (optional, for visualization of XDMF outputs)

Note

If a parameter is omitted in your YAML file, PVade uses the default value from the input schema.

Basic Command

Run PVade with:

conda run -n PVade python pvade_main.py --input <path-to-yaml>

Example Inputs In This Repository

The table below lists example YAML files currently present in this branch.

Example cases and input files

Case

Input file

Panels 2D

examples/panels2d.yaml

Panels 3D

examples/panels3d.yaml

Single heliostat 3D

examples/single_heliostat.yaml

Heated panels 2D

examples/heated_panels2d.yaml

Common Run Examples

Panels 3D:

conda run -n PVade python pvade_main.py --input examples/panels3d.yaml

Panels 2D:

conda run -n PVade python pvade_main.py --input examples/panels2d.yaml

Output Location

Output files are written to the directory set by general.output_dir in your input YAML. Typical contents include:

  • Mesh files under a mesh subdirectory

  • Solution files under a solution subdirectory

  • A run log file named logfile.log

CLI Parameter Overrides

You can override YAML values from the command line using dotted keys:

conda run -n PVade python pvade_main.py --input examples/panels3d.yaml --solver.dt 0.001 --solver.t_final 0.01

More On Input Parameters

For detailed parameter documentation, see Input File Parameters and Input Schema.

Controlling Terminal Verbosity

PVade’s terminal output is controlled by the PVADE_VERBOSITY environment variable. It accepts three levels:

  • 0: quiet mode; INFO messages are suppressed in the terminal (errors are always shown)

  • 1 (default): INFO messages are printed from rank 0 only

  • 2: verbose mode; INFO messages are printed from every MPI rank

Set it before launching a run, for example:

PVADE_VERBOSITY=2 conda run -n PVade python pvade_main.py --input examples/panels3d.yaml

Note

PVADE_VERBOSITY only affects what is echoed to the terminal. The full set of INFO-level messages is always written to logfile.log in the run’s output directory, regardless of the verbosity level.