Skip to content

Commit 0b5ba09

Browse files
committed
bit more docs
1 parent d3bd426 commit 0b5ba09

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

pvlib/iotools/ecmwf.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ def get_era5(latitude, longitude, start, end, variables, api_key,
6060
"""
6161
Retrieve ERA5 reanalysis data from the ECMWF's Copernicus Data Store.
6262
63-
This API [1]_ provides a subset of the full ERA5 dataset. See [2]_ for
63+
A CDS API key is needed to access this API. Register for one at [1]_.
64+
65+
This API [2]_ provides a subset of the full ERA5 dataset. See [3]_ for
6466
the available variables. Data are available on a 0.25° x 0.25° grid.
6567
6668
Parameters
@@ -76,7 +78,7 @@ def get_era5(latitude, longitude, start, end, variables, api_key,
7678
variables : list of str
7779
List of variable names to retrieve. See [1]_ for options.
7880
api_key : str
79-
ECMWF API key.
81+
ECMWF CDS API key.
8082
map_variables : bool, default True
8183
When true, renames columns of the DataFrame to pvlib variable names
8284
where applicable. See variable :const:`VARIABLE_MAP`.
@@ -100,8 +102,9 @@ def get_era5(latitude, longitude, start, end, variables, api_key,
100102
101103
References
102104
----------
103-
.. [1] https://cds.climate.copernicus.eu/datasets/reanalysis-era5-single-levels-timeseries?tab=overview
104-
.. [2] https://confluence.ecmwf.int/pages/viewpage.action?pageId=505390919
105+
.. [1] https://cds.climate.copernicus.eu/
106+
.. [2] https://cds.climate.copernicus.eu/datasets/reanalysis-era5-single-levels-timeseries?tab=overview
107+
.. [3] https://confluence.ecmwf.int/pages/viewpage.action?pageId=505390919
105108
""" # noqa: E501
106109
start = pd.to_datetime(start).strftime("%Y-%m-%d")
107110
end = pd.to_datetime(end).strftime("%Y-%m-%d")

0 commit comments

Comments
 (0)