pvlib 0.11.2__tar.gz → 0.12.0__tar.gz

{pvlib-0.11.2/pvlib.egg-info → pvlib-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pvlib
-Version: 0.11.2
+Version: 0.12.0
 Summary: A set of functions and classes for simulating the performance of photovoltaic energy systems.
 Home-page: https://github.com/pvlib/pvlib-python
 Author-email: pvlib python Developers <pvlib-admin@googlegroups.com>
@@ -44,7 +44,7 @@ Requires-Dist: pillow; extra == "doc"
 Requires-Dist: sphinx-toggleprompt==0.5.2; extra == "doc"
 Requires-Dist: sphinx-favicon; extra == "doc"
 Requires-Dist: solarfactors; extra == "doc"
-Requires-Dist: sphinx-hoverxref; extra == "doc"
+Requires-Dist: sphinx-hoverxref~=1.4.2; extra == "doc"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -56,6 +56,8 @@ Requires-Dist: pytest-remotedata; extra == "test"
 Requires-Dist: packaging; extra == "test"
 Provides-Extra: all
 Requires-Dist: pvlib[doc,optional,test]; extra == "all"
+Dynamic: home-page
+Dynamic: license-file
 
 pvlib python is a community developed toolbox that provides a set of
 functions and classes for simulating the performance of photovoltaic

pvlib-0.12.0/docs/sphinx/source/_static/tooltipster_color_theming.css

@@ -0,0 +1,10 @@
+/* Overrides for sphinx-hoverxref since it does not support a native dark theme, see */
+/* https://github.com/readthedocs/sphinx-hoverxref/issues/231 */
+/* Inspired by https://github.com/pybamm-team/PyBaMM/pull/3083 */
+
+/* These will ensure that the tooltip inherits the pydata-sphinx-theme colours */
+
+.tooltipster-sidetip.tooltipster-shadow.tooltipster-shadow-custom .tooltipster-content {
+    background-color: var(--pst-color-background) !important;
+    color: var(--pst-color-text-base) !important;
+}

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/conf.py

@@ -282,6 +282,8 @@ def setup(app):
     app.add_css_file("reference_format.css")
     # Add a warning banner at the top of the page if viewing the "latest" docs
     app.add_js_file("version-alert.js")
+    # Match the color theme of tooltips to PyData Sphinx Theme light/dark mode
+    app.add_css_file("tooltipster_color_theming.css")
 
 # -- Options for LaTeX output ---------------------------------------------
 

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/contributing/testing.rst

@@ -11,7 +11,7 @@ Overview
 Developers **must** include comprehensive tests for any additions or
 modifications to pvlib. New unit test code should be placed in the
 corresponding test module in the
-`pvlib/tests <https://github.com/pvlib/pvlib-python/tree/main/pvlib/tests>`_
+`tests <https://github.com/pvlib/pvlib-python/tree/main/tests>`_
 directory.
 
 A pull request will automatically run the tests for you on a variety of
@@ -20,26 +20,26 @@ typically more efficient to run and debug the tests in your own local
 environment.
 
 To run the tests locally, install the ``test`` dependencies specified in the
-`setup.py <https://github.com/pvlib/pvlib-python/blob/main/setup.py>`_
+`pyproject.toml <https://github.com/pvlib/pvlib-python/blob/main/pyproject.toml>`_
 file. See :ref:`installation` instructions for more information.
 
 pvlib's unit tests can easily be run by executing ``pytest`` on the
-pvlib directory::
+tests directory::
 
-    pytest pvlib
+    pytest tests
 
 or, for a single module::
 
-    pytest pvlib/tests/test_clearsky.py
+    pytest tests/test_clearsky.py
 
 or, for a single test::
 
-    pytest pvlib/tests/test_clearsky.py::test_ineichen_nans
+    pytest tests/test_clearsky.py::test_ineichen_nans
 
 We suggest using pytest's ``--pdb`` flag to debug test failures rather
 than using ``print`` or ``logging`` calls. For example::
 
-    pytest pvlib --pdb
+    pytest tests --pdb
 
 will drop you into the
 `pdb debugger <https://docs.python.org/3/library/pdb.html>`_ at the
@@ -50,7 +50,7 @@ to the test suite (with rare exceptions).
 To include all network-dependent tests, include the ``--remote-data`` flag to
 your ``pytest`` call::
 
-    pytest pvlib --remote-data
+    pytest tests --remote-data
 
 And consider adding ``@pytest.mark.remote_data`` to any network dependent test
 you submit for a PR.

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/reference/airmass_atmospheric.rst

@@ -14,7 +14,6 @@ Airmass and atmospheric models
    atmosphere.tdew_from_rh
    atmosphere.rh_from_tdew
    atmosphere.gueymard94_pw
-   atmosphere.first_solar_spectral_correction
    atmosphere.bird_hulstrom80_aod_bb
    atmosphere.kasten96_lt
    atmosphere.angstrom_aod_at_lambda

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst

@@ -8,7 +8,6 @@ Spectrum
 
    spectrum.spectrl2
    spectrum.get_example_spectral_response
-   spectrum.get_am15g
    spectrum.get_reference_spectra
    spectrum.calc_spectral_mismatch_field
    spectrum.spectral_factor_caballero

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/reference/modelchain.rst

@@ -112,7 +112,6 @@ on the information in the associated :py:class:`~pvsystem.PVSystem` object.
    modelchain.ModelChain.infer_dc_model
    modelchain.ModelChain.infer_ac_model
    modelchain.ModelChain.infer_aoi_model
-   modelchain.ModelChain.infer_spectral_model
    modelchain.ModelChain.infer_temperature_model
    modelchain.ModelChain.infer_losses_model
 

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/reference/pv_modeling/system_models.rst

@@ -12,7 +12,6 @@ Sandia array performance model (SAPM)
 
    pvsystem.sapm
    pvsystem.sapm_effective_irradiance
-   pvsystem.sapm_spectral_loss
    spectrum.spectral_factor_sapm
    inverter.sandia
    temperature.sapm_cell

pvlib-0.12.0/docs/sphinx/source/user_guide/index.rst

@@ -0,0 +1,34 @@
+.. _user_guide:
+
+==========
+User Guide
+==========
+
+This user guide is an overview and explains some of the key features of pvlib.
+
+.. toctree::
+   :caption: Getting started
+   :maxdepth: 2
+   
+   package_overview
+   installation
+   introtutorial
+   
+.. toctree::
+   :caption: Modeling topics
+   :maxdepth: 2
+   
+   pvsystem
+   modelchain
+   timetimezones
+   bifacial
+   clearsky
+   weather_data
+   singlediode
+
+.. toctree::
+   :caption: Extras
+   :maxdepth: 2
+
+   nomenclature
+   faq

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/user_guide/introtutorial.rst

@@ -87,7 +87,7 @@ to accomplish our system modeling goal:
             longitude=longitude,
             altitude=altitude,
             temperature=weather["temp_air"],
-            pressure=pvlib.atmosphere.alt2pres(altitude),
+            pressure=weather["pressure"],
         )
         dni_extra = pvlib.irradiance.get_extra_radiation(weather.index)
         airmass = pvlib.atmosphere.get_relative_airmass(solpos['apparent_zenith'])

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/user_guide/nomenclature.rst

