Temperature Scenario

Temperature Scenario#

# if running on google colab, uncomment the next line and execute this cell to install the dependencies and prevent "ModuleNotFoundError" in later cells:
# !pip install pvdeg

import pvdeg
import os

# This information helps with debugging and getting support :)
import sys
import platform

print("Working on a ", platform.system(), platform.release())
print("Python version ", sys.version)
print("pvdeg version ", pvdeg.__version__)

Working on a  Linux 6.11.0-1018-azure
Python version  3.11.14 (main, Oct 10 2025, 01:03:14) [GCC 13.3.0]
pvdeg version  0.1.dev1+g25fa88ae5

Adding Modules and Pipeline Jobs (Run Functions on Scenario Object)#

Material: OX003 corresponds to a set of EVA material parameters from the default file O2Permeation.json in the pvdeg/data directory. Look in these files to see available options.

scene_temp = pvdeg.Scenario(
    name="temperature and degradation",
    api_key="DEMO_KEY",
    email="user@mail.com",
)

scene_temp.addLocation(
    lat_long=(25.783388, -80.189029),
)

# this module will be overwritten because another with the same name is added afterwards
scene_temp.addModule(module_name="sapm_1", temperature_model="sapm")

scene_temp.addModule(
    module_name="sapm_1",
    racking="open_rack_glass_polymer",
    materials="OX003",
    temperature_model="sapm",
    irradiance_kwarg={"azimuth": 120, "tilt": 30},
    model_kwarg={"irrad_ref": 1100},
)

scene_temp.addModule(
    module_name="pvsyst_1",
    racking="freestanding",
    materials="OX003",
    temperature_model="pvsyst",
    irradiance_kwarg={"azimuth": 180, "tilt": 0},
    model_kwarg={"module_efficiency": 0.15},
)
scene_temp.addModule(
    module_name="sapm_2",
    racking="open_rack_glass_polymer",
    materials="OX003",
    temperature_model="sapm",
    irradiance_kwarg={"azimuth": 120, "tilt": 30},
    model_kwarg={"irrad_ref": 1000},
)
scene_temp.addModule(
    module_name="sapm_3",
    racking="open_rack_glass_polymer",
    materials="OX003",
    temperature_model="sapm",
    irradiance_kwarg={"azimuth": 180, "tilt": 0},
    model_kwarg={"irrad_ref": 1000},
)

scene_temp.addModule(
    module_name="pvsyst_2",
    racking="freestanding",
    materials="OX003",
    temperature_model="pvsyst",
    irradiance_kwarg={"azimuth": 180, "tilt": 0},
    model_kwarg={"module_efficiency": 0.2},
)

scene_temp.addJob(
    func=pvdeg.temperature.temperature,
    func_kwarg={"cell_or_mod": "cell"},
)

scene_temp.addJob(
    func=pvdeg.degradation.vantHoff_deg,
    func_kwarg={"I_chamber": 1000, "temp_chamber": 25},
)

scene_temp.addJob(
    func=pvdeg.degradation.vantHoff_deg,
    func_kwarg={"I_chamber": 1000, "temp_chamber": 30},
)

scene_temp.addJob(
    func=pvdeg.degradation.IwaVantHoff,
)

 Column "relative_humidity" not found in DataFrame. Calculating...
                                                                     

/opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/site-packages/pvdeg/scenario.py:367: UserWarning: WARNING - Module already found by name "sapm_1"
  warnings.warn(f'WARNING - Module already found by name "{module_name}"')
/opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/site-packages/pvdeg/scenario.py:368: UserWarning: Module will be replaced with new instance.
  warnings.warn("Module will be replaced with new instance.")

Run and View Scenario Results#

scene_temp.run()

scene_temp
# noqa

self.name: temperature and degradation

self.path: /home/runner/work/PVDegradationTools/PVDegradationTools/tutorials/04_scenario/pvd_job_temperature and degradation

# noqa

self.gids: [1060499]

self.email: user@mail.com

self.api_key: DEMO_KEY

self.results

# noqa

► pvsyst_1

# noqa

► pvsyst_2

# noqa

► sapm_1

# noqa

► sapm_2

# noqa

► sapm_3

self.pipeline

# noqa

► # noqa temperature, #GZLAE # noqa

# noqa

► # noqa vantHoff_deg, #SBFBE # noqa

# noqa

► # noqa vantHoff_deg, #JCEIG # noqa

# noqa

► # noqa IwaVantHoff, #ELHBK # noqa

self.modules

# noqa

► sapm_1

# noqa

► pvsyst_1

# noqa

► sapm_2

# noqa

