Spectral Effect
Incomplete
This section is yet to be completed.
Spectral Factor¶
Usage: pvgis-prototype performance spectral-factor [OPTIONS] IRRADIANCE
LONGITUDE LATITUDE
ELEVATION [TIMESTAMPS]
⋅ Estimate the spectral factor
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * longitude FLOAT RANGE Longitude in decimal degrees ranging in [-180, 360]. If ranging in [0, 360], consider the `--convert-longitude-360` option. │
│ [required] │
│ * latitude FLOAT RANGE Latitude in decimal degrees ranging in [-90, 90] [required] │
│ * elevation FLOAT RANGE Topographical elevation [required] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Solar irradiance spectrum ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * irradiance PARSE_IRRADIANCE_DATA [default: None] [required] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Timestamps ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ timestamps [TIMESTAMPS] 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 ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --limit-spectral-range --no-limit-spectral-range Limit the spectral range of the irradiance input data. Default for │
│ `spectral_factor_model = Pelland` │
│ [default: no-limit-spectral-range] │
│ --resample-large-series --no-resample-large-series [default: no-resample-large-series] │
│ --show-footer --no-show-footer Show output table footer [default: show-footer] │
│ --log -l INTEGER 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! [default: None] │
│ --periods INTEGER Number of timestamps to generate [default: None] │
│ --frequency TEXT 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. │
│ [default: None] │
│ --end-time,--et PARSE_TIMESTAMP End timestamp of the period. Overrides the `timestamps` parameter! [default: None] │
│ --timezone,--tz,--zone PARSE_TIMEZONE Timezone (e.g., 'Europe/Athens'). Use the system's time zone via the `--local` option. │
│ [default: None] │
│ --random-timestamps --no-random-timestamps Generate a random date, time and timezone to demonstrate calculation │
│ [default: no-random-timestamps] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Spectral responsivity ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --responsivity PARSE_SPECTRAL_RESPONSIVITY Spectral responsivity of a photovoltaic device │
│ expressed in units A/W (amperes per watt) is the │
│ electrical current (in amperes) per unit of incident │
│ optical power (in watts) at specific wavelengths (CSV │
│ string or file, examples: 'path_to_file.csv' or │
│ '400,0.3; 500,0.5; 600,0.2') │
│ --integrate-responsivity --no-integrate-responsivity Integrate the spectral responsivity over Kato bands │
│ [default: no-integrate-responsivity] │
│ --responsivity-column TEXT Column name for responsivity values in `responsivity` │
│ CSV input │
│ --photovoltaic-module-type [all|cSi|aSi|monoSi|polySi|FS3|FS6|CIGS] Photovoltaic module type for the spectral │
│ responsivity. Column names in CSV input must match │
│ this option's listed types! │
│ [default: cSi] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ External time series selection ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --wavelength-column TEXT Column name for wavelength values in `wavelength` CSV input │
│ --spectrally-resolved-irradiance TEXT Variable name │
│ --average-irradiance-density TEXT Variable name │
│ --neighbor-lookup [None|pad|backfill|nearest] Enable nearest neighbor (inexact) lookups. Read Xarray manual on │
│ nearest-neighbor-lookups │
│ [default: nearest] │
│ --tolerance FLOAT Maximum distance between original & new labels for inexact matches. │
│ Read Xarray manual on nearest-neighbor-lookups │
│ [default: 0.1] │
│ --mask-and-scale --no-mask-and-scale Mask and scale the series [default: no-mask-and-scale] │
│ --in-memory --no-in-memory Use in-memory processing [default: no-in-memory] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Solar irradiance spectrum ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --min-wavelength FLOAT Minimum wavelength for spectral irradiance range │
│ [default: 280] │
│ --max-wavelength FLOAT Maximum {spectral_irradiance_wavelength_limit_typer_help} │
│ [default: 4000] │
│ --reference-spectrum PARSE_REFERENCE_SPECTRUM The reference spectrum to use for the mismatch calculation. │
│ User-defined input Yet not complete! The default is the │
│ ASTM G173-03 global tilted spectrum. [(W/m^2)/nm] │
│ [default: None] │
│ --integrate-reference-spectrum --no-integrate-reference-spectrum Integrate the reference spectrum over Kato bands │
│ [default: no-integrate-reference-spectrum] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Spectral factor ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --spectral-factor-model [all|pvlib|Pelland|Huld] Spectral factor model [default: pvlib] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Data processing ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --dtype TEXT Data type [default: float32] │
│ --array-backend TEXT Array backend [default: numpy] │
│ --multi-thread --no-multi-thread Multi threading [default: multi-thread] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ > Input : < Output ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --rounding-places -r INTEGER Number of digits to round results to [default: 3] │
│ --csv PATH CSV output filename [default: None] │
│ --verbose -v INTEGER 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 ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --analysis --no-analysis Analysis of performance. Will force verbose=9 (for detailed calculations) and quiet=True. [default: no-analysis] │
│ --statistics --no-statistics Calculate and display summary statistics [default: no-statistics] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ 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] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