Features
Overview¶
-
Help
For each command, there is a
--helpoption. -
Versioning
Which version of the software am I running?
-
Auto-Completion
Auto-completion in the command line?
Help¶
For each and every command,
there is a --help option.
Please consult it to grasp the details for
a command,
its arguments and optional parameters,
default values
and settings that can further shape the output.
For example,
or
Example
Usage: pvgis [OPTIONS] COMMAND [ARGS]...
PVGIS Command Line Interface prototype
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version Show the version of the │
│ application and exit │
│ --log -l <int> Enable logging │
│ --log-rich-handler,--log-rich Use RichHandler along with │
│ `--log` to prettify logs │
│ --log-file <path> Optional log file │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ > Input : < Output ─────────────────────────────────────────────────────────╮
│ --verbose -v <int> Show details while executing commands [default: 0] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Reference ──────────────────────────────────────────────────────────────────╮
│ conventions Conventions in PVGIS' solar positioning, irradiance & │
│ photovoltaic performance calculations │
│ symbols Print the list of symbols used throughout PVGIS along with │
│ their description │
│ cite Generate citation text for PVGIS │
│ manual 📖 Manual for solar radiation terms │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Photovoltaic Performance ───────────────────────────────────────────────────╮
│ performance 🔌 Analyse the performance of a photovoltaic system over a tim… │
│ series │
│ power 🔌 Estimate the photovoltaic power over a time series │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Series ───────────────────────────────────────────────────────────────────╮
│ irradiance 🌞 Calculate the solar irradiance incident on a solar surface │
│ meteo 🌦 Typical Meteorological Year │
│ series Work with time series │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ 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 │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Toolbox ─────────────────────────────╮
│ utilities 🧰 Diagnostic functions │
╰───────────────────────────────────────╯
Version ¶
It might be useful to know which version of the software we have installed:
Auto-Completion¶
Auto-completion in the command line can be installed optionally.
This is offered via the hidden command completion.
Auto-completion in the command line
Usage: pvgis completion [OPTIONS] COMMAND [ARGS]...
Generate and install completion scripts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ show Show completion for the specified shell, to copy or customize it. │
│ install Install completion for the specified shell. │
╰────────────────────────────────────────────────────────────────────────────╯