Skip to content

Commit 3497ff4

Browse files
committed
Remove colon after default
1 parent debcc63 commit 3497ff4

File tree

5 files changed

+39
-39
lines changed

5 files changed

+39
-39
lines changed

pvlib/iotools/bsrn.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def get_bsrn(station, start, end, username, password,
8484
username for accessing the BSRN FTP server
8585
password : str
8686
password for accessing the BSRN FTP server
87-
logical_records : list or tuple, default: ('0100',)
87+
logical_records : list or tuple, default ('0100',)
8888
List of the logical records (LR) to parse. Options include: '0100',
8989
'0300', and '0500'.
9090
save_path : str or path-like, optional
@@ -221,7 +221,7 @@ def parse_bsrn(fbuf, logical_records=('0100',)):
221221
----------
222222
fbuf : file-like buffer
223223
Buffer of a BSRN station-to-archive data file
224-
logical_records : list or tuple, default: ('0100',)
224+
logical_records : list or tuple, default ('0100',)
225225
List of the logical records (LR) to parse. Options include: '0100',
226226
'0300', and '0500'.
227227
@@ -379,7 +379,7 @@ def read_bsrn(filename, logical_records=('0100',)):
379379
----------
380380
filename : str or path-like
381381
Name or path of a BSRN station-to-archive data file
382-
logical_records : list or tuple, default: ('0100',)
382+
logical_records : list or tuple, default ('0100',)
383383
List of the logical records (LR) to parse. Options include: '0100',
384384
'0300', and '0500'.
385385

pvlib/iotools/crn.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def read_crn(filename, map_variables=True):
6868
----------
6969
filename : str, path object, or file-like
7070
filepath or url to read for the fixed-width file.
71-
map_variables : boolean, default: True
71+
map_variables : boolean, default True
7272
When true, renames columns of the Dataframe to pvlib variable names
7373
where applicable. See variable :const:`VARIABLE_MAP`.
7474

pvlib/iotools/pvgis.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -63,20 +63,20 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
6363
In decimal degrees, between -90 and 90, north is positive (ISO 19115)
6464
longitude : float
6565
In decimal degrees, between -180 and 180, east is positive (ISO 19115)
66-
start : int or datetime like, default: None
66+
start : int or datetime like, default None
6767
First year of the radiation time series. Defaults to first year
6868
available.
69-
end : int or datetime like, default: None
69+
end : int or datetime like, default None
7070
Last year of the radiation time series. Defaults to last year
7171
available.
72-
raddatabase : str, default: None
72+
raddatabase : str, default None
7373
Name of radiation database. Options depend on location, see [3]_.
74-
components : bool, default: True
74+
components : bool, default True
7575
Output solar radiation components (beam, diffuse, and reflected).
7676
Otherwise only global irradiance is returned.
77-
surface_tilt : float, default: 0
77+
surface_tilt : float, default 0
7878
Tilt angle from horizontal plane. Ignored for two-axis tracking.
79-
surface_azimuth : float, default: 180
79+
surface_azimuth : float, default 180
8080
Orientation (azimuth angle) of the (fixed) plane. Counter-clockwise
8181
from north (north=0, south=180). This is offset 180 degrees from
8282
the convention used by PVGIS. Ignored for tracking systems.
@@ -85,45 +85,45 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
8585
The `surface_azimuth` parameter now follows the pvlib convention, which
8686
is counterclockwise from north. However, the convention used by the
8787
PVGIS website and pvlib<=0.9.5 is offset by 180 degrees.
88-
usehorizon : bool, default: True
88+
usehorizon : bool, default True
8989
Include effects of horizon
90-
userhorizon : list of float, default: None
90+
userhorizon : list of float, default None
9191
Optional user specified elevation of horizon in degrees, at equally
9292
spaced azimuth clockwise from north, only valid if ``usehorizon`` is
9393
true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
9494
PVGIS will calculate the horizon [4]_
95-
pvcalculation : bool, default: False
95+
pvcalculation : bool, default False
9696
Return estimate of hourly PV production.
97-
peakpower : float, default: None
97+
peakpower : float, default None
9898
Nominal power of PV system in kW. Required if pvcalculation=True.
99-
pvtechchoice : {'crystSi', 'CIS', 'CdTe', 'Unknown'}, default: 'crystSi'
99+
pvtechchoice : {'crystSi', 'CIS', 'CdTe', 'Unknown'}, default 'crystSi'
100100
PV technology.
101-
mountingplace : {'free', 'building'}, default: free
101+
mountingplace : {'free', 'building'}, default free
102102
Type of mounting for PV system. Options of 'free' for free-standing
103103
and 'building' for building-integrated.
104-
loss : float, default: 0
104+
loss : float, default 0
105105
Sum of PV system losses in percent. Required if pvcalculation=True
106-
trackingtype : {0, 1, 2, 3, 4, 5}, default: 0
106+
trackingtype : {0, 1, 2, 3, 4, 5}, default 0
107107
Type of suntracking. 0=fixed, 1=single horizontal axis aligned
108108
north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single
109109
horizontal axis aligned east-west, 5=single inclined axis aligned
110110
north-south.
111-
optimal_surface_tilt : bool, default: False
111+
optimal_surface_tilt : bool, default False
112112
Calculate the optimum tilt angle. Ignored for two-axis tracking
113-
optimalangles : bool, default: False
113+
optimalangles : bool, default False
114114
Calculate the optimum tilt and azimuth angles. Ignored for two-axis
115115
tracking.
116-
outputformat : str, default: 'json'
116+
outputformat : str, default 'json'
117117
Must be in ``['json', 'csv']``. See PVGIS hourly data
118118
documentation [2]_ for more info.
119-
url : str, default: :const:`pvlib.iotools.pvgis.URL`
119+
url : str, default :const:`pvlib.iotools.pvgis.URL`
120120
Base url of PVGIS API. ``seriescalc`` is appended to get hourly data
121121
endpoint. Note, a specific PVGIS version can be specified, e.g.,
122122
https://re.jrc.ec.europa.eu/api/v5_2/
123-
map_variables : bool, default: True
123+
map_variables : bool, default True
124124
When true, renames columns of the Dataframe to pvlib variable names
125125
where applicable. See variable :const:`VARIABLE_MAP`.
126-
timeout : int, default: 30
126+
timeout : int, default 30
127127
Time in seconds to wait for server response before timeout
128128
129129
Returns
@@ -418,7 +418,7 @@ def get_pvgis_tmy(latitude, longitude, outputformat='json', usehorizon=True,
418418
first year to calculate TMY
419419
endyear : int, default None
420420
last year to calculate TMY, must be at least 10 years from first year
421-
url : str, default: :const:`pvlib.iotools.pvgis.URL`
421+
url : str, default :const:`pvlib.iotools.pvgis.URL`
422422
base url of PVGIS API, append ``tmy`` to get TMY endpoint
423423
map_variables : bool, default True
424424
When true, renames columns of the Dataframe to pvlib variable names
@@ -678,7 +678,7 @@ def get_pvgis_horizon(latitude, longitude, url=URL, **kwargs):
678678
Latitude in degrees north
679679
longitude : float
680680
Longitude in degrees east
681-
url : str, default: :const:`pvlib.iotools.pvgis.URL`
681+
url : str, default :const:`pvlib.iotools.pvgis.URL`
682682
Base URL for PVGIS
683683
kwargs:
684684
Passed to requests.get

pvlib/iotools/sodapro.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,26 +76,26 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear',
7676
altitude : float, optional
7777
Altitude in meters. If None, then the altitude is determined from the
7878
NASA SRTM database
79-
time_step : str, {'1min', '15min', '1h', '1d', '1M'}, default: '1h'
79+
time_step : str, {'1min', '15min', '1h', '1d', '1M'}, default '1h'
8080
Time step of the time series, either 1 minute, 15 minute, hourly,
8181
daily, or monthly.
82-
time_ref : str, {'UT', 'TST'}, default: 'UT'
82+
time_ref : str, {'UT', 'TST'}, default 'UT'
8383
'UT' (universal time) or 'TST' (True Solar Time)
84-
verbose : boolean, default: False
84+
verbose : boolean, default False
8585
Verbose mode outputs additional parameters (aerosols). Only available
8686
for 1 minute and universal time. See [1]_ for parameter description.
8787
integrated : boolean, default False
8888
Whether to return radiation parameters as integrated values (Wh/m^2)
8989
or as average irradiance values (W/m^2) (pvlib preferred units)
90-
label : {'right', 'left'}, default: None
90+
label : {'right', 'left'}, default None
9191
Which bin edge label to label time-step with. The default is 'left' for
9292
all time steps except for '1M' which has a default of 'right'.
93-
map_variables : bool, default: True
93+
map_variables : bool, default True
9494
When true, renames columns of the DataFrame to pvlib variable names
9595
where applicable. See variable :const:`VARIABLE_MAP`.
96-
server : str, default: :const:`pvlib.iotools.sodapro.URL`
96+
server : str, default :const:`pvlib.iotools.sodapro.URL`
9797
Base url of the SoDa Pro CAMS Radiation API.
98-
timeout : int, default: 30
98+
timeout : int, default 30
9999
Time in seconds to wait for server response before timeout
100100
101101
Returns
@@ -240,10 +240,10 @@ def parse_cams(fbuf, integrated=False, label=None, map_variables=True):
240240
integrated : boolean, default False
241241
Whether to return radiation parameters as integrated values (Wh/m^2)
242242
or as average irradiance values (W/m^2) (pvlib preferred units)
243-
label : {'right', 'left'}, default: None
243+
label : {'right', 'left'}, default None
244244
Which bin edge label to label time-step with. The default is 'left' for
245245
all time steps except for '1M' which has a default of 'right'.
246-
map_variables : bool, default: True
246+
map_variables : bool, default True
247247
When true, renames columns of the Dataframe to pvlib variable names
248248
where applicable. See variable :const:`VARIABLE_MAP`.
249249
@@ -341,10 +341,10 @@ def read_cams(filename, integrated=False, label=None, map_variables=True):
341341
integrated : boolean, default False
342342
Whether to return radiation parameters as integrated values (Wh/m^2)
343343
or as average irradiance values (W/m^2) (pvlib preferred units)
344-
label : {'right', 'left}, default: None
344+
label : {'right', 'left}, default None
345345
Which bin edge label to label time-step with. The default is 'left' for
346346
all time steps except for '1M' which has a default of 'right'.
347-
map_variables : bool, default: True
347+
map_variables : bool, default True
348348
When true, renames columns of the Dataframe to pvlib variable names
349349
where applicable. See variable :const:`VARIABLE_MAP`.
350350

pvlib/iotools/srml.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def read_srml(filename, map_variables=True):
3333
----------
3434
filename : str
3535
filepath or url to read for the tsv file.
36-
map_variables : bool, default: True
36+
map_variables : bool, default True
3737
When true, renames columns of the DataFrame to pvlib variable names
3838
where applicable. See variable :const:`VARIABLE_MAP`.
3939
@@ -183,7 +183,7 @@ def read_srml_month_from_solardat(station, year, month, filetype='PO',
183183
Month to request data for.
184184
filetype : string
185185
SRML file type to gather. See notes for explanation.
186-
map_variables : bool, default: True
186+
map_variables : bool, default True
187187
When true, renames columns of the DataFrame to pvlib variable names
188188
where applicable. See variable :const:`VARIABLE_MAP`.
189189

0 commit comments

Comments
 (0)