@@ -71,6 +71,9 @@ There is a convention on consistent variable names throughout the library:
     ghi
         Global horizontal irradiance
 
+    ghi_clear
+        Clearsky global horizontal irradiance [Wm⁻²]
+
     ghi_extra
         Horizontal irradiance at top of atmosphere (extraterrestrial)
 

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.10.0.rst

@@ -53,9 +53,9 @@ Deprecations
   deprecated. Use :py:func:`pvlib.pvsystem.v_from_i` and
   :py:func:`pvlib.pvsystem.i_from_v` instead. (:issue:`1626`, :pull:`1743`)
 * Functions for calculating spectral modifiers have been moved to :py:mod:`pvlib.spectrum`:
-  :py:func:`pvlib.atmosphere.first_solar_spectral_correction` is deprecated and
+  :py:func:`!pvlib.atmosphere.first_solar_spectral_correction` is deprecated and
   replaced by :py:func:`~pvlib.spectrum.spectral_factor_firstsolar`, and
-  :py:func:`pvlib.pvsystem.sapm_spectral_loss` is deprecated and replaced by
+  :py:func:`!pvlib.pvsystem.sapm_spectral_loss` is deprecated and replaced by
   :py:func:`~pvlib.spectrum.spectral_factor_sapm`. (:pull:`1628`)
 * Removed the ``get_ecmwf_macc`` and ``read_ecmwf_macc`` iotools functions as the
   MACC dataset has been `removed by ECMWF <https://confluence.ecmwf.int/display/DAC/Decommissioning+of+ECMWF+Public+Datasets+Service>`_

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.11.0.rst

