Skip to content

CLI

Toolbox Overview

PVGIS is also a collection of command line tools. Welcome yourself in the PVGIS command line interface (CLI) !

pvgis-prototype
 Usage: pvgis-prototype [OPTIONS] COMMAND [ARGS]...                                                                                                             

 PVGIS Command Line Interface prototype                                                                                                                         

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version                                       Show the version of the application and exit                                                                 │
│ --log                          -l      INTEGER  Enable logging [default: None]                                                                               │
│ --log-rich-handler,--log-rich                   Use RichHandler along with `--log` to prettify logs                                                          │
│ --log-file                             PATH     Specify a log file to write logs to [default: None]                                                          │
│ --help                                          Show this message and exit.                                                                                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ > Input : < Output ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --verbose  -v      INTEGER  Show details while executing commands [default: 0]                                                                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Reference ─────────────────────────────────────────╮
│ conventions   📜 Conventions in PVGIS' calculations │
│ symbols       🔣 List the symbols used in PVGIS     │
│ cite          📄 Generate citation text for PVGIS   │
│ manual        📖 Manual for solar radiation terms   │
╰─────────────────────────────────────────────────────╯
╭─ Photovoltaic Performance ────────────────────────────────────────────────────────────╮
│ performance   % Estimate the performance of a photovoltaic system over a time series │
│ power         ⌁ Estimate the photovoltaic power over a time series                    │
╰───────────────────────────────────────────────────────────────────────────────────────╯
╭─ Time Series ──────────────────────────────────────────────────────────────╮
│ irradiance    ⸾ Calculate the solar irradiance incident on a solar surface │
│ meteo         🌦 Meteorology & Typical Meteorological Year                  │
│ series        󰱐 Work with time series                                      │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Solar Position ───────────────────────────────────────────────────────────────────────────────╮
│ time          󱩷 Calculate the solar time for a location and moment                             │
│ position      🌞 Calculate solar position parameters for a location and moment in time         │
│ surface       󰶛  Calculate solar surface geometry parameters for a location and moment in time │
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Data Model ──────────────────────────────────╮
│ data-model    ⎄ Tooling for PVGIS' Data Model │
╰───────────────────────────────────────────────╯