Skip to content

Commit 919a921

Browse files
committed
split up iotools ref page by data provider/source
1 parent 8a7927a commit 919a921

File tree

1 file changed

+136
-21
lines changed

1 file changed

+136
-21
lines changed

docs/sphinx/source/reference/iotools.rst

Lines changed: 136 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,39 @@ IO Tools
1111
Functions for retrieving, reading, and writing data from a variety
1212
of sources and file formats relevant to solar energy modeling.
1313

14+
Public datasets
15+
---------------
16+
17+
PVGIS
18+
^^^^^
19+
20+
.. autosummary::
21+
:toctree: generated/
22+
23+
iotools.get_pvgis_tmy
24+
iotools.read_pvgis_tmy
25+
iotools.get_pvgis_hourly
26+
iotools.read_pvgis_hourly
27+
iotools.get_pvgis_horizon
28+
29+
30+
CAMS
31+
^^^^
32+
33+
.. autosummary::
34+
:toctree: generated/
35+
36+
iotools.get_cams
37+
iotools.read_cams
38+
iotools.parse_cams
39+
40+
41+
NSRDB
42+
^^^^^
43+
1444
.. autosummary::
1545
:toctree: generated/
1646

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
2947
iotools.get_nsrdb_psm4_aggregated
3048
iotools.get_nsrdb_psm4_tmy
3149
iotools.get_nsrdb_psm4_conus
@@ -35,32 +53,129 @@ of sources and file formats relevant to solar energy modeling.
3553
iotools.get_psm3
3654
iotools.read_psm3
3755
iotools.parse_psm3
38-
iotools.get_pvgis_tmy
39-
iotools.read_pvgis_tmy
40-
iotools.get_pvgis_hourly
41-
iotools.read_pvgis_hourly
42-
iotools.get_pvgis_horizon
56+
57+
58+
BSRN
59+
^^^^
60+
61+
.. autosummary::
62+
:toctree: generated/
63+
4364
iotools.get_bsrn
4465
iotools.read_bsrn
4566
iotools.parse_bsrn
46-
iotools.get_cams
47-
iotools.read_cams
48-
iotools.parse_cams
67+
68+
69+
SOLRAD
70+
^^^^^^
71+
72+
.. autosummary::
73+
:toctree: generated/
74+
75+
iotools.read_solrad
76+
iotools.get_solrad
77+
78+
79+
SURFRAD
80+
^^^^^^^
81+
82+
.. autosummary::
83+
:toctree: generated/
84+
85+
iotools.read_surfrad
86+
87+
88+
MIDC
89+
^^^^
90+
91+
.. autosummary::
92+
:toctree: generated/
93+
94+
iotools.read_midc
95+
iotools.read_midc_raw_data_from_nrel
96+
97+
98+
SRML
99+
^^^^
100+
101+
.. autosummary::
102+
:toctree: generated/
103+
104+
iotools.read_srml
105+
iotools.get_srml
106+
107+
108+
ACIS
109+
^^^^
110+
111+
.. autosummary::
112+
:toctree: generated/
113+
49114
iotools.get_acis_prism
50115
iotools.get_acis_nrcc
51116
iotools.get_acis_mpe
52117
iotools.get_acis_station_data
53118
iotools.get_acis_available_stations
54-
iotools.read_panond
119+
120+
121+
CRN
122+
^^^
123+
124+
.. autosummary::
125+
:toctree: generated/
126+
127+
iotools.read_crn
128+
129+
130+
131+
Commercial datasets
132+
-------------------
133+
134+
135+
SolarAnywhere
136+
^^^^^^^^^^^^^
137+
138+
.. autosummary::
139+
:toctree: generated/
140+
55141
iotools.get_solaranywhere
56142
iotools.read_solaranywhere
143+
144+
145+
Solcast
146+
^^^^^^^
147+
148+
.. autosummary::
149+
:toctree: generated/
150+
57151
iotools.get_solcast_tmy
58152
iotools.get_solcast_historic
59153
iotools.get_solcast_forecast
60154
iotools.get_solcast_live
155+
156+
157+
Solargis
158+
^^^^^^^^
159+
160+
.. autosummary::
161+
:toctree: generated/
162+
61163
iotools.get_solargis
62164

63165

166+
Generic data file readers
167+
-------------------------
168+
169+
.. autosummary::
170+
:toctree: generated/
171+
172+
iotools.read_tmy2
173+
iotools.read_tmy3
174+
iotools.read_epw
175+
iotools.parse_epw
176+
iotools.read_panond
177+
178+
64179
A :py:class:`~pvlib.location.Location` object may be created from metadata
65180
in some files.
66181

0 commit comments

Comments
 (0)