@@ -28,7 +28,7 @@ Deprecations
 ~~~~~~~~~~~~
 * The ``pvlib.irradiance.SURFACE_ALBEDOS`` dictionary has been moved to
   :py:const:`pvlib.albedo.SURFACE_ALBEDOS`. (:pull:`2095`)
-* Function :py:func:`pvlib.spectrum.get_am15g` has been deprecated in favor
+* Function :py:func:`!pvlib.spectrum.get_am15g` has been deprecated in favor
   of the new function :py:func:`pvlib.spectrum.get_reference_spectra`. Use
   ``pvlib.spectrum.get_reference_spectra(standard="ASTM G173-03")["global"]``
   instead. (:pull:`2039`)

pvlib-0.12.0/docs/sphinx/source/whatsnew/v0.12.0.rst

@@ -0,0 +1,100 @@
+.. _whatsnew_01200:
+
+
+v0.12.0 (March 19, 2025)
+------------------------
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+* The :py:attr:`pvlib.location.Location.pytz` attribute is now read only. The
+  ``pytz`` attribute is now set internally to be consistent with the
+  :py:attr:`pvlib.location.Location.tz` attribute. (:issue:`2340`, :pull:`2341`)
+* Users must now provide :py:attr:`ModelChain.spectral_model`, or the ``'no_loss'`` spectral
+  model is assumed. :py:class:`~pvlib.modelchain.ModelChain` no longer attempts to infer
+  the spectral model from :py:class:`~pvlib.pvsystem.PVSystem` attributes. (:issue:`2017`, :pull:`2253`)
+* Remove deprecated :py:func:`!pvlib.pvsystem.sapm_spectral_loss`; use
+  :py:func:`~pvlib.spectrum.spectral_factor_sapm` instead. (:issue:`2243`, :pull:`2244`)
+* :py:func:`~pvlib.iotools.read_tmy3` now defaults to ``map_variables=True``.
+  Additionally, the deprecated ``recolumn`` parameter is now removed. (:issue:`2324`, :pull:`2408`)
+* Remove :py:func:`!pvlib.atmosphere.first_solar_spectral_correction`, deprecated in v0.10.0.
+  Use :py:func:`~pvlib.spectrum.spectral_factor_firstsolar` instead. (:issue:`2130`, :pull:`2131`)
+* Remove deprecated :py:func:`!pvlib.spectrum.get_am15g` function; use
+  :py:func:`~pvlib.spectrum.get_reference_spectra` instead.  (:pull:`2409`)
+* Change default method of :py:func:`~pvlib.location.Location.get_sun_rise_set_transit`
+  to ``'spa'`` instead of ``'pyephem'``. (:pull:`2410`)
+
+Bug fixes
+~~~~~~~~~
+* Add a check to :py:func:`~pvlib.snow.fully_covered_nrel` and
+  :py:func:`~pvlib.snow.coverage_nrel`. The check uses snow depth on the ground
+  to improve modeling for systems with shallow tilt angles. The check
+  adds a new, optional parameter ``snow_depth``. (:issue:`1171`, :pull:`2292`)
+* Fix a bug in :py:func:`pvlib.bifacial.infinite_sheds.get_irradiance_poa` which may have yielded non-zero
+  ground irradiance when the sun was below the horizon. (:issue:`2245`, :pull:`2359`)
+* Fix a bug where :py:func:`pvlib.transformer.simple_efficiency` could only be imported
+  using the ``from pvlib.transformer`` syntax. (:pull:`2388`)
+* :py:class:`~pvlib.modelchain.ModelChain` now requires only a minimal set of
+  parameters to run the SAPM electrical model. (:issue:`2369`, :pull:`2393`)
+* Correct keys for First Solar modules in :py:func:`~pvlib.spectrum.spectral_factor_pvspec`. (:issue:`2398`, :pull:`2400`)
+* Ensure proper tz and pytz types in :py:class:`~pvlib.location.Location`. To ensure that
+  the time zone in :py:class:`~pvlib.location.Location` remains internally consistent
+  if/when the time zone is updated, the ``tz`` attribute is now the single source
+  of time-zone truth, is the single time-zone setter interface, and its getter 
+  returns an IANA string. (:issue:`2340`, :pull:`2341`)
+* :py:func:`~pvlib.iotools.get_pvgis_tmy` with ``outputformat='csv'`` now
+  works with the updated data format returned by PVGIS. (:issue:`2344`, :pull:`2395`)
+
+Enhancements
+~~~~~~~~~~~~
+* :py:func:`~pvlib.irradiance.gti_dirint` now raises an informative message
+  when input data don't include values with AOI<90. (:issue:`1342`, :pull:`2347`)
+* Reduce space requirements by excluding tests and test files from wheel.
+  Zipped wheel is now 66% of the previous size, and installed size is 50% of
+  the previous size. (:issue:`2271`, :pull:`2277`)
+
+Documentation
+~~~~~~~~~~~~~
+* Fix Procedural and Object Oriented simulation examples having slightly different
+  results in :ref:`introtutorial`. (:issue:`2366`, :pull:`2367`)
+* Restructure the user guide with subsections. (:issue:`2302`, :pull:`2310`)
+* Add references for :py:func:`pvlib.snow.loss_townsend`. (:issue:`2383`, :pull:`2384`)
+* Add :term:`ghi_clear` to the :ref:`nomenclature` page. (:issue:`2272`, :pull:`2397`)
+* Add output variable naming clarifaction to :py:func:`pvlib.pvsystem.calcparams_desoto`
+  and :py:func:`pvlib.pvsystem.calcparams_pvsyst`. (:issue:`716`, :pull:`2405`)
+
+Testing
+~~~~~~~
+* Move tests folder to ``/tests`` and data exclusively used for testing to ``/tests/data``.
+  (:issue:`2271`, :pull:`2277`)
+* Add Python 3.13 to test suite. (:issue:`2201`, :pull:`2258`)
+* Add tests for all input types for the :py:attr:`pvlib.location.Location.tz` attribute.
+  (:issue:`2340`, :pull:`2341`)
+* Add tests for time-conversion functions in :py:mod:`pvlib.tools`. (:issue:`2340`, :pull:`2341`)
+
+Maintenance
+~~~~~~~~~~~
+* Fix ReadTheDocs builds by upgrading ``readthedocs.yml`` configuration
+  (:issue:`2357`, :pull:`2358`)
+* asv 0.4.2 upgraded to asv 0.6.4 to fix CI failure due to pinned older conda.
+  (:pull:`2352`)
+
+Contributors
+~~~~~~~~~~~~
+* Rajiv Daxini (:ghuser:`RDaxini`)
+* Cliff Hansen (:ghuser:`cwhanse`)
+* Jason Lun Leung (:ghuser:`jason-rpkt`)
+* Manoj K S (:ghuser:`manojks1999`)
+* Kurt Rhee (:ghuser:`kurt-rhee`)
+* Ayush jariyal (:ghuser:`ayushjariyal`)
+* Kevin Anderson (:ghuser:`kandersolar`)
+* Echedey Luis (:ghuser:`echedey-ls`)
+* Mark Campanelli (:ghuser:`markcampanelli`)
+* Max Jackson (:ghuser:`MaxJackson`)
+* Anton Driesse (:ghuser:`adriesse`)
+* Adam R. Jensen (:ghuser:`AdamRJensen`)
+* Ioannis Sifnaios (:ghuser:`IoannisSifnaios`)
+* Will Holmgren (:ghuser:`wholmgren`)
+* Sophie Pelland (:ghuser:`solphie-pelland`)
+* Will Hobbs (:ghuser:`williamhobbs`)
+* Karel De Brabandere (:ghuser:`kdebrab`)
+* Kenneth J. Sauer (:ghuser:`kjsauer`)

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.6.1.rst

