Skip to content

Other irradiance tools

This page groups examples for additional irradiance tools.

Extraterrestrial

Calculate extraterrestrial normal irradiance time series:

pvgis irradiance extraterrestrial \
    --start-time "2014-01-01" \
    --end-time "2014-01-02" \
    --quiet

Inspect all options:

pvgis irradiance extraterrestrial --help
 Usage: pvgis irradiance extraterrestrial [OPTIONS] [timestamps]                                                        

 🌣 Calculate the extraterrestrial normal irradiance over a time series                                                  

╭─ Timestamps ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│   timestamps      <parse_timestamp_series>  Quoted date-time strings of data to extract from series, example:        │
│                                             '2112-12-21, 2112-12-21 12:21:21, 2112-12-21 21:12:12''                  │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --resample-large-series      --no-resample-large-series           [default: no-resample-large-series]                │
│ --log                    -l                                <int>  Enable logging [default: 0]                        │
│ --help                                                            Show this message and exit.                        │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Timestamps ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --start-time,--st                                   <parse_timestamp>  Start timestamp of the period. Overrides the  │
│                                                                        `timestamps` parameter!                       │
│ --periods                                           <int>              Number of timestamps to generate              │
│ --frequency                                         <str>              A common date/time frequency unit optionally  │
│                                                                        with a multiples number, such as H(hourly),   │
│                                                                        min(utely), S(econdly), D(aily), W(eekly),    │
│                                                                        M(onth end), Y(early) or 30min. See Pandas    │
│                                                                        time series offset aliases.                   │
│ --end-time,--et                                     <parse_timestamp>  End timestamp of the period. Overrides the    │
│                                                                        `timestamps` parameter!                       │
│ --timezone,--tz,--zone                              <parse_timezone>   Timezone (e.g., 'Europe/Athens'). Use the     │
│                                                                        system's time zone via the `--local` option.  │
│ --random-timestamps       --no-random-timestamps                       Generate a random date, time and timezone to  │
│                                                                        demonstrate calculation                       │
│                                                                        [default: no-random-timestamps]               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Earth orbit ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --solar-constant                        <float range> [x>=1360]  Top-of-Atmosphere mean solar electromagnetic        │
│                                                                  radiation (W/m-2) 1 au (astronomical unit) away     │
│                                                                  from the Sun.                                       │
│                                                                  [default: 1360.8]                                   │
│ --perigee-offset                        <float>                  Perigee offset [default: 0.048869]                  │
│ --eccentricity-correction-factor        <float>                  Eccentricity correction factor [default: 0.03344]   │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Data processing ────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --dtype                <str>  Data type [default: float32]                                                           │
│ --array-backend        <str>  Array backend [default: numpy]                                                         │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ > Input : < Output ─────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --rounding-places  -r      <int>   Number of digits to round results to [default: 3]                                 │
│ --csv                      <path>  CSV output filename                                                               │
│ --verbose          -v      <int>   Show details while executing commands [default: 0]                                │
│ --index,--idx      -i              Index rows in output table (meaningful with at least 1x -v)                       │
│ --quiet                            Do not print out the output                                                       │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Statistics ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --statistics    --no-statistics           Calculate and display summary statistics [default: no-statistics]          │
│ --groupby                          <str>  Group statistics, ex. M or 3h. A number and date/time unit : (Y)ear,       │
│                                           (S)eason, (M)onth, (D)ay, (W)eek, (h)our. See Xarray's group-by            │
│                                           operations.                                                                │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Plotting ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --uniplot                    --no-uniplot             Plot the PV power output time series in the terminal           │
│                                                       [default: no-uniplot]                                          │
│ --terminal-width-fraction                    <float>  Fraction of number of columns of the current terminal, ex. 0.9 │
│                                                       [default: 0.9]                                                 │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Metadata ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --fingerprint,--fp                       Fingerprint the output time series                                          │
│ --metadata            --no-metadata      Print command metadata [default: no-metadata]                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Loss

Under development

This feature is under development.

The toolbox command for irradiance-loss-related effects is currently exposed as reflectivity.

pvgis irradiance reflectivity --help
 Usage: pvgis irradiance reflectivity [OPTIONS] COMMAND [ARGS]...                                                       

 ⦟ Calculate the reflectivity effect factor for inclined irradiance components Yet not complete!                        

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Toolbox ──────────────────────────────────────────────────────────────────────────────────────────────────╮
│ direct    ⦟ Solar incidence angle modifier for direct irradiance due to reflectivity Yet not complete!     │
│ indirect  ⦟ Solar incidence angle modifier for non-direct irradiance due to reflectivity Yet not complete! │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Limits

Show available limits subcommands:

pvgis irradiance limits --help
 Usage: pvgis irradiance limits [OPTIONS] COMMAND [ARGS]...                                                             

 [⸾] Calculate physically possible irradiance limits                                                                    

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ External solar irradiance time series ─────────╮
│ physical  Calculate physically possible limits. │
│ rare      Calculate extremely rare limits.      │
╰─────────────────────────────────────────────────╯

Example with physically possible limits:

pvgis irradiance limits physical 0.8
  Component          Min          Max  
 ───────────────────────────────────── 
  Global SWdn          0   2140.96124  
  Global SW dn         0   2140.96124  
  Diffuse SW           0   1342.60879  
  Direct Normal SW     0       1360.8  
  Direct SW            0   1360.66735  
  SWup                 0   1682.76899  
  LWdn                40          700  
  LWup                40          900