-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Organize iotools
reference page by data provider
#2447
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
base: main
Are you sure you want to change the base?
Changes from all commits
919a921
7fbb9b6
084347d
f405613
1aacc49
bb4aad3
d7a356b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,23 +9,62 @@ IO Tools | |
======== | ||
|
||
Functions for retrieving, reading, and writing data from a variety | ||
of sources and file formats relevant to solar energy modeling. | ||
of sources and file formats relevant to solar energy modeling. See also | ||
:ref:`weatherdata`. | ||
|
||
.. contents:: Currently supported APIs | ||
:depth: 3 | ||
:local: | ||
|
||
|
||
Gridded solar resource data | ||
--------------------------- | ||
|
||
Modeled irradiance and meteorological data, available for large regions of | ||
the world. | ||
|
||
Public datasets | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You could consider adding to the description the timestep of each dataframe |
||
^^^^^^^^^^^^^^^ | ||
|
||
These APIs are free to access, although some require registration. | ||
|
||
PVGIS | ||
***** | ||
|
||
Multiple gridded irradiance datasets and weather data with global coverage. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_pvgis_tmy | ||
iotools.read_pvgis_tmy | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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"? |
||
iotools.get_pvgis_hourly | ||
iotools.read_pvgis_hourly | ||
iotools.get_pvgis_horizon | ||
|
||
|
||
CAMS | ||
**** | ||
|
||
Satellite-derived irradiance data for Europe, Africa, and Asia, and | ||
clear-sky irradiance globally. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_cams | ||
iotools.read_cams | ||
iotools.parse_cams | ||
|
||
|
||
NSRDB | ||
***** | ||
|
||
Satellite-derived irradiance and weather data for the Americas. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_tmy2 | ||
iotools.read_tmy3 | ||
iotools.read_epw | ||
iotools.parse_epw | ||
iotools.read_srml | ||
iotools.get_srml | ||
iotools.read_surfrad | ||
iotools.read_midc | ||
iotools.read_midc_raw_data_from_nrel | ||
iotools.read_crn | ||
iotools.read_solrad | ||
iotools.get_solrad | ||
iotools.get_nsrdb_psm4_aggregated | ||
iotools.get_nsrdb_psm4_tmy | ||
iotools.get_nsrdb_psm4_conus | ||
|
@@ -34,30 +73,158 @@ of sources and file formats relevant to solar energy modeling. | |
iotools.get_psm3 | ||
iotools.read_psm3 | ||
iotools.parse_psm3 | ||
iotools.get_pvgis_tmy | ||
iotools.read_pvgis_tmy | ||
iotools.get_pvgis_hourly | ||
iotools.read_pvgis_hourly | ||
iotools.get_pvgis_horizon | ||
|
||
|
||
Commercial datasets | ||
^^^^^^^^^^^^^^^^^^^ | ||
|
||
Accessing these APIs typically requires payment. | ||
|
||
SolarAnywhere | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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) |
||
************* | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_solaranywhere | ||
iotools.read_solaranywhere | ||
|
||
|
||
Solcast | ||
******* | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_solcast_tmy | ||
iotools.get_solcast_historic | ||
iotools.get_solcast_forecast | ||
iotools.get_solcast_live | ||
|
||
|
||
Solargis | ||
******** | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_solargis | ||
|
||
|
||
Ground station solar data | ||
------------------------- | ||
|
||
Measurements from various networks of ground stations | ||
focusing on solar irradiance. | ||
|
||
BSRN | ||
^^^^ | ||
|
||
A global network dedicated to high-quality monitoring of solar and | ||
long-wave radiation. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_bsrn | ||
iotools.read_bsrn | ||
iotools.parse_bsrn | ||
iotools.get_cams | ||
iotools.read_cams | ||
iotools.parse_cams | ||
|
||
|
||
SOLRAD | ||
^^^^^^ | ||
|
||
A solar radiation network in the USA, run by NOAA. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_solrad | ||
iotools.get_solrad | ||
|
||
|
||
SURFRAD | ||
^^^^^^^ | ||
|
||
A solar radiation network in the USA, run by NOAA. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_surfrad | ||
|
||
|
||
MIDC | ||
^^^^ | ||
|
||
A solar radiation network in the USA, run by NREL. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_midc | ||
iotools.read_midc_raw_data_from_nrel | ||
|
||
|
||
SRML | ||
^^^^ | ||
|
||
A solar radiation network in the northwestern USA, run by | ||
the University of Oregon. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_srml | ||
iotools.get_srml | ||
|
||
|
||
Weather data | ||
------------ | ||
|
||
Meteorological data from a variety of modeled and measured datasets. | ||
|
||
ACIS | ||
^^^^ | ||
|
||
A combination of many meteorological datasets providing temperature, | ||
precipitation, wind speed, and other weather measurements. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.get_acis_prism | ||
iotools.get_acis_nrcc | ||
iotools.get_acis_mpe | ||
iotools.get_acis_station_data | ||
iotools.get_acis_available_stations | ||
|
||
|
||
CRN | ||
^^^ | ||
|
||
A network of ground stations from NOAA. Irradiance measurements are of | ||
lower quality. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_crn | ||
|
||
|
||
Generic data file readers | ||
------------------------- | ||
|
||
Functions for reading irradiance/weather data files. | ||
|
||
.. autosummary:: | ||
:toctree: generated/ | ||
|
||
iotools.read_tmy2 | ||
iotools.read_tmy3 | ||
iotools.read_epw | ||
iotools.parse_epw | ||
iotools.read_panond | ||
iotools.get_solaranywhere | ||
iotools.read_solaranywhere | ||
iotools.get_solcast_tmy | ||
iotools.get_solcast_historic | ||
iotools.get_solcast_forecast | ||
iotools.get_solcast_live | ||
iotools.get_solargis | ||
|
||
|
||
A :py:class:`~pvlib.location.Location` object may be created from metadata | ||
|
Uh oh!
There was an error while loading. Please reload this page.