@@ -56,7 +56,7 @@ Enhancements
 * Use HRRR modeled surface temperature values instead of inferring from
   isobaric values and modeled wind speed instead of inferring from gust.
   (:issue:`604`)
-* Change :py:func:`pvlib.pvsystem.sapm_spectral_loss` to avoid numpy warning.
+* Change :py:func:`!pvlib.pvsystem.sapm_spectral_loss` to avoid numpy warning.
 * Add warning message when :py:func:`pvlib.spa` is reloaded. (:issue:`401`)
 * Add option for :py:func:`pvlib.irradiance.disc` to use relative airmass
   by supplying `pressure=None`. (:issue:`449`)

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.7.0.rst

@@ -104,7 +104,7 @@ API Changes with Deprecations
 * Changes related to spectral modifier (:issue:`782`):
    * Changes to functions
       - Added the argument `pw_min` and `pw_max`, default values 0.1 and 8 resp.,
-	to `atmosphere.first_solar_spectral_correction`. This function now returns NaN
+	to :py:func:`!pvlib.atmosphere.first_solar_spectral_correction`. This function now returns NaN
 	if pw value higher than `pw_max`.
 * The `times` keyword argument has been deprecated in the
   :py:meth:`pvlib.modelchain.ModelChain.run_model`,

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.7.2.rst

