@@ -9,23 +9,62 @@ IO Tools
99========
1010
1111Functions for retrieving, reading, and writing data from a variety
12- of sources and file formats relevant to solar energy modeling.
12+ of sources and file formats relevant to solar energy modeling. See also
13+ :ref: `weatherdata `.
14+
15+ .. contents :: Currently supported APIs
16+ :depth: 3
17+ :local:
18+
19+
20+ Gridded solar resource data
21+ ---------------------------
22+
23+ Modeled irradiance and meteorological data, available for large regions of
24+ the world.
25+
26+ Public datasets
27+ ^^^^^^^^^^^^^^^
28+
29+ These APIs are free to access, although some require registration.
30+
31+ PVGIS
32+ *****
33+
34+ Multiple gridded irradiance datasets and weather data with global coverage.
35+
36+ .. autosummary ::
37+ :toctree: generated/
38+
39+ iotools.get_pvgis_tmy
40+ iotools.read_pvgis_tmy
41+ iotools.get_pvgis_hourly
42+ iotools.read_pvgis_hourly
43+ iotools.get_pvgis_horizon
44+
45+
46+ CAMS
47+ ****
48+
49+ Satellite-derived irradiance data for Europe, Africa, and Asia, and
50+ clear-sky irradiance globally.
51+
52+ .. autosummary ::
53+ :toctree: generated/
54+
55+ iotools.get_cams
56+ iotools.read_cams
57+ iotools.parse_cams
58+
59+
60+ NSRDB
61+ *****
62+
63+ Satellite-derived irradiance and weather data for the Americas.
1364
1465.. autosummary ::
1566 :toctree: generated/
1667
17- iotools.read_tmy2
18- iotools.read_tmy3
19- iotools.read_epw
20- iotools.parse_epw
21- iotools.read_srml
22- iotools.get_srml
23- iotools.read_surfrad
24- iotools.read_midc
25- iotools.read_midc_raw_data_from_nrel
26- iotools.read_crn
27- iotools.read_solrad
28- iotools.get_solrad
2968 iotools.get_nsrdb_psm4_aggregated
3069 iotools.get_nsrdb_psm4_tmy
3170 iotools.get_nsrdb_psm4_conus
@@ -34,30 +73,159 @@ of sources and file formats relevant to solar energy modeling.
3473 iotools.get_psm3
3574 iotools.read_psm3
3675 iotools.parse_psm3
37- iotools.get_pvgis_tmy
38- iotools.read_pvgis_tmy
39- iotools.get_pvgis_hourly
40- iotools.read_pvgis_hourly
41- iotools.get_pvgis_horizon
76+
77+
78+ Commercial datasets
79+ ^^^^^^^^^^^^^^^^^^^
80+
81+ Accessing these APIs typically requires payment.
82+ Datasets provide near-global coverage.
83+
84+ SolarAnywhere
85+ *************
86+
87+ .. autosummary ::
88+ :toctree: generated/
89+
90+ iotools.get_solaranywhere
91+ iotools.read_solaranywhere
92+
93+
94+ Solcast
95+ *******
96+
97+ .. autosummary ::
98+ :toctree: generated/
99+
100+ iotools.get_solcast_tmy
101+ iotools.get_solcast_historic
102+ iotools.get_solcast_forecast
103+ iotools.get_solcast_live
104+
105+
106+ Solargis
107+ ********
108+
109+ .. autosummary ::
110+ :toctree: generated/
111+
112+ iotools.get_solargis
113+
114+
115+ Ground station solar data
116+ -------------------------
117+
118+ Measurements from various networks of ground stations
119+ focusing on solar irradiance.
120+
121+ BSRN
122+ ^^^^
123+
124+ A global network dedicated to high-quality monitoring of solar and
125+ long-wave radiation.
126+
127+ .. autosummary ::
128+ :toctree: generated/
129+
42130 iotools.get_bsrn
43131 iotools.read_bsrn
44132 iotools.parse_bsrn
45- iotools.get_cams
46- iotools.read_cams
47- iotools.parse_cams
133+
134+
135+ SOLRAD
136+ ^^^^^^
137+
138+ A solar radiation network in the USA, run by NOAA.
139+
140+ .. autosummary ::
141+ :toctree: generated/
142+
143+ iotools.read_solrad
144+ iotools.get_solrad
145+
146+
147+ SURFRAD
148+ ^^^^^^^
149+
150+ A solar radiation network in the USA, run by NOAA.
151+
152+ .. autosummary ::
153+ :toctree: generated/
154+
155+ iotools.read_surfrad
156+
157+
158+ MIDC
159+ ^^^^
160+
161+ A solar radiation network in the USA, run by NREL.
162+
163+ .. autosummary ::
164+ :toctree: generated/
165+
166+ iotools.read_midc
167+ iotools.read_midc_raw_data_from_nrel
168+
169+
170+ SRML
171+ ^^^^
172+
173+ A solar radiation network in the northwestern USA, run by
174+ the University of Oregon.
175+
176+ .. autosummary ::
177+ :toctree: generated/
178+
179+ iotools.read_srml
180+ iotools.get_srml
181+
182+
183+ Weather data
184+ ------------
185+
186+ Meteorological data from a variety of modeled and measured datasets.
187+
188+ ACIS
189+ ^^^^
190+
191+ A combination of many meteorological datasets providing temperature,
192+ precipitation, wind speed, and other weather measurements.
193+
194+ .. autosummary ::
195+ :toctree: generated/
196+
48197 iotools.get_acis_prism
49198 iotools.get_acis_nrcc
50199 iotools.get_acis_mpe
51200 iotools.get_acis_station_data
52201 iotools.get_acis_available_stations
202+
203+
204+ CRN
205+ ^^^
206+
207+ A network of ground stations from NOAA. Irradiance measurements are of
208+ lower quality.
209+
210+ .. autosummary ::
211+ :toctree: generated/
212+
213+ iotools.read_crn
214+
215+
216+ Generic data file readers
217+ -------------------------
218+
219+ Functions for reading irradiance/weather data files.
220+
221+ .. autosummary ::
222+ :toctree: generated/
223+
224+ iotools.read_tmy2
225+ iotools.read_tmy3
226+ iotools.read_epw
227+ iotools.parse_epw
53228 iotools.read_panond
54- iotools.get_solaranywhere
55- iotools.read_solaranywhere
56- iotools.get_solcast_tmy
57- iotools.get_solcast_historic
58- iotools.get_solcast_forecast
59- iotools.get_solcast_live
60- iotools.get_solargis
61229
62230
63231A :py:class: `~pvlib.location.Location ` object may be created from metadata
0 commit comments