► sapm_3

# noqa

► pvsyst_2

self.weather_data

# noqa

► # noqa Weather Data

self.meta_data

{'Source': 'NSRDB', 'Location ID': '1060499', 'City': '-', 'State': '-', 'Country': '-', 'Clearsky DHI Units': 'w/m2', 'Clearsky DNI Units': 'w/m2', 'Clearsky GHI Units': 'w/m2', 'Dew Point Units': 'c', 'DHI Units': 'w/m2', 'DNI Units': 'w/m2', 'GHI Units': 'w/m2', 'Solar Zenith Angle Units': 'Degree', 'Temperature Units': 'c', 'Pressure Units': 'mbar', 'Relative Humidity Units': '%', 'Precipitable Water Units': 'cm', 'Wind Direction Units': 'Degrees', 'Wind Speed Units': 'm/s', 'Cloud Type -15': 'N/A', 'Cloud Type 0': 'Clear', 'Cloud Type 1': 'Probably Clear', 'Cloud Type 2': 'Fog', 'Cloud Type 3': 'Water', 'Cloud Type 4': 'Super-Cooled Water', 'Cloud Type 5': 'Mixed', 'Cloud Type 6': 'Opaque Ice', 'Cloud Type 7': 'Cirrus', 'Cloud Type 8': 'Overlapping', 'Cloud Type 9': 'Overshooting', 'Cloud Type 10': 'Unknown', 'Cloud Type 11': 'Dust', 'Cloud Type 12': 'Smoke', 'Fill Flag 0': 'N/A', 'Fill Flag 1': 'Missing Image', 'Fill Flag 2': 'Low Irradiance', 'Fill Flag 3': 'Exceeds Clearsky', 'Fill Flag 4': 'Missing CLoud Properties', 'Fill Flag 5': 'Rayleigh Violation', 'Surface Albedo Units': 'N/A', 'Version': '4.1.2.dev4+g3b38bc8.d20250228', 'latitude': 25.77, 'longitude': -80.18, 'altitude': 7, 'tz': -5, 'wind_height': 2}

All attributes can be accessed by the names shown above.

scene_temp.dump()

Plotting and Extracting Results#

These methods are independent of one another (i.e. you do not need to extract before plotting but both are shown below.)

import datetime

t0 = datetime.datetime(1970, 1, 1, 0, 0)
tf = datetime.datetime(1970, 1, 1, 23, 59)

# Get the first function result dynamically
function_ids = [key[1] for key in scene_temp.results.keys() if key[0] == "function"]
if function_ids:
    temp_df = scene_temp.extract(
        ("function", function_ids[0]), tmy=True, start_time=t0, end_time=tf
    )
    display(temp_df)
else:
    print("No function results found")

No function results found

# Get the first function result dynamically for plotting
function_ids = [key[1] for key in scene_temp.results.keys() if key[0] == "function"]
if function_ids:
    scene_temp.plot(
        ("function", function_ids[0]),
        tmy=True,
        start_time=t0,
        end_time=tf,
        title="single day cell temperature",
    )
else:
    print("No function results found")

No function results found

Create a Copy of a Scenario#

from pathlib import Path

parent_dir = Path(pvdeg.PVDEG_DIR).parent
new_path = parent_dir / "tutorials" / "data" / "temperature_and_degradation.json"

copy = pvdeg.scenario.Scenario.load_json(
    file_path=str(new_path),
    email="user@mail.com",
    api_key="DEMO_KEY",
)

copy

---------------------------------------------------------------------------
FileNotFoundError                         Traceback (most recent call last)
Cell In[9], line 6
      3 parent_dir = Path(pvdeg.PVDEG_DIR).parent
      4 new_path = parent_dir / "tutorials" / "data" / "temperature_and_degradation.json"
----> 6 copy = pvdeg.scenario.Scenario.load_json(
      7     file_path=str(new_path),
      8     email="user@mail.com",
      9     api_key="DEMO_KEY",
     10 )
     12 copy

File /opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/site-packages/pvdeg/scenario.py:668, in Scenario.load_json(cls, file_path, email, api_key)
    660 @classmethod
    661 def load_json(
    662     cls,
   (...)    665     api_key: Optional[str] = None,
    666 ):
    667     """Import scenario dictionaries from existing 'scenario.json' file."""
--> 668     with open(file_path, "r") as f:
    669         data = json.load(f)
    670     name = data["name"]

FileNotFoundError: [Errno 2] No such file or directory: '/opt/hostedtoolcache/Python/3.11.14/x64/lib/python3.11/site-packages/tutorials/data/temperature_and_degradation.json'
Contents