Solar
Solar
- class Solar(start='2021-05-01', end='2021-09-01', normalise=True, return_full_df=False, api_version='v4')[source]
Load the GB National Solar Estimates dataset for time series forecasting.
This class wraps the Sheffield Solar PV_Live API to extract national solar data for the GB electricity network. Note that these are estimates of the true solar generation, as the true values are “behind the meter” and unknown.
- Parameters:
- startstring, default=”2021-05-01”
The start date of the time series in “YYYY-MM-DD” format.
- endstring, default=”2021-09-01”
The end date of the time series in “YYYY-MM-DD” format.
- normaliseboolean, default=True
Normalise the returned time series by installed capacity.
- return_full_dfboolean, default=False
Return a pd.DataFrame with power, capacity, and normalised estimates.
- api_versionstring or None, default=”v4”
API version to call. If None, a stored sample of the data is loaded.
Notes
The returned time series is half-hourly. For more information, refer to:
References
Examples
>>> from sktime.datasets.forecasting import Solar >>> y = Solar().load("y")
Methods
cache_files_directory()Get the directory where cache files are stored.
cleanup_cache_files()Cleanup cache files from the cache directory.
clone()Obtain a clone of the object with same hyper-parameters and config.
clone_tags(estimator[, tag_names])Clone tags from another object as dynamic override.
create_test_instance([parameter_set])Construct an instance of the class, using first test parameter set.
create_test_instances_and_names([parameter_set])Create list of all test instances and a list of names for them.
get_class_tag(tag_name[, tag_value_default])Get class tag value from class, with tag level inheritance from parents.
get_class_tags()Get class tags from class, with tag level inheritance from parent classes.
get_config()Get config flags for self.
get_param_defaults()Get object's parameter defaults.
get_param_names([sort])Get object's parameter names.
get_params([deep])Get a dict of parameters values for this object.
get_tag(tag_name[, tag_value_default, ...])Get tag value from instance, with tag level inheritance and overrides.
get_tags()Get tags from instance, with tag level inheritance and overrides.
get_test_params([parameter_set])Return testing parameters.
is_composite()Check if the object is composed of other BaseObjects.
keys()Return a list of available sets.
load(*args)Load the dataset.
load_from_path(serial)Load object from file location.
load_from_serial(serial)Load object from serialized memory container.
loader_func([end, normalise, ...])Get national solar estimates for GB from Sheffield Solar PV_Live API.
reset()Reset the object to a clean post-init state.
save([path, serialization_format])Save serialized self to bytes-like object or to (.zip) file.
set_config(**config_dict)Set config flags to given values.
set_params(**params)Set the parameters of this object.
set_random_state([random_state, deep, ...])Set random_state pseudo-random seed parameters for self.
set_tags(**tag_dict)Set instance level tag overrides to given values.
get_loader_func