@@ -46,7 +46,7 @@ Bug fixes
 * Fix :py:func:`~pvlib.iotools.read_tmy3` parsing when February contains
   a leap year. (:pull:`866`)
 * Implement NREL Developer Network API key for consistent success with API
-  calls in :py:mod:`pvlib.tests.iotools.test_psm3`. (:pull:`873`)
+  calls in :py:mod:`!pvlib.tests.iotools.test_psm3`. (:pull:`873`)
 * Fix issue with :py:class:`pvlib.location.Location` creation when
   passing ``tz=datetime.timezone.utc``. (:pull:`879`)
 * Fix documentation homepage title to "pvlib python" based on first heading on

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew/v0.9.3.rst

@@ -14,7 +14,7 @@ Enhancements
   (:issue:`1516`, :pull:`1518`)
 * New module to calculate spectral mismatch from field spectral measurements
   :py:func:`~pvlib.spectrum.get_example_spectral_response`
-  :py:func:`~pvlib.spectrum.get_am15g`
+  :py:func:`!pvlib.spectrum.get_am15g`
   :py:func:`~pvlib.spectrum.calc_spectral_mismatch_field`
   (:issue:`1523`, :pull:`1524`)
 * Added Townsend-Powers monthly snow loss model:

{pvlib-0.11.2 → pvlib-0.12.0}/docs/sphinx/source/whatsnew.rst

@@ -6,6 +6,7 @@ What's New
 
 These are new features and improvements of note in each release.
 
+.. include:: whatsnew/v0.12.0.rst
 .. include:: whatsnew/v0.11.2.rst
 .. include:: whatsnew/v0.11.1.rst
 .. include:: whatsnew/v0.11.0.rst

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/__init__.py

@@ -27,4 +27,5 @@ from pvlib import (  # noqa: F401
     temperature,
     tools,
     tracking,
+    transformer,
 )

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/atmosphere.py

