pvlib 0.13.1a1__tar.gz → 0.15.0__tar.gz

{pvlib-0.13.1a1/pvlib.egg-info → pvlib-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pvlib
-Version: 0.13.1a1
+Version: 0.15.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>
@@ -29,7 +29,7 @@ Requires-Dist: cython; extra == "optional"
 Requires-Dist: ephem; extra == "optional"
 Requires-Dist: nrel-pysam; extra == "optional"
 Requires-Dist: numba>=0.17.0; extra == "optional"
-Requires-Dist: solarfactors; extra == "optional"
+Requires-Dist: solarfactors>=1.6.1; extra == "optional"
 Requires-Dist: statsmodels; extra == "optional"
 Provides-Extra: doc
 Requires-Dist: ipython; extra == "doc"
@@ -42,7 +42,7 @@ Requires-Dist: docutils==0.21; extra == "doc"
 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: solarfactors>=1.6.1; extra == "doc"
 Requires-Dist: sphinx-hoverxref~=1.4.2; extra == "doc"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/adr-pvarray/plot_fit_to_matrix.py

@@ -51,7 +51,7 @@ iec61853data = '''
 25        1000         75.0  273.651
 26        1100         75.0  301.013
 '''
-df = pd.read_csv(StringIO(iec61853data), delim_whitespace=True)
+df = pd.read_csv(StringIO(iec61853data), sep=r"\s+")
 
 # %%
 #

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/agrivoltaics/plot_diffuse_PAR_Spitters_relationship.py

@@ -57,7 +57,7 @@ tmy = tmy["2002-09-06":"2002-09-21"]  # select some days
 
 solar_position = pvlib.solarposition.get_solarposition(
     # TMY timestamp is at end of hour, so shift to center of interval
-    tmy.index.shift(freq="-30T"),
+    tmy.index.shift(freq="-30min"),
     latitude=metadata["latitude"],
     longitude=metadata["longitude"],
     altitude=metadata["altitude"],

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/bifacial/plot_bifi_model_mc.py

@@ -40,7 +40,7 @@ warnings.filterwarnings(action='ignore', module='pvfactors')
 # create site location and times characteristics
 lat, lon = 36.084, -79.817
 tz = 'Etc/GMT+5'
-times = pd.date_range('2021-06-21', '2021-6-22', freq='1T', tz=tz)
+times = pd.date_range('2021-06-21', '2021-6-22', freq='1min', tz=tz)
 
 # create site system characteristics
 axis_tilt = 0

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/bifacial/plot_bifi_model_pvwatts.py

@@ -32,7 +32,7 @@ warnings.filterwarnings(action='ignore', module='pvfactors')
 # using Greensboro, NC for this example
 lat, lon = 36.084, -79.817
 tz = 'Etc/GMT+5'
-times = pd.date_range('2021-06-21', '2021-06-22', freq='1T', tz=tz)
+times = pd.date_range('2021-06-21', '2021-06-22', freq='1min', tz=tz)
 
 # create location object and get clearsky data
 site_location = location.Location(lat, lon, tz=tz, name='Greensboro, NC')

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/bifacial/plot_pvfactors_fixed_tilt.py

@@ -30,7 +30,7 @@ warnings.filterwarnings(action='ignore', module='pvfactors')
 # %%
 # First, generate the usual modeling inputs:
 
-times = pd.date_range('2021-06-21', '2021-06-22', freq='1T', tz='Etc/GMT+5')
+times = pd.date_range('2021-06-21', '2021-06-22', freq='1min', tz='Etc/GMT+5')
 loc = location.Location(latitude=40, longitude=-80, tz=times.tz)
 sp = loc.get_solarposition(times)
 cs = loc.get_clearsky(times)

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/floating-pv/plot_floating_pv_cell_temperature.py

@@ -140,7 +140,7 @@ tmy = tmy['2002-06-06 00:00':'2002-06-06 23:59']  # select period
 
 solar_position = pvlib.solarposition.get_solarposition(
     # TMY timestamp is at end of hour, so shift to center of interval
-    tmy.index.shift(freq='-30T'),
+    tmy.index.shift(freq='-30min'),
     latitude=metadata['latitude'],
     longitude=metadata['longitude'],
     altitude=metadata['altitude'],

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/irradiance-decomposition/plot_diffuse_fraction.py

@@ -35,7 +35,7 @@ greensboro, metadata = read_tmy3(DATA_DIR / '723170TYA.CSV', coerce_year=1990,
 # NOTE: TMY3 files timestamps indicate the end of the hour, so shift indices
 # back 30-minutes to calculate solar position at center of the interval
 solpos = get_solarposition(
-    greensboro.index.shift(freq="-30T"), latitude=metadata['latitude'],
+    greensboro.index.shift(freq="-30min"), latitude=metadata['latitude'],
     longitude=metadata['longitude'], altitude=metadata['altitude'],
     pressure=greensboro.pressure*100,  # convert from millibar to Pa
     temperature=greensboro.temp_air)
@@ -44,7 +44,7 @@ solpos.index = greensboro.index  # reset index to end of the hour
 # %%
 # pvlib Decomposition Functions
 # -----------------------------
-# Methods for separating DHI into diffuse and direct components include:
+# Methods for separating GHI into diffuse and direct components include:
 # `DISC`_, `DIRINT`_, `Erbs`_, and `Boland`_.
 
 # %%
@@ -112,7 +112,7 @@ out_boland = out_boland.rename(
 # ----------------
 # In the plots below we compare the four decomposition models to the TMY3 file
 # for Greensboro, North Carolina. We also compare the clearness index, kt, with
-# GHI normalized by a reference irradiance, E0 = 1000 [W/m^2], to highlight
+# GHI normalized by a reference irradiance, E0 = 1000 [Wm⁻²], to highlight
 # spikes caused when cosine of zenith approaches zero, particularly at sunset.
 #
 # First we combine the dataframes for the decomposition models and the TMY3

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/irradiance-transposition/plot_seasonal_tilt.py

@@ -96,6 +96,6 @@ results = pd.DataFrame({
     'Seasonal 20/40 Production': mc.results.ac,
     'Fixed 30 Production': mc2.results.ac,
 })
-results.resample('m').sum().plot()
+results.resample('ME').sum().plot()
 plt.ylabel('Monthly Production')
 plt.show()

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/irradiance-transposition/plot_transposition_gain.py

@@ -80,7 +80,7 @@ for tilt in range(0, 50, 10):
     column_name = f"FT-{tilt}"
     # TMYs are hourly, so we can just sum up irradiance [W/m^2] to get
     # insolation [Wh/m^2]:
-    df_monthly[column_name] = poa_irradiance.resample('m').sum()
+    df_monthly[column_name] = poa_irradiance.resample('ME').sum()
 
 # single-axis tracking:
 orientation = tracking.singleaxis(solar_position['apparent_zenith'],
@@ -95,10 +95,10 @@ poa_irradiance = calculate_poa(tmy,
                                solar_position,
                                orientation['surface_tilt'],
                                orientation['surface_azimuth'])
-df_monthly['SAT-0.4'] = poa_irradiance.resample('m').sum()
+df_monthly['SAT-0.4'] = poa_irradiance.resample('ME').sum()
 
 # calculate the percent difference from GHI
-ghi_monthly = tmy['ghi'].resample('m').sum()
+ghi_monthly = tmy['ghi'].resample('ME').sum()
 df_monthly = 100 * (df_monthly.divide(ghi_monthly, axis=0) - 1)
 
 df_monthly.plot()

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

@@ -14,7 +14,7 @@ solar-position data, and adjust DNI and POA-global irradiance.
 # After location information and a date range is established, solar position
 # data is calculated using :py:func:`pvlib.solarposition.get_solarposition`.
 # Horizon data is assigned, and interpolated to the solar azimuth time
-# series data. Finally, in times when solar elevation is greater than the
+# series data. Finally, in times when solar elevation is less than the
 # interpolated horizon elevation angle, DNI is set to 0.
 
 import numpy as np
@@ -27,7 +27,7 @@ tz = 'MST'
 
 # Set times in the morning of the December solstice.
 times = pd.date_range(
-    '2020-12-20 6:30', '2020-12-20 9:00', freq='1T', tz=tz
+    '2020-12-20 6:30', '2020-12-20 9:00', freq='1min', tz=tz
 )
 
 # Create location object, and get solar position and clearsky irradiance data.

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/solar-position/plot_sunpath_diagrams.py

@@ -24,7 +24,7 @@ import matplotlib.pyplot as plt
 tz = 'Asia/Calcutta'
 lat, lon = 28.6, 77.2
 
-times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', freq='H', tz=tz)
+times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', freq='h', tz=tz)
 solpos = solarposition.get_solarposition(times, lat, lon)
 # remove nighttime
 solpos = solpos.loc[solpos['apparent_elevation'] > 0, :]
@@ -112,7 +112,7 @@ import matplotlib.pyplot as plt
 
 tz = 'Asia/Calcutta'
 lat, lon = 28.6, 77.2
-times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', freq='H', tz=tz)
+times = pd.date_range('2019-01-01 00:00:00', '2020-01-01', freq='h', tz=tz)
 
 solpos = solarposition.get_solarposition(times, lat, lon)
 # remove nighttime

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/spectrum/average_photon_energy.py

@@ -11,8 +11,8 @@ Calculation of the Average Photon Energy from SPECTRL2 output.
 # This example demonstrates how to use the
 # :py:func:`~pvlib.spectrum.average_photon_energy` function to calculate the
 # Average Photon Energy (APE, :math:`\overline{E_\gamma}`) of spectral
-# irradiance distributions. This example uses spectral irradiance simulated
-# using :py:func:`~pvlib.spectrum.spectrl2`, but the same method is
+# irradiance distributions. This example uses clearsky spectral irradiance
+# simulated using :py:func:`~pvlib.spectrum.spectrl2`, but the same method is
 # applicable to spectral irradiance from any source.
 # More information on the SPECTRL2 model can be found in [1]_.
 # The APE parameter is a useful indicator of the overall shape of the solar
@@ -35,18 +35,19 @@ from scipy.integrate import trapezoid
 from pvlib import spectrum, solarposition, irradiance, atmosphere
 
 lat, lon = 39.742, -105.18  # NREL SRRL location
-tilt = 25
-azimuth = 180  # south-facing system
+surface_tilt = 25
+surface_azimuth = 180  # south-facing system
 pressure = 81190  # at 1828 metres AMSL, roughly
-water_vapor_content = 0.5  # cm
-tau500 = 0.1
+precipitable_water = 0.5  # cm
+aerosol_turbidity_500nm = 0.1
 ozone = 0.31  # atm-cm
 albedo = 0.2
 
 times = pd.date_range('2023-01-01 08:00', freq='h', periods=9,
                       tz='America/Denver')
 solpos = solarposition.get_solarposition(times, lat, lon)
-aoi = irradiance.aoi(tilt, azimuth, solpos.apparent_zenith, solpos.azimuth)
+aoi = irradiance.aoi(surface_tilt, surface_azimuth,
+                     solpos.apparent_zenith, solpos.azimuth)
 
 relative_airmass = atmosphere.get_relative_airmass(solpos.apparent_zenith,
                                                    model='kastenyoung1989')
@@ -64,13 +65,13 @@ relative_airmass = atmosphere.get_relative_airmass(solpos.apparent_zenith,
 spectra_components = spectrum.spectrl2(
     apparent_zenith=solpos.apparent_zenith,
     aoi=aoi,
-    surface_tilt=tilt,
+    surface_tilt=surface_tilt,
     ground_albedo=albedo,
     surface_pressure=pressure,
     relative_airmass=relative_airmass,
-    precipitable_water=water_vapor_content,
+    precipitable_water=precipitable_water,
     ozone=ozone,
-    aerosol_turbidity_500nm=tau500,
+    aerosol_turbidity_500nm=aerosol_turbidity_500nm,
 )
 
 # %%

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/examples/system-models/plot_oedi_9068.py

@@ -143,10 +143,12 @@ email = 'your_email@domain.com'
 
 keys = ['ghi', 'dni', 'dhi', 'temp_air', 'wind_speed',
         'albedo', 'precipitable_water']
-psm3, psm3_metadata = pvlib.iotools.get_psm3(latitude, longitude, api_key,
-                                             email, interval=5, names=2019,
-                                             map_variables=True, leap_day=True,
-                                             attributes=keys)
+psm3, psm3_metadata = pvlib.iotools.get_nsrdb_psm4_conus(latitude, longitude,
+                                                         api_key, email,
+                                                         year=2019, interval=5,
+                                                         parameters=keys,
+                                                         map_variables=True,
+                                                         leap_day=True)
 
 # %%
 # Pre-generate some model inputs

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst

@@ -12,9 +12,10 @@ Spectrum
    spectrum.calc_spectral_mismatch_field
    spectrum.spectral_factor_caballero
    spectrum.spectral_factor_firstsolar
-   spectrum.spectral_factor_sapm
-   spectrum.spectral_factor_pvspec
    spectrum.spectral_factor_jrc
+   spectrum.spectral_factor_polo
+   spectrum.spectral_factor_pvspec
+   spectrum.spectral_factor_sapm
    spectrum.sr_to_qe
    spectrum.qe_to_sr
    spectrum.average_photon_energy

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/iotools.rst

@@ -81,9 +81,6 @@ Satellite-derived irradiance and weather data for the Americas.
    iotools.get_nsrdb_psm4_conus
    iotools.get_nsrdb_psm4_full_disc
    iotools.read_nsrdb_psm4
-   iotools.get_psm3
-   iotools.read_psm3
-   iotools.parse_psm3
 
 
 Commercial datasets
@@ -236,6 +233,27 @@ lower quality.
 
    iotools.read_crn
 
+ECMWF ERA5
+^^^^^^^^^^
+
+A global reanalysis dataset providing weather and solar resource data.
+
+.. autosummary::
+   :toctree: generated/
+
+   iotools.get_era5
+
+MERRA-2
+^^^^^^^
+
+A global reanalysis dataset providing weather, aerosol, and solar irradiance
+data.
+
+.. autosummary::
+   :toctree: generated/
+
+   iotools.get_merra2
+
 
 Generic data file readers
 -------------------------

pvlib-0.15.0/docs/sphinx/source/reference/irradiance/angle-of-incidence.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Angle of incidence
+------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.aoi
+   irradiance.aoi_projection

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/irradiance/clearness-index.rst

@@ -1,7 +1,7 @@
 .. currentmodule:: pvlib
 
-Clearness index models
-----------------------
+Clearness and clearsky index
+----------------------------
 
 .. autosummary::
    :toctree: ../generated/

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/irradiance/decomposition.rst

@@ -2,8 +2,8 @@
 
 .. _dniestmodels:
 
-DNI estimation models
----------------------
+Decomposition models
+--------------------
 
 .. autosummary::
    :toctree: ../generated/
@@ -16,6 +16,4 @@ DNI estimation models
    irradiance.orgill_hollands
    irradiance.boland
    irradiance.campbell_norman
-   irradiance.gti_dirint
    irradiance.louche
-

pvlib-0.15.0/docs/sphinx/source/reference/irradiance/extraterrestrial-radiation.rst

@@ -0,0 +1,9 @@
+.. currentmodule:: pvlib
+
+Extraterrestrial radiation
+--------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.get_extra_radiation

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/irradiance/index.rst

@@ -6,9 +6,10 @@ Irradiance
 .. toctree::
    :maxdepth: 2
 
-   class-methods
-   components
-   transposition
    decomposition
+   transposition
+   reverse-transposition
+   angle-of-incidence
    clearness-index
-   albedo
+   extraterrestrial-radiation
+   other

pvlib-0.13.1a1/docs/sphinx/source/reference/irradiance/albedo.rst → pvlib-0.15.0/docs/sphinx/source/reference/irradiance/other.rst

@@ -1,9 +1,12 @@
 .. currentmodule:: pvlib
 
-Albedo
-------
+Other
+-----
 
 .. autosummary::
    :toctree: ../generated/
 
+   irradiance.dni
+   irradiance.complete_irradiance
+   irradiance.diffuse_par_spitters
    albedo.inland_water_dvoracek

pvlib-0.15.0/docs/sphinx/source/reference/irradiance/reverse-transposition.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Reverse transposition models
+----------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.ghi_from_poa_driesse_2023
+   irradiance.gti_dirint

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/irradiance/transposition.rst

@@ -8,6 +8,9 @@ Transposition models
 
    irradiance.get_total_irradiance
    irradiance.get_sky_diffuse
+   irradiance.get_ground_diffuse
+   irradiance.beam_component
+   irradiance.poa_components
    irradiance.isotropic
    irradiance.perez
    irradiance.perez_driesse
@@ -15,4 +18,3 @@ Transposition models
    irradiance.klucher
    irradiance.reindl
    irradiance.king
-   irradiance.ghi_from_poa_driesse_2023

pvlib-0.15.0/docs/sphinx/source/reference/location.rst

@@ -0,0 +1,31 @@
+.. currentmodule:: pvlib
+
+Location
+========
+
+Methods for information about locations.
+
+.. autosummary::
+   :toctree: generated/
+
+   location.lookup_altitude
+
+Classes
+-------
+.. autosummary::
+   :toctree: generated/
+   
+   location.Location
+
+A :py:class:`~pvlib.location.Location` object may be created from the
+metadata returned by these file types:
+
+.. autosummary::
+   :toctree: generated/
+
+   location.Location.from_tmy
+   location.Location.from_epw
+
+Methods for calculating time series of certain variables for a given
+location are available through this class.
+

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/pv_modeling/sdm.rst

@@ -17,6 +17,7 @@ Functions relevant for single diode models.
    pvsystem.v_from_i
    pvsystem.max_power_point
    ivtools.sdm.pvsyst_temperature_coeff
+   singlediode.batzelis
 
 Low-level functions for solving the single diode equation.
 
@@ -37,3 +38,4 @@ Functions for fitting diode models
     ivtools.sde.fit_sandia_simple
     ivtools.sdm.fit_cec_sam
     ivtools.sdm.fit_desoto
+    ivtools.sdm.fit_desoto_batzelis

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/reference/pv_modeling/system_models.rst

@@ -55,3 +55,11 @@ PVGIS model
    :toctree: ../generated/
 
     pvarray.huld
+
+Other
+^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+
+    pvarray.batzelis

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/user_guide/extras/faq.rst

@@ -52,15 +52,7 @@ Where can I get irradiance data for my simulation?
 
 pvlib has a module called iotools which has several functions for
 retrieving irradiance data as well as reading standard file formats
-such as EPW, TMY2, and TMY3. For free irradiance data, you may
-consider NREL's NSRDB which can be accessed using the
-:py:func:`pvlib.iotools.get_psm3` function and is available for
-North America. For Europe and Africa, you may consider looking into
-CAMS (:py:func:`pvlib.iotools.get_cams`).
-PVGIS (:py:func:`pvlib.iotools.get_pvgis_hourly`) is another option, which
-provides irradiance from several different databases with near global coverage.
-pvlib also has functions for accessing a plethora of ground-measured
-irradiance datasets, including the BSRN, SURFRAD, SRML, and NREL's MIDC.
+such as EPW, TMY2, and TMY3.  See :ref:`weatherdata`.
 
 
 Can I use PVsyst (PAN/OND) files with pvlib?

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/user_guide/getting_started/installation.rst

@@ -185,7 +185,7 @@ With your conda/virtual environment still active...
    Consider installing pvlib using ``pip install -e .[all]`` so that
    you can run the unit tests and build the documentation.
    Your clone directory is probably similar to
-   ``C:\Users\%USER%\Documents\GitHub\pvlib-python``(Windows) or
+   ``C:\Users\%USER%\Documents\GitHub\pvlib-python`` (Windows) or
    ``/Users/%USER%/Documents/pvlib-python`` (Mac).
 #. **Test** your installation by running ``python -c 'import pvlib'``.
    You're good to go if it returns without an exception.

{pvlib-0.13.1a1 → pvlib-0.15.0}/docs/sphinx/source/user_guide/index.rst

@@ -26,6 +26,7 @@ This user guide is an overview and explains some of the key features of pvlib.
    modeling_topics/clearsky
    modeling_topics/weather_data
    modeling_topics/singlediode
+   modeling_topics/temperature
 
 .. toctree::
    :maxdepth: 2