Features

Overview¶

Help

For each command, there is a --help option.
Versioning

Which version of the software am I running ?
```
pvgis-prototype --version
```
Auto-Completion

Auto-completion in the command line ?
```
pvgis-prototype completion --help
```

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,

pvgis-prototype

or

pvgis-prototype --help

Example

pvgis-prototype --help

 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 │
╰───────────────────────────────────────────────╯

Version ¶

It might be useful to know which version of the software we have installed :

pvgis-prototype --version

PVGIS prototype version: 0.8.9.dev1979+g176828911.d20251123

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

pvgis-prototype completion --help

 Usage: pvgis-prototype 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.                       │
╰─────────────────────────────────────────────────────────────────────────────╯