Organize iotools reference page by data provider
#2447
Conversation
Co-authored-by: Echedey Luis <[email protected]>
|
I suggest organizing by topic (Gridded irradiance data, Ground measurement irradiance data, Weather data) and secondary by public/commercial data sources. More importantly, I think we should add a one-line description for each dataset, e.g., CAMSSatellite-derived irradiance data for Europe, Africa, and Asia, and clear-sky irradiance globally. PVGISMultiple gridded irradiance and weather datasets with global coverage. NSRDBSatellite-derived irradiance and weather data for the Americas. |
|
I suggest also adding a link to this on the "Weather data" page in the users guide. E.g., "For an overview of available functions, see [reference to this page]" |
Co-authored-by: Adam R. Jensen <[email protected]>
There was a problem hiding this comment.
Looks great @kandersolar!! I think it makes so much more sense now! Just minor things from my side.
I guess it is still a bit strange to me that they are not organized alphabetically within each category, but I don't have strong feelings about this.
| :toctree: generated/ | ||
|
|
||
| iotools.get_pvgis_tmy | ||
| iotools.read_pvgis_tmy |
There was a problem hiding this comment.
I guess this is more a question for @AdamRJensen: why does the description of the "read_pvgis_tmy" say "read a file downloaded from PVGIS" and does not say "read a TMY file downloaded from PVGIS"?
|
|
||
| Accessing these APIs typically requires payment. | ||
|
|
||
| SolarAnywhere |
There was a problem hiding this comment.
You could consider adding the coverage of these datasets (in the free ones, you have a sentence saying for which part of the world they have data)
| Modeled irradiance and meteorological data, available for large regions of | ||
| the world. | ||
|
|
||
| Public datasets |
There was a problem hiding this comment.
You could consider adding to the description the timestep of each dataframe
iotoolsreference page needs some organization #2446[ ] Tests added[ ] Updates entries indocs/sphinx/source/referencefor API changes.[ ] Adds description and name entries in the appropriate "what's new" file indocs/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`).[ ] New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.remote-data) and Milestone are assigned to the Pull Request and linked Issue.See #2446. Docs build link: https://pvlib-python--2447.org.readthedocs.build/en/2447/reference/iotools.html