calibsunapi.models package
Submodules
calibsunapi.models.listplants module
- class calibsunapi.models.listplants.Plant(site_id: str, name: str, latitude: float, longitude: float, elevation: float, peakpower: float, tracker: bool, tilt: float, azimut: float, tilt_gti: float | None, azimut_gti: float | None, rendement_stc: float, coefficient_temperature: float, dc_ac: float, backtracking: bool, maxangle: float, entraxe: float, panel_length: float, coefficient_irradiance: float, coefficient_log_irradiance: float, u_tamb_to_tcell: float, client: ForwardRef('CalibsunApiClient') | None = None)
Bases:
object- azimut: float
- azimut_gti: float | None
- backtracking: bool
- client: CalibsunApiClient | None = None
- coefficient_irradiance: float
- coefficient_log_irradiance: float
- coefficient_temperature: float
- dc_ac: float
- elevation: float
- entraxe: float
- get_deterministic_forecast(time: str, target: str)
Retrieve the deterministic forecast for a specific time and target.
- Parameters:
time (str) – The time for which the forecast is requested.
target (str) – The target parameter for the forecast.
- Returns:
The deterministic forecast data retrieved from the client.
- Return type:
dict
- get_forecast(time: str, target: str)
Retrieve the forecast for a specific time and target.
- Parameters:
time (str) – The time for which the forecast is requested.
target (str) – The target for which the forecast is requested.
- Returns:
The forecast data retrieved from the client.
- Return type:
dict
- get_forecast_availability(target: str, start_date: datetime = datetime.datetime(2025, 5, 27, 9, 1, 41, 128754, tzinfo=datetime.timezone.utc), end_date: datetime = datetime.datetime(2025, 5, 28, 9, 1, 41, 128763, tzinfo=datetime.timezone.utc))
Check the availability of forecasts for a specific target.
- Parameters:
target (str) – The target for which to check forecast availability.
- Returns:
A dictionary indicating the availability of forecasts for the specified target.
- Return type:
dict
- get_historical_deterministic_forecast(forecast_datetime: str, target: str)
Retrieve the historical deterministic forecast for a specific datetime and target.
- Parameters:
forecast_datetime (str) – The datetime for which the deterministic forecast is requested.
target (str) – The target parameter for the forecast.
- Returns:
The historical deterministic forecast data.
- Return type:
dict
- get_historical_forecast(forecast_datetime: str, target: str)
Retrieve the historical forecast for a specific datetime and target.
- Parameters:
forecast_datetime (str) – The datetime for which the forecast is requested.
target (str) – The target parameter for the forecast.
- Returns:
The historical forecast data.
- Return type:
dict
- get_historical_probabilistic_forecast(forecast_datetime: str, target: str)
Retrieve the historical probabilistic forecast for a specific datetime and target.
- Parameters:
forecast_datetime (str) – The datetime for which the probabilistic forecast is requested.
target (str) – The target parameter for the forecast.
- Returns:
The historical probabilistic forecast data.
- Return type:
dict
- get_latest_forecast(target: str)
Retrieve the latest forecast for a specified target.
- Parameters:
target (str) – The target for which to retrieve the latest forecast.
- Returns:
The latest forecast data for the specified target.
- Return type:
dict
- get_latest_forecast_deterministic(target: str)
Retrieve the latest deterministic forecast for a given target.
- Parameters:
target (str) – The target for which the latest deterministic forecast is requested.
- Returns:
The latest deterministic forecast data for the specified target.
- Return type:
dict
- get_latest_forecast_probabilistic(target: str)
Retrieve the latest probabilistic forecast for a given target.
- Parameters:
target (str) – The target for which to retrieve the forecast.
- Returns:
The latest probabilistic forecast data for the specified target.
- Return type:
dict
- get_probabilistic_forecast(time: str, target: str)
Retrieve the probabilistic forecast for a given time and target.
- Parameters:
time (str) – The specific time for which the forecast is requested.
target (str) – The target parameter for the forecast (e.g., ghi, gti, prod).
- Returns:
A dictionary containing the probabilistic forecast data.
- Return type:
dict
- latitude: float
- longitude: float
- maxangle: float
- name: str
- panel_length: float
- peakpower: float
- push_measurements(format: str, data: dict[str, str] = None, filepath: str = None)
Push measurements to the server.
- Parameters:
format (str) – The format of the measurements data.
data (dict[str, str], optional) – A dictionary containing the measurements data. Defaults to None.
filepath (str, optional) – The file path to the measurements data file. Defaults to None.
- Returns:
The response from the server after pushing the measurements.
- Return type:
Response
- rendement_stc: float
- site_id: str
- tilt: float
- tilt_gti: float | None
- tracker: bool
- u_tamb_to_tcell: float