h2integrate.resource.solar.nrel_developer_goes_api_models#
Classes
|
Configuration class to download solar resource data from GOES Aggregated PSM v4. |
|
|
|
Configuration class to download solar resource data from GOES Conus PSM v4. |
|
|
|
Configuration class to download solar resource data from GOES Full Disc PSM v4. |
|
|
|
|
|
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESAggregatedAPIConfig(*, latitude, longitude, timezone, use_fixed_resource_location=True, resource_year, dataset_desc='goes_aggregated_v4', resource_type='solar', valid_intervals=NOTHING, resource_data={}, resource_filename='', resource_dir=None)#
Configuration class to download solar resource data from GOES Aggregated PSM v4. This dataset covers regions within North and South America at a spatial resolution of 4 km.
- Parameters:
resource_year (int) -- Year to use for resource data. Must been between 1998 and 2024 (inclusive).
resource_data (dict | object, optional) -- Dictionary of user-input resource data. Defaults to an empty dictionary.
resource_dir (str | Path, optional) -- Folder to save resource files to or load resource files from. Defaults to "".
resource_filename (str, optional) -- Filename to save resource data to or load resource data from. Defaults to None.
latitude (float)
longitude (float)
timezone (int | float)
use_fixed_resource_location (bool)
dataset_desc (str)
resource_type (str)
valid_intervals (list[int])
- dataset_desc#
description of the dataset, used in file naming. For this dataset, the dataset_desc is "goes_aggregated_v2".
- Type:
str
- resource_type#
type of resource data downloaded, used in folder naming. For this dataset, the resource_type is "solar".
- Type:
str
- valid_intervals#
time interval(s) in minutes that resource data can be downloaded in. For this dataset, valid_intervals are 30 and 60 minutes.
- Type:
list[int]
- resource_year: int#
- dataset_desc: str#
- resource_type: str#
- valid_intervals: list[int]#
- resource_data: dict | object#
- resource_filename: Path | str#
- resource_dir: Path | str | None#
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESAggregatedSolarAPI(**kwargs)#
- setup()#
Declare inputs and outputs.
- Available attributes:
name pathname comm options
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESConusAPIConfig(*, latitude, longitude, timezone, use_fixed_resource_location=True, resource_year, dataset_desc='goes_conus_v4', resource_type='solar', valid_intervals=NOTHING, resource_data={}, resource_filename='', resource_dir=None)#
Configuration class to download solar resource data from GOES Conus PSM v4. This dataset covers regions within the continental United States at a spatial resolution of 2 km.
- Parameters:
resource_year (int) -- Year to use for resource data. Must been between 2018 and 2024 (inclusive).
resource_data (dict | object, optional) -- Dictionary of user-input resource data. Defaults to an empty dictionary.
resource_dir (str | Path, optional) -- Folder to save resource files to or load resource files from. Defaults to "".
resource_filename (str, optional) -- Filename to save resource data to or load resource data from. Defaults to None.
latitude (float)
longitude (float)
timezone (int | float)
use_fixed_resource_location (bool)
dataset_desc (str)
resource_type (str)
valid_intervals (list[int])
- dataset_desc#
description of the dataset, used in file naming. For this dataset, the dataset_desc is "goes_aggregated_v2".
- Type:
str
- resource_type#
type of resource data downloaded, used in folder naming. For this dataset, the resource_type is "solar".
- Type:
str
- valid_intervals#
time interval(s) in minutes that resource data can be downloaded in. For this dataset, valid_intervals are 5, 15, 30 and 60 minutes.
- Type:
list[int]
- resource_year: int#
- dataset_desc: str#
- resource_type: str#
- valid_intervals: list[int]#
- resource_data: dict | object#
- resource_filename: Path | str#
- resource_dir: Path | str | None#
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESConusSolarAPI(**kwargs)#
- setup()#
Declare inputs and outputs.
- Available attributes:
name pathname comm options
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESFullDiscAPIConfig(*, latitude, longitude, timezone, use_fixed_resource_location=True, resource_year, dataset_desc='goes_fulldisc_v4', resource_type='solar', valid_intervals=NOTHING, resource_data={}, resource_filename='', resource_dir=None)#
Configuration class to download solar resource data from GOES Full Disc PSM v4. This dataset covers regions within North and South America at a spatial resolution of 2 km.
- Parameters:
resource_year (int) -- Year to use for resource data. Must been between 2018 and 2024 (inclusive).
resource_data (dict | object, optional) -- Dictionary of user-input resource data. Defaults to an empty dictionary.
resource_dir (str | Path, optional) -- Folder to save resource files to or load resource files from. Defaults to "".
resource_filename (str, optional) -- Filename to save resource data to or load resource data from. Defaults to None.
latitude (float)
longitude (float)
timezone (int | float)
use_fixed_resource_location (bool)
dataset_desc (str)
resource_type (str)
valid_intervals (list[int])
- dataset_desc#
description of the dataset, used in file naming. For this dataset, the dataset_desc is "goes_aggregated_v2".
- Type:
str
- resource_type#
type of resource data downloaded, used in folder naming. For this dataset, the resource_type is "solar".
- Type:
str
- valid_intervals#
time interval(s) in minutes that resource data can be downloaded in. For this dataset, valid_intervals are 10, 30 and 60 minutes.
- Type:
list[int]
- resource_year: int#
- dataset_desc: str#
- resource_type: str#
- valid_intervals: list[int]#
- resource_data: dict | object#
- resource_filename: Path | str#
- resource_dir: Path | str | None#
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESFullDiscSolarAPI(**kwargs)#
- setup()#
Declare inputs and outputs.
- Available attributes:
name pathname comm options
- class h2integrate.resource.solar.nrel_developer_goes_api_models.GOESTMYAPIConfig(*, latitude, longitude, timezone, use_fixed_resource_location=True, resource_year, dataset_desc='goes_tmy_v4', resource_type='solar', valid_intervals=NOTHING, resource_data={}, resource_filename='', resource_dir=None)#
Configuration class to download solar resource data from GOES Full Disc PSM v4. This dataset covers regions within North and South America at a spatial resolution of 4 km.
- Parameters:
resource_year (str) -- Year to use for resource data. Can be any of the following: tmy-2022, tdy-2022, tgy-2022, tmy-2023, tdy-2023, tgy-2023, tmy-2024, tdy-2024, or tgy-2024.
resource_data (dict | object, optional) -- Dictionary of user-input resource data. Defaults to an empty dictionary.
resource_dir (str | Path, optional) -- Folder to save resource files to or load resource files from. Defaults to "".
resource_filename (str, optional) -- Filename to save resource data to or load resource data from. Defaults to None.
latitude (float)
longitude (float)
timezone (int | float)
use_fixed_resource_location (bool)
dataset_desc (str)
resource_type (str)
valid_intervals (list[int])
- dataset_desc#
description of the dataset, used in file naming. For this dataset, the dataset_desc is "goes_aggregated_v2".
- Type:
str
- resource_type#
type of resource data downloaded, used in folder naming. For this dataset, the resource_type is "solar".
- Type:
str
- valid_intervals#
time interval(s) in minutes that resource data can be downloaded in. For this dataset, valid_intervals is minutes.
- Type:
list[int]
- resource_year: str#
- dataset_desc: str#
- resource_type: str#
- valid_intervals: list[int]#
- resource_data: dict | object#
- resource_filename: Path | str#
- resource_dir: Path | str | None#