Skip to main content

pyepwmorph

License: MIT Python 3.9+ PyPI

A Python package for morphing EnergyPlus Weather (EPW) files with climate model data. Supports CMIP6 projections from Google Cloud and custom CSV-based model data for both future and historical scenarios.

Overview

pyepwmorph enables building performance analysts and researchers to create morphed weather files by applying scientifically validated procedures (Belcher et al. 2005, Jentsch et al. 2013) to existing EPW files. The package can morph EPWs using:

  • CMIP6 data fetched automatically from Google Cloud (Pangeo)
  • Custom CSV data from any climate model, including historical reconstructions
  • CH2025 station scenarios for Switzerland, shipped with the package and indexed by global warming level

Installation

uv add pyepwmorph

Development setup

git clone https://github.com/justinfmccarty/pyepwmorph.git
cd pyepwmorph
uv sync --extra dev

With pip

pip install pyepwmorph

Quick start

CMIP6 workflow (future projections)

import pyepwmorph.tools.workflow as workflow

results = workflow.morphing_workflow(
    project_name="MyBuilding_Future",
    epw_file="weather.epw",
    user_variables=["Temperature", "Humidity", "Clouds and Radiation"],
    user_pathways=["Middle of the Road"],   # ssp245
    percentiles=[50],
    target_years=[2050],
    output_directory="output/",
)

Custom CSV workflow (historical or any model)

import pyepwmorph.tools.workflow as workflow

custom_data = {
    "reference": {
        "tas": "data/reference_tas.csv",
        "tasmax": "data/reference_tasmax.csv",
        "tasmin": "data/reference_tasmin.csv",
    },
    "target_1990s": {
        "tas": "data/target_tas.csv",
        "tasmax": "data/target_tasmax.csv",
        "tasmin": "data/target_tasmin.csv",
    },
}

results = workflow.morphing_workflow(
    project_name="Historical_Morph",
    epw_file="weather.epw",
    user_variables=["Temperature"],
    user_pathways=["target_1990s"],
    percentiles=[50],
    target_years=[1990],
    output_directory="output/",
    data_source="custom",
    custom_data=custom_data,
    reference_scenario="reference",
)

Custom CSVs should have a date column (parseable by pandas) and a column named after the CMIP6 variable (e.g. tas, tasmax). Rows should be monthly.

The reference and target scenarios must cover different years, the same way the CMIP6 historical and sspXXX experiments do. The two series are concatenated before the baseline and target periods are sliced out, so overlapping years get averaged together and weaken the climate signal. Keep baseline_range inside the years the reference scenario covers.

Switzerland (CH2025 warming levels)

For an EPW inside Switzerland, data_source="ch2025" morphs from MeteoSwiss CH2025 station scenarios. There is no target year: each pathway is a global warming level relative to 1991-2020, and the run is offline.

results = workflow.morphing_workflow(
    project_name="Zurich_GWL2",
    epw_file="zurich.epw",
    user_variables=["Temperature", "Humidity", "Wind", "Radiation", "Dew Point"],
    user_pathways=["GWL 2.0"],
    percentiles=[50],
    output_directory="output/",
    data_source="ch2025",
)
morphed = results["gwl2.0"]["50"]

The site is matched to the nearest station that has the requested variables (or, with ch2025_full_coverage=True, the nearest station that has every CH2025 variable), with an elevation penalty so a much higher station is not chosen just because it is close on the map. Supported variables are temperature, humidity, dew point, wind, and radiation (global, diffuse, and direct). Pressure and cloud cover are not in CH2025; requesting them raises an error. Sky cover is left at the EPW's baseline values when radiation is morphed, so longwave sky temperature in EnergyPlus does not follow the shortwave change.

The signal is the change from the 1991-2020 reference climate to the chosen warming level. Each model chain's change is computed first, over the chains that reach that warming level, and the percentiles are taken of those changes. The EPW's period is read from the Period of Record in its header. If that is not exactly 1991-2020, a UserWarning recommends a TMY built from 1991-2020 data. If the header states no period, a second warning says the period could not be detected, and the mismatch warning still fires if the data rows' years fall outside 1991-2020. The signal is applied to the file as it stands either way. tools.io.write_period_of_record adds the statement to files built without one. The same caveats are listed in MorphConfig.ch2025_notes and the matched station in MorphConfig.ch2025_station.

CH2025 data: MeteoSwiss & ETH Zurich (2025), Climate CH2025 - Daily Datasets, CC-BY 4.0, https://doi.org/10.18751/climate/scenarios/ch2025/data/1.0/

Measured data (actual meteorological year)

Moved to weather-file-builder (2.1 and later), together with ISO 15927-4 typical years from station data: weather_file_builder.amy.station_table_to_epw and weather_file_builder.station_tmy.station_table_to_tmy_epw. pyepwmorph.tools.amy still works in 3.4 but warns on import and will be removed in 4.0.

Climate scenarios

Scenario SSP Description Expected warming
Best Case Scenario ssp126 Strong mitigation, renewable transition ~1.8 C by 2100
Middle of the Road ssp245 Moderate mitigation efforts ~2.7 C by 2100
Upper Middle Scenario ssp370 Regional rivalry, slow convergence ~3.6 C by 2100
Worst Case Scenario ssp585 Fossil-fueled development ~4.4 C by 2100

Morphing variables

  • Temperature -- dry bulb temperature (shift + stretch)
  • Humidity -- relative humidity, stretched in specific humidity space
  • Pressure -- atmospheric pressure (shift)
  • Wind -- wind speed (stretch)
  • Radiation -- global/diffuse/direct radiation, without changing sky cover (all sources; the only radiation option for CH2025)
  • Clouds and Radiation -- global/diffuse/direct radiation and sky cover (CMIP6 and custom data)
  • Dew Point -- recalculated from morphed temperature and humidity

Variable dependencies

Some variables cannot be morphed on their own:

  • Humidity requires Temperature and Pressure, except with CH2025, where relative humidity is stretched directly
  • Dew Point requires Temperature, Humidity, and Pressure (Temperature and Humidity only with CH2025)

Dependencies are added automatically and are written to the output file. Asking for Dew Point alone therefore returns an EPW with morphed pressure, temperature, relative humidity, and dew point, which keeps the file internally consistent. MorphConfig.resolved_variables shows exactly what will be written, in the order it is computed.

Caching

Climate model data is cached locally after the first download, and the cache is consulted before the remote catalogue is opened so a hit costs no network traffic.

import pyepwmorph.models.access as access

stats = access.get_cmip6_cache_stats()
access.clear_cmip6_cache()

Cache entries live in the per-user cache directory (~/Library/Caches/pyepwmorph on macOS, ~/.cache/pyepwmorph on Linux, %LOCALAPPDATA%\pyepwmorph on Windows) and are keyed by location, pathway, variable, model sources, and time slices. Two environment variables override the defaults:

Variable Purpose Default
PYEPWMORPH_CACHE_DIR Where cache files are written per-user cache directory
PYEPWMORPH_CACHE_MAX_MB Size cap before old files go 500

Available climate models

from pyepwmorph.tools.utilities import available_models

models = available_models()

Development

git clone https://github.com/justinfmccarty/pyepwmorph.git
cd pyepwmorph
uv sync --extra dev

# Run tests (fully offline)
uv run pytest

# Run with coverage
uv run pytest --cov=pyepwmorph

# Lint
uv run ruff check pyepwmorph tests gui

Releases

./release.sh [patch|minor|major]

The script refuses to run on a dirty tree, off main, with failing lint or tests, or without a matching CHANGELOG.md section. It bumps the version, tags, and pushes; creating the GitHub Release then triggers the PyPI publish workflow.

gh release create v3.0.0 \
  --title "v3.0.0" \
  --notes "See CHANGELOG.md."

Changes

See CHANGELOG.md for the full history. The most recent release corrects several morphing calculations, so morphed humidity, dew point, wind speed, cloud cover, and direct/diffuse radiation all differ from files produced by earlier versions.

Requirements

  • Python >= 3.9
  • pandas >= 2.2
  • Internet connection (for CMIP6 data download; the custom CSV and CH2025 workflows run offline)

License

MIT License. See LICENSE.

Citation

McCarty, J. (2026). pyepwmorph: A Python package for climate-informed
EPW file morphing. Version 3.0.0.
https://github.com/justinfmccarty/pyepwmorph

Metadata

Release files for pyepwmorph 3.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyepwmorph 3.4.0
File Size Uploaded
pyepwmorph-3.4.0.tar.gz 3.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyepwmorph 3.4.0
File Interpreter ABI Platform
pyepwmorph-3.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 6.6 MB

Release files / pyepwmorph-3.4.0.tar.gz

Download URL pyepwmorph-3.4.0.tar.gz
Size 3.3 MB
Tags Source
SHA-256 checksum
How to use checksums
b8586f2d129befbdd35c28d2fb36f96b7c17564ff03f075e3a4590df64f56d44
BLAKE2b-256 checksum
How to use checksums
b8e0adc3faa7eaf0ea70e3d29e9845f8ba801bf67c4ca970bfe4252fd432973c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.

Transparency log

Release files / pyepwmorph-3.4.0-py3-none-any.whl

Download URL pyepwmorph-3.4.0-py3-none-any.whl
Size 3.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
20d0e938f66f245805bc8671809a09ed50fb84557e26e4e6bd4a8fd03c7b5eb3
BLAKE2b-256 checksum
How to use checksums
45757cbe084bbd3f5a67a545f427bc8ebdbb289fc2ce386caf470ff0a4ee166b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 9, 2026.

Transparency log

Release history Release notifications | RSS feed

3.5.0

2 release files

This release

3.4.0 This release

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.0

2 release files

1.1.0

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

0.4.12

2 release files

0.4.11

2 release files

0.4.10

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.1

2 release files

0.3.1

1 release file

0.3.0

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page