Remove colon after default

Author: echedey-ls

pvlib/iotools/bsrn.py

@@ -84,7 +84,7 @@ def get_bsrn(station, start, end, username, password,
         username for accessing the BSRN FTP server
     password: str
         password for accessing the BSRN FTP server
-    logical_records: list or tuple, default: ('0100',)
+    logical_records : list or tuple, default ('0100',)
         List of the logical records (LR) to parse. Options include: '0100',
         '0300', and '0500'.
     save_path: str or path-like, optional
@@ -225,7 +225,7 @@ def parse_bsrn(fbuf, logical_records=('0100',)):
     ----------
     fbuf: file-like buffer
         Buffer of a BSRN station-to-archive data file
-    logical_records: list or tuple, default: ('0100',)
+    logical_records : list or tuple, default ('0100',)
         List of the logical records (LR) to parse. Options include: '0100',
         '0300', and '0500'.
 
@@ -383,7 +383,7 @@ def read_bsrn(filename, logical_records=('0100',)):
     ----------
     filename: str or path-like
         Name or path of a BSRN station-to-archive data file
-    logical_records: list or tuple, default: ('0100',)
+    logical_records : list or tuple, default ('0100',)
         List of the logical records (LR) to parse. Options include: '0100',
         '0300', and '0500'.
 

pvlib/iotools/crn.py

@@ -68,7 +68,7 @@ def read_crn(filename, map_variables=True):
     ----------
     filename: str, path object, or file-like
         filepath or url to read for the fixed-width file.
-    map_variables: boolean, default: True
+    map_variables : boolean, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
 

pvlib/iotools/pvgis.py

@@ -59,24 +59,24 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
 
     Parameters
     ----------
-    latitude: float
+    latitude : float
         In decimal degrees, between -90 and 90, north is positive (ISO 19115)
-    longitude: float
+    longitude : float
         In decimal degrees, between -180 and 180, east is positive (ISO 19115)
-    start: int or datetime like, default: None
+    start : int or datetime like, default None
         First year of the radiation time series. Defaults to first year
         available.
-    end: int or datetime like, default: None
+    end : int or datetime like, default None
         Last year of the radiation time series. Defaults to last year
         available.
-    raddatabase: str, default: None
+    raddatabase : str, default None
         Name of radiation database. Options depend on location, see [3]_.
-    components: bool, default: True
+    components : bool, default True
         Output solar radiation components (beam, diffuse, and reflected).
         Otherwise only global irradiance is returned.
-    surface_tilt: float, default: 0
+    surface_tilt : float, default 0
         Tilt angle from horizontal plane. Ignored for two-axis tracking.
-    surface_azimuth: float, default: 180
+    surface_azimuth : float, default 180
         Orientation (azimuth angle) of the (fixed) plane. Counter-clockwise
         from north (north=0, south=180). This is offset 180 degrees from
         the convention used by PVGIS. Ignored for tracking systems.
@@ -85,45 +85,45 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
            The `surface_azimuth` parameter now follows the pvlib convention, which
            is counterclockwise from north. However, the convention used by the
            PVGIS website and pvlib<=0.9.5 is offset by 180 degrees.
-    usehorizon: bool, default: True
+    usehorizon : bool, default True
         Include effects of horizon
-    userhorizon: list of float, default: None
+    userhorizon : list of float, default None
         Optional user specified elevation of horizon in degrees, at equally
         spaced azimuth clockwise from north, only valid if ``usehorizon`` is
         true, if ``usehorizon`` is true but ``userhorizon`` is ``None`` then
         PVGIS will calculate the horizon [4]_
-    pvcalculation: bool, default: False
+    pvcalculation : bool, default False
         Return estimate of hourly PV production.
-    peakpower: float, default: None
+    peakpower : float, default None
         Nominal power of PV system in kW. Required if pvcalculation=True.
-    pvtechchoice: {'crystSi', 'CIS', 'CdTe', 'Unknown'}, default: 'crystSi'
+    pvtechchoice : {'crystSi', 'CIS', 'CdTe', 'Unknown'}, default 'crystSi'
         PV technology.
-    mountingplace: {'free', 'building'}, default: free
+    mountingplace : {'free', 'building'}, default free
         Type of mounting for PV system. Options of 'free' for free-standing
         and 'building' for building-integrated.
-    loss: float, default: 0
+    loss : float, default 0
         Sum of PV system losses in percent. Required if pvcalculation=True
-    trackingtype: {0, 1, 2, 3, 4, 5}, default: 0
+    trackingtype : {0, 1, 2, 3, 4, 5}, default 0
         Type of suntracking. 0=fixed, 1=single horizontal axis aligned
         north-south, 2=two-axis tracking, 3=vertical axis tracking, 4=single
         horizontal axis aligned east-west, 5=single inclined axis aligned
         north-south.
-    optimal_surface_tilt: bool, default: False
+    optimal_surface_tilt : bool, default False
         Calculate the optimum tilt angle. Ignored for two-axis tracking
-    optimalangles: bool, default: False
+    optimalangles : bool, default False
         Calculate the optimum tilt and azimuth angles. Ignored for two-axis
         tracking.
-    outputformat: str, default: 'json'
+    outputformat : str, default 'json'
         Must be in ``['json', 'csv']``. See PVGIS hourly data
         documentation [2]_ for more info.
-    url: str, default: :const:`pvlib.iotools.pvgis.URL`
+    url : str, default :const:`pvlib.iotools.pvgis.URL`
         Base url of PVGIS API. ``seriescalc`` is appended to get hourly data
         endpoint. Note, a specific PVGIS version can be specified, e.g.,
         https://re.jrc.ec.europa.eu/api/v5_2/
-    map_variables: bool, default: True
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
-    timeout: int, default: 30
+    timeout : int, default 30
         Time in seconds to wait for server response before timeout
 
     Returns
@@ -217,9 +217,9 @@ def get_pvgis_hourly(latitude, longitude, start=None, end=None,
     if raddatabase is not None:
         params['raddatabase'] = raddatabase
     if start is not None:
-        params['startyear'] = start if isinstance(start, int) else pd.to_datetime(start).year  # noqa: E501
+        params['startyear'] = start if isinstance(start, int) else start.year
     if end is not None:
-        params['endyear'] = end if isinstance(end, int) else pd.to_datetime(end).year  # noqa: E501
+        params['endyear'] = end if isinstance(end, int) else end.year
     if peakpower is not None:
         params['peakpower'] = peakpower
 
@@ -315,7 +315,7 @@ def read_pvgis_hourly(filename, pvgis_format=None, map_variables=True):
         ``pvgis_format`` is ``None`` then the file extension will be used to
         determine the PVGIS format to parse. If ``filename`` is a buffer, then
         ``pvgis_format`` is required and must be in ``['csv', 'json']``.
-    map_variables: bool, default True
+    map_variables : bool, default True
         When true, renames columns of the DataFrame to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
 
@@ -391,8 +391,8 @@ def read_pvgis_hourly(filename, pvgis_format=None, map_variables=True):
 
 
 def get_pvgis_tmy(latitude, longitude, outputformat='json', usehorizon=True,
-                  userhorizon=None, startyear=None, endyear=None,
-                  map_variables=True, url=URL, timeout=30):
+                  userhorizon=None, startyear=None, endyear=None, url=URL,
+                  map_variables=True, timeout=30):
     """
     Get TMY data from PVGIS.
 
@@ -418,11 +418,11 @@ def get_pvgis_tmy(latitude, longitude, outputformat='json', usehorizon=True,
         first year to calculate TMY
     endyear : int, default None
         last year to calculate TMY, must be at least 10 years from first year
-    map_variables: bool, default True
+    url : str, default :const:`pvlib.iotools.pvgis.URL`
+        base url of PVGIS API, append ``tmy`` to get TMY endpoint
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
-    url : str, default: :const:`pvlib.iotools.pvgis.URL`
-        base url of PVGIS API, append ``tmy`` to get TMY endpoint
     timeout : int, default 30
         time in seconds to wait for server response before timeout
 
@@ -581,7 +581,7 @@ def read_pvgis_tmy(filename, pvgis_format=None, map_variables=True):
         ``outputformat='basic'``, please set ``pvgis_format`` to ``'basic'``.
         If ``filename`` is a buffer, then ``pvgis_format`` is required and must
         be in ``['csv', 'epw', 'json', 'basic']``.
-    map_variables: bool, default True
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
 
@@ -678,7 +678,7 @@ def get_pvgis_horizon(latitude, longitude, url=URL, **kwargs):
         Latitude in degrees north
     longitude : float
         Longitude in degrees east
-    url: str, default: :const:`pvlib.iotools.pvgis.URL`
+    url : str, default :const:`pvlib.iotools.pvgis.URL`
         Base URL for PVGIS
     kwargs:
         Passed to requests.get

pvlib/iotools/sodapro.py

@@ -47,9 +47,8 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear',
              altitude=None, time_step='1h', time_ref='UT', verbose=False,
              integrated=False, label=None, map_variables=True,
              server=URL, timeout=30):
-    """Retrieve irradiance and clear-sky time series from CAMS.
-
-    Time-series of radiation and/or clear-sky global, beam, and
+    """
+    Retrieve time-series of radiation and/or clear-sky global, beam, and
     diffuse radiation from CAMS (see [1]_). Data is retrieved from SoDa [2]_.
 
     Time coverage: 2004-01-01 to two days ago
@@ -62,48 +61,48 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear',
 
     Parameters
     ----------
-    latitude: float
+    latitude : float
         in decimal degrees, between -90 and 90, north is positive (ISO 19115)
     longitude : float
         in decimal degrees, between -180 and 180, east is positive (ISO 19115)
-    start: datetime-like
+    start : datetime like
         First day of the requested period
-    end: datetime-like
+    end : datetime like
         Last day of the requested period
-    email: str
+    email : str
         Email address linked to a SoDa account
-    identifier: {'mcclear', 'cams_radiation'}
+    identifier : {'mcclear', 'cams_radiation'}
         Specify whether to retrieve CAMS Radiation or McClear parameters
-    altitude: float, optional
+    altitude : float, optional
         Altitude in meters. If None, then the altitude is determined from the
         NASA SRTM database
-    time_step: str, {'1min', '15min', '1h', '1d', '1M'}, default: '1h'
+    time_step : str, {'1min', '15min', '1h', '1d', '1M'}, default '1h'
         Time step of the time series, either 1 minute, 15 minute, hourly,
         daily, or monthly.
-    time_ref: str, {'UT', 'TST'}, default: 'UT'
+    time_ref : str, {'UT', 'TST'}, default 'UT'
         'UT' (universal time) or 'TST' (True Solar Time)
-    verbose: boolean, default: False
+    verbose : boolean, default False
         Verbose mode outputs additional parameters (aerosols). Only available
         for 1 minute and universal time. See [1]_ for parameter description.
-    integrated: boolean, default False
+    integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label: {'right', 'left'}, default: None
+    label : {'right', 'left'}, default None
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
-    map_variables: bool, default: True
+    map_variables : bool, default True
         When true, renames columns of the DataFrame to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
-    server: str, default: :const:`pvlib.iotools.sodapro.URL`
+    server : str, default :const:`pvlib.iotools.sodapro.URL`
         Base url of the SoDa Pro CAMS Radiation API.
-    timeout : int, default: 30
+    timeout : int, default 30
         Time in seconds to wait for server response before timeout
 
     Returns
     -------
-    data: pandas.DataFrame
+    data : pandas.DataFrame
         Timeseries data, see Notes for columns
-    metadata: dict
+    metadata : dict
         Metadata of the requested time-series
 
     Notes
@@ -178,8 +177,8 @@ def get_cams(latitude, longitude, start, end, email, identifier='mcclear',
         altitude = -999
 
     # Start and end date should be in the format: yyyy-mm-dd
-    start = pd.to_datetime(start).strftime('%Y-%m-%d')
-    end = pd.to_datetime(end).strftime('%Y-%m-%d')
+    start = start.strftime('%Y-%m-%d')
+    end = end.strftime('%Y-%m-%d')
 
     email = email.replace('@', '%2540')  # Format email address
     identifier = 'get_{}'.format(identifier.lower())  # Format identifier str
@@ -236,23 +235,23 @@ def parse_cams(fbuf, integrated=False, label=None, map_variables=True):
 
     Parameters
     ----------
-    fbuf: file-like object
+    fbuf : file-like object
         File-like object containing data to read.
-    integrated: boolean, default False
+    integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label: {'right', 'left'}, default: None
+    label : {'right', 'left'}, default None
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
-    map_variables: bool, default: True
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
 
     Returns
     -------
-    data: pandas.DataFrame
+    data : pandas.DataFrame
         Timeseries data from CAMS Radiation or McClear
-    metadata: dict
+    metadata : dict
         Metadata available in the file.
 
     See Also
@@ -337,24 +336,24 @@ def read_cams(filename, integrated=False, label=None, map_variables=True):
 
     Parameters
     ----------
-    filename: str
+    filename : str
         Filename of a file containing data to read.
-    integrated: boolean, default False
+    integrated : boolean, default False
         Whether to return radiation parameters as integrated values (Wh/m^2)
         or as average irradiance values (W/m^2) (pvlib preferred units)
-    label: {'right', 'left}, default: None
+    label : {'right', 'left}, default None
         Which bin edge label to label time-step with. The default is 'left' for
         all time steps except for '1M' which has a default of 'right'.
-    map_variables: bool, default: True
+    map_variables : bool, default True
         When true, renames columns of the Dataframe to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
 
     Returns
     -------
-    data: pandas.DataFrame
+    data : pandas.DataFrame
         Timeseries data from CAMS Radiation or McClear.
         See :func:`pvlib.iotools.get_cams` for fields.
-    metadata: dict
+    metadata : dict
         Metadata available in the file.
 
     See Also