Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

weather.get geospatial docstring example #154

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion pvdeg/weather.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def get(database, id=None, geospatial=False, **kwargs):
Dictionary of metadata for the weather data


Example
Examples
--------
Collecting a single site of PSM3 NSRDB data. *Api key and email must be replaced with your personal api key and email*. [Request a key!](https://developer.nrel.gov/signup/)

Expand All @@ -89,6 +89,33 @@ def get(database, id=None, geospatial=False, **kwargs):
.. code-block:: python

weather_df, meta_dict = pvdeg.weather.get(database="PVGIS", id=(49.95, 1.5))

Collecting geospatial data from NSRDB on Kestrel (NREL INTERNAL USERS ONLY)

satellite options:
``"GOES", "METEOSAT", "Himawari", "SUNY", "CONUS", "Americas"``


.. code-block:: python

weather_db = "NSRDB"
weather_arg = {
"satellite": "Americas",
"names": "TMY",
"NREL_HPC": True,
"attributes": [
"air_temperature",
"wind_speed",
"dhi",
"ghi",
"dni",
"relative_humidity",
],
}

geo_weather, geo_meta = pvdeg.weather.get(
weather_db, geospatial=True, **weather_arg
)
"""

META_MAP = {"elevation": "altitude", "Local Time Zone": "tz"}
Expand Down