Add NSRDB PSM4 polar and polar TMY iotools#2807
Conversation
…sen/pvlib-python into add-nsrdb-polar-iotools
|
Ready for review! Test failures are unrelated. |
There was a problem hiding this comment.
I think the only (?) difference between the get_nsrdb_psm4_polar and get_nsrdb_psm4_polar_tmy is that the second has year='tmy' (and a different URL). I assume you split it into two functions to follow the iotools convention, but honestly I could easily see it being one function...
I guess you could add a test for a bad request (api_key or location).
Otherwise LGTM (but I couldn't evaluate the readthedocs)!
| NLR API uses this to automatically communicate messages back | ||
| to the user only if necessary | ||
| year : int or str | ||
| PSM4 API parameter specifing year (e.g. ``2023``) to download. The |
There was a problem hiding this comment.
| PSM4 API parameter specifing year (e.g. ``2023``) to download. The | |
| The year(s) the PSM4 API parameter should download (e.g. ``2023``). The |
| leap_day : bool, default : True | ||
| include leap day in the results | ||
| full_name : str, default 'pvlib python' | ||
| optional |
There was a problem hiding this comment.
The name of the user requesting data.
There was a problem hiding this comment.
If you agree to this, add it also to the TMY function
| full_name : str, default 'pvlib python' | ||
| optional | ||
| affiliation : str, default 'pvlib python' | ||
| optional |
There was a problem hiding this comment.
The affiliation of the user requesting data.
There was a problem hiding this comment.
If you agree to this, add it also to the TMY function
| latitude : float or int | ||
| in decimal degrees, between 60 and 90 degrees north | ||
| longitude : float or int | ||
| in decimal degrees, between -180 and 180, east is positive |
There was a problem hiding this comment.
I couldn't easily find the locations where data exists. Is there some link we could provide or something (even the NSRDB API example is a bit confusing because they report longitude first...)
| Returns | ||
| ------- | ||
| data : pandas.DataFrame | ||
| timeseries data from NLR PSM4 |
There was a problem hiding this comment.
| timeseries data from NLR PSM4 | |
| timeseries data from NLR PSM4 Polar dataset |
There was a problem hiding this comment.
If you agree to this, add it also to the TMY function
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.