@@ -6,9 +6,6 @@ speed at different heights.
 
 import numpy as np
 import pandas as pd
-import pvlib
-
-from pvlib._deprecation import deprecated
 
 APPARENT_ZENITH_MODELS = ('simple', 'kasten1966', 'kastenyoung1989',
                           'gueymard1993', 'pickering2002')
@@ -416,12 +413,6 @@ def tdew_from_rh(temp_air, relative_humidity, coeff=(6.112, 17.62, 243.12)):
     return dewpoint
 
 
-first_solar_spectral_correction = deprecated(
-    since='0.10.0',
-    alternative='pvlib.spectrum.spectral_factor_firstsolar'
-)(pvlib.spectrum.spectral_factor_firstsolar)
-
-
 def bird_hulstrom80_aod_bb(aod380, aod500):
     """
     Approximate broadband aerosol optical depth.

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/bifacial/infinite_sheds.py

@@ -260,8 +260,9 @@ def get_irradiance_poa(surface_tilt, surface_azimuth, solar_zenith,
     Returns
     -------
     output : dict or DataFrame
-        Output is a DataFrame when input ghi is a Series. See Notes for
-        descriptions of content.
+        Output is a ``pandas.DataFrame`` when ``ghi`` is a Series.
+        Otherwise it is a dict of ``numpy.ndarray``
+        See Notes for descriptions of content.
 
     Notes
     -----
@@ -372,7 +373,7 @@ def get_irradiance_poa(surface_tilt, surface_azimuth, solar_zenith,
         'poa_global': poa_global, 'poa_direct': poa_direct,
         'poa_diffuse': poa_diffuse, 'poa_ground_diffuse': poa_gnd_pv,
         'poa_sky_diffuse': poa_sky_pv, 'shaded_fraction': f_x}
-    if isinstance(poa_global, pd.Series):
+    if isinstance(ghi, pd.Series):
         output = pd.DataFrame(output)
     return output
 

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/bifacial/utils.py

@@ -87,7 +87,8 @@ def _unshaded_ground_fraction(surface_tilt, surface_azimuth, solar_zenith,
                                         surface_azimuth)
     f_gnd_beam = 1.0 - np.minimum(
         1.0, gcr * np.abs(cosd(surface_tilt) + sind(surface_tilt) * tan_phi))
-    np.where(solar_zenith > max_zenith, 0., f_gnd_beam)  # [1], Eq. 4
+    # [1], Eq. 4
+    f_gnd_beam = np.where(solar_zenith > max_zenith, 0., f_gnd_beam)
     return f_gnd_beam  # 1 - min(1, abs()) < 1 always
 
 

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/iotools/psm3.py

@@ -49,7 +49,7 @@ REQUEST_VARIABLE_MAP = {
     'ghi_clear': 'clearsky_ghi',
     'dhi_clear': 'clearsky_dhi',
     'dni_clear': 'clearsky_dni',
-    'zenith': 'solar_zenith_angle',
+    'solar_zenith': 'solar_zenith_angle',
     'temp_air': 'air_temperature',
     'temp_dew': 'dew_point',
     'relative_humidity': 'relative_humidity',

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/iotools/pvgis.py

@@ -559,9 +559,17 @@ def _parse_pvgis_tmy_csv(src):
     inputs['longitude'] = float(src.readline().split(b':')[1])
     # Elevation (m): 1389.0\r\n
     inputs['elevation'] = float(src.readline().split(b':')[1])
+
+    # TMY has an extra line here: Irradiance Time Offset (h): 0.1761\r\n
+    line = src.readline()
+    if line.startswith(b'Irradiance Time Offset'):
+        inputs['irradiance time offset'] = float(line.split(b':')[1])
+        src.readline()  # skip over the "month,year\r\n"
+    else:
+        # `line` is already the "month,year\r\n" line, so nothing to do
+        pass
     # then there's a 13 row comma separated table with two columns: month, year
-    # which contains the year used for that month in the
-    src.readline()  # get "month,year\r\n"
+    # which contains the year used for that month in the TMY
     months_selected = []
     for month in range(12):
         months_selected.append(

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/iotools/tmy.py

@@ -3,8 +3,6 @@
 import datetime
 import re
 import pandas as pd
-import warnings
-from pvlib._deprecation import pvlibDeprecationWarning
 
 # Dictionary mapping TMY3 names to pvlib names
 VARIABLE_MAP = {
@@ -24,8 +22,7 @@ VARIABLE_MAP = {
 }
 
 
-def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
-              encoding=None):
+def read_tmy3(filename, coerce_year=None, map_variables=True, encoding=None):
     """Read a TMY3 file into a pandas dataframe.
 
     Note that values contained in the metadata dictionary are unchanged
@@ -44,13 +41,9 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
         If supplied, the year of the index will be set to ``coerce_year``, except
         for the last index value which will be set to the *next* year so that
         the index increases monotonically.
-    map_variables : bool, optional
+    map_variables : bool, default True
         When True, renames columns of the DataFrame to pvlib variable names
         where applicable. See variable :const:`VARIABLE_MAP`.
-    recolumn : bool (deprecated, use map_variables instead)
-        If ``True``, apply standard names to TMY3 columns. Typically this
-        results in stripping the units from the column name.
-        Cannot be used in combination with ``map_variables``.
     encoding : str, optional
         Encoding of the file. For files that contain non-UTF8 characters it may
         be necessary to specify an alternative encoding, e.g., for
@@ -233,74 +226,15 @@ def read_tmy3(filename, coerce_year=None, map_variables=None, recolumn=None,
     # unit must be in (D,h,m,s,ms,us,ns), but pandas>=0.24 allows unit='hour'
     data.index = data_ymd + pd.to_timedelta(shifted_hour, unit='h') \
         + pd.to_timedelta(minutes, unit='min')
-    # shouldnt' specify both recolumn and map_variables
-    if recolumn is not None and map_variables is not None:
-        msg = "`map_variables` and `recolumn` cannot both be specified"
-        raise ValueError(msg)
-    elif map_variables is None and recolumn is not None:
-        warnings.warn(
-            'The recolumn parameter is deprecated and will be removed in '
-            'pvlib 0.11.0. Use `map_variables` instead, although note that '
-            'its behavior is different from `recolumn`.',
-            pvlibDeprecationWarning)
-    elif map_variables is None and recolumn is None:
-        warnings.warn(
-            'TMY3 variable names will be renamed to pvlib conventions by '
-            'default starting in pvlib 0.11.0. Specify map_variables=True '
-            'to enable that behavior now, or specify map_variables=False '
-            'to hide this warning.', pvlibDeprecationWarning)
+
     if map_variables:
         data = data.rename(columns=VARIABLE_MAP)
-    elif recolumn or (recolumn is None and map_variables is None):
-        data = _recolumn(data)
 
     data = data.tz_localize(int(meta['TZ'] * 3600))
 
     return data, meta
 
 
-def _recolumn(tmy3_dataframe):
-    """
-    Rename the columns of the TMY3 DataFrame.
-
-    Parameters
-    ----------
-    tmy3_dataframe : DataFrame
-    inplace : bool
-        passed to DataFrame.rename()
-
-    Returns
-    -------
-    Recolumned DataFrame.
-    """
-    # paste in the header as one long line
-    raw_columns = 'ETR (W/m^2),ETRN (W/m^2),GHI (W/m^2),GHI source,GHI uncert (%),DNI (W/m^2),DNI source,DNI uncert (%),DHI (W/m^2),DHI source,DHI uncert (%),GH illum (lx),GH illum source,Global illum uncert (%),DN illum (lx),DN illum source,DN illum uncert (%),DH illum (lx),DH illum source,DH illum uncert (%),Zenith lum (cd/m^2),Zenith lum source,Zenith lum uncert (%),TotCld (tenths),TotCld source,TotCld uncert (code),OpqCld (tenths),OpqCld source,OpqCld uncert (code),Dry-bulb (C),Dry-bulb source,Dry-bulb uncert (code),Dew-point (C),Dew-point source,Dew-point uncert (code),RHum (%),RHum source,RHum uncert (code),Pressure (mbar),Pressure source,Pressure uncert (code),Wdir (degrees),Wdir source,Wdir uncert (code),Wspd (m/s),Wspd source,Wspd uncert (code),Hvis (m),Hvis source,Hvis uncert (code),CeilHgt (m),CeilHgt source,CeilHgt uncert (code),Pwat (cm),Pwat source,Pwat uncert (code),AOD (unitless),AOD source,AOD uncert (code),Alb (unitless),Alb source,Alb uncert (code),Lprecip depth (mm),Lprecip quantity (hr),Lprecip source,Lprecip uncert (code),PresWth (METAR code),PresWth source,PresWth uncert (code)'  # noqa: E501
-
-    new_columns = [
-        'ETR', 'ETRN', 'GHI', 'GHISource', 'GHIUncertainty',
-        'DNI', 'DNISource', 'DNIUncertainty', 'DHI', 'DHISource',
-        'DHIUncertainty', 'GHillum', 'GHillumSource', 'GHillumUncertainty',
-        'DNillum', 'DNillumSource', 'DNillumUncertainty', 'DHillum',
-        'DHillumSource', 'DHillumUncertainty', 'Zenithlum',
-        'ZenithlumSource', 'ZenithlumUncertainty', 'TotCld', 'TotCldSource',
-        'TotCldUncertainty', 'OpqCld', 'OpqCldSource', 'OpqCldUncertainty',
-        'DryBulb', 'DryBulbSource', 'DryBulbUncertainty', 'DewPoint',
-        'DewPointSource', 'DewPointUncertainty', 'RHum', 'RHumSource',
-        'RHumUncertainty', 'Pressure', 'PressureSource',
-        'PressureUncertainty', 'Wdir', 'WdirSource', 'WdirUncertainty',
-        'Wspd', 'WspdSource', 'WspdUncertainty', 'Hvis', 'HvisSource',
-        'HvisUncertainty', 'CeilHgt', 'CeilHgtSource', 'CeilHgtUncertainty',
-        'Pwat', 'PwatSource', 'PwatUncertainty', 'AOD', 'AODSource',
-        'AODUncertainty', 'Alb', 'AlbSource', 'AlbUncertainty',
-        'Lprecipdepth', 'Lprecipquantity', 'LprecipSource',
-        'LprecipUncertainty', 'PresWth', 'PresWthSource',
-        'PresWthUncertainty']
-
-    mapping = dict(zip(raw_columns.split(','), new_columns))
-
-    return tmy3_dataframe.rename(columns=mapping)
-
-
 def read_tmy2(filename):
     """
     Read a TMY2 file into a DataFrame.

{pvlib-0.11.2 → pvlib-0.12.0}/pvlib/irradiance.py

@@ -2368,6 +2368,9 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
            irradiance, Solar Energy 122, 1037-1046.
            :doi:`10.1016/j.solener.2015.10.024`
     """
+    # check input data and raise Exceptions where data will cause the
+    # algorithm to fail
+    _gti_dirint_check_input(aoi)
 
     aoi_lt_90 = aoi < 90
 
@@ -2399,6 +2402,17 @@ def gti_dirint(poa_global, aoi, solar_zenith, solar_azimuth, times,
     return output
 
 
+def _gti_dirint_check_input(aoi):
+    r"""
+    Helper for gti_dirint
+
+    Raises Exceptions from input data that cause the algorithm to fail.
+    """
+    if not (aoi < 90).any():
+        raise ValueError("There are no times with AOI < 90. "
+                         "gti_dirint requires some data with AOI < 90.")
+
+
 def _gti_dirint_lt_90(poa_global, aoi, aoi_lt_90, solar_zenith, solar_azimuth,
                       times, surface_tilt, surface_azimuth, pressure=101325.,
                       use_delta_kt_prime=True, temp_dew=None, albedo=.25,