Skip to content

Commit 084347d

Browse files
committed
reorganize, add blurbs
1 parent 7fbb9b6 commit 084347d

File tree

1 file changed

+73
-41
lines changed

1 file changed

+73
-41
lines changed

docs/sphinx/source/reference/iotools.rst

Lines changed: 73 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,24 @@ IO Tools
99
========
1010

1111
Functions 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`.
1314

1415
.. contents:: Currently supported APIs
1516
:depth: 3
1617
:local:
1718

19+
20+
Gridded resource data
21+
---------------------
22+
1823
Public datasets
19-
---------------
24+
^^^^^^^^^^^^^^^
2025

2126
PVGIS
22-
^^^^^
27+
*****
28+
29+
Multiple gridded irradiance and weather datasets with global coverage.
2330

2431
.. autosummary::
2532
:toctree: generated/
@@ -32,7 +39,10 @@ PVGIS
3239

3340

3441
CAMS
35-
^^^^
42+
****
43+
44+
Satellite-derived irradiance data for Europe, Africa, and Asia, and
45+
clear-sky irradiance globally.
3646

3747
.. autosummary::
3848
:toctree: generated/
@@ -43,7 +53,9 @@ CAMS
4353

4454

4555
NSRDB
46-
^^^^^
56+
*****
57+
58+
Satellite-derived irradiance and weather data for the Americas.
4759

4860
.. autosummary::
4961
:toctree: generated/
@@ -59,9 +71,48 @@ NSRDB
5971
iotools.parse_psm3
6072

6173

74+
Commercial datasets
75+
^^^^^^^^^^^^^^^^^^^
76+
77+
SolarAnywhere
78+
*************
79+
80+
.. autosummary::
81+
:toctree: generated/
82+
83+
iotools.get_solaranywhere
84+
iotools.read_solaranywhere
85+
86+
87+
Solcast
88+
*******
89+
90+
.. autosummary::
91+
:toctree: generated/
92+
93+
iotools.get_solcast_tmy
94+
iotools.get_solcast_historic
95+
iotools.get_solcast_forecast
96+
iotools.get_solcast_live
97+
98+
99+
Solargis
100+
********
101+
102+
.. autosummary::
103+
:toctree: generated/
104+
105+
iotools.get_solargis
106+
107+
108+
Ground station data
109+
-------------------
110+
62111
BSRN
63112
^^^^
64113

114+
A global network dedicated to high-quality monitoring of solar radiation.
115+
65116
.. autosummary::
66117
:toctree: generated/
67118

@@ -73,6 +124,8 @@ BSRN
73124
SOLRAD
74125
^^^^^^
75126

127+
A solar radiation network in the USA, run by NOAA.
128+
76129
.. autosummary::
77130
:toctree: generated/
78131

@@ -83,6 +136,8 @@ SOLRAD
83136
SURFRAD
84137
^^^^^^^
85138

139+
A solar radiation network in the USA, run by NOAA.
140+
86141
.. autosummary::
87142
:toctree: generated/
88143

@@ -92,6 +147,8 @@ SURFRAD
92147
MIDC
93148
^^^^
94149

150+
A solar radiation network in the USA, run by NREL.
151+
95152
.. autosummary::
96153
:toctree: generated/
97154

@@ -102,16 +159,24 @@ MIDC
102159
SRML
103160
^^^^
104161

162+
A solar radiation network in the northwest USA, run by the University of Oregon.
163+
105164
.. autosummary::
106165
:toctree: generated/
107166

108167
iotools.read_srml
109168
iotools.get_srml
110169

111170

171+
Weather data
172+
------------
173+
112174
ACIS
113175
^^^^
114176

177+
A combination of many meteorological datasets providing temperature,
178+
precipitation, wind speed, and other weather measurements.
179+
115180
.. autosummary::
116181
:toctree: generated/
117182

@@ -125,46 +190,13 @@ ACIS
125190
CRN
126191
^^^
127192

128-
.. autosummary::
129-
:toctree: generated/
130-
131-
iotools.read_crn
132-
133-
134-
135-
Commercial datasets
136-
-------------------
137-
138-
139-
SolarAnywhere
140-
^^^^^^^^^^^^^
141-
142-
.. autosummary::
143-
:toctree: generated/
144-
145-
iotools.get_solaranywhere
146-
iotools.read_solaranywhere
147-
148-
149-
Solcast
150-
^^^^^^^
151-
152-
.. autosummary::
153-
:toctree: generated/
154-
155-
iotools.get_solcast_tmy
156-
iotools.get_solcast_historic
157-
iotools.get_solcast_forecast
158-
iotools.get_solcast_live
159-
160-
161-
Solargis
162-
^^^^^^^^
193+
A network of ground stations from NOAA. Irradiance measurements are of
194+
relatively lower quality.
163195

164196
.. autosummary::
165197
:toctree: generated/
166198

167-
iotools.get_solargis
199+
iotools.read_crn
168200

169201

170202
Generic data file readers

0 commit comments

Comments
 (0)