Skip to main content

A tool to convert ERA5/ECMWF data to EnergyPlus Weather (EPW) format

Project description

ERA5 to EPW Converter

A tool that fetches ERA5 data and generates a full year AMY (Actual Meteorological Year) EnergyPlus Weather file (EPW).

The tool takes care of fetching the necessary data from the Copernicus Climate Data Store (CDS) and the Copernicus Atmosphere Data Store (CAMS), processing it, and formatting it into the EPW format. It's designed for fast and efficient data retrieval.

Installation

Prerequisites

Make sure to register for an API key and validate licences at:

Then create the file ~/.cdsapirc with the following content:

url: https://cds.climate.copernicus.eu/api/v2
key: <your_api_key>

Note: the URL will be dynamically managed by the script depending on the data source. The API key doesn't vary, it's the same for both ERA5 and CAMS data.

Moreover, before proceeding, it is required to accept all the licenses in the section "Your profile" in the website of Copernicus.

Install the package

From PyPI

pip install era5epw

From source

Clone the current repository and install the required dependencies using Poetry:

git clone https://github.com/airboxlab/era5epw.git
poetry install

Usage

Example usage:

# using poetry, execute in local repository
poetry run era5epw_download --year 2024 --latitude 49.4 --longitude 0.1 --city-name "Le Havre" --elevation 0 --time-zone 1

# using installed binary, after pypi package installation
era5epw_download --year 2024 --latitude 49.4 --longitude 0.1 --city-name "Le Havre" --elevation 0 --time-zone 1

By default, the time-zone argument is used only to populate the LOCATION header and data time is UTC. Use --apply-time-zone-to-data to apply it to the date and time fields (this will shift the UTC time by the provided time zone offset).

Use --help to have a list of available options.

Documentation

ERA5
CAMS
EPW format
Earthkit

Datasets home pages:

View your API requests and download responses at:

CDS Requests
ADS Requests

Check CDS API status at CDS Live, it provides information about congestion for each dataset.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

era5epw-0.3.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

era5epw-0.3.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file era5epw-0.3.0.tar.gz.

File metadata

  • Download URL: era5epw-0.3.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.8.0-87-generic

File hashes

Hashes for era5epw-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5c00dea704f6384823427bbbe86d224b1217945fc01967d9e6d37fbec29deb8f
MD5 b0d6c6c838b746c66fbbe8607ca24a2b
BLAKE2b-256 9d76a1ee3b99c6230d35c01bf533a3b53102c40f7a35ead36250a9817782ce14

See more details on using hashes here.

File details

Details for the file era5epw-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: era5epw-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.8.0-87-generic

File hashes

Hashes for era5epw-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4daad25d9f4c20b2bfad90f6cea1567481a897e45d3171d4ef2fbba01c15202b
MD5 3fbc738bb44e441434e6b5195fbfb4b4
BLAKE2b-256 3827e13e142703718ed8537e7a32bf614e8537042c42291b1e55e16ab0fd65fe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page