Skip to main content

Weather for Open Energy Efficiency Meter

Project description

https://travis-ci.org/openeemeter/eeweather.svg?branch=master https://img.shields.io/github/license/openeemeter/eeweather.svg https://readthedocs.org/projects/eeweather/badge/?version=latest https://img.shields.io/pypi/v/eeweather.svg https://codecov.io/gh/openeemeter/eeweather/branch/master/graph/badge.svg

EEweather — tools for matching to and fetching data from NCEI ISD, TMY3, or CZ2010 weather stations.

EEweather comes with a database of weather station metadata, ZCTA metadata, and GIS data that makes it easier to find the right weather station to use for a particular ZIP code or lat/long coordinate.

Read the docs.

Installation

EEweather is a python package and can be installed with pip.

$ pip install eeweather

Supported Sources of Weather Data

  • NCEI Integrated Surface Database (ISD)

  • Global Summary of the Day (GSOD)

  • NREL Typical Meteorological Year 3 (TMY3)

  • California Energy Commission 1998-2009 Weather Normals (CZ2010)

Features

  • Match by ZIP code (ZCTA) or by lat/long coordinates

  • Use user-supplied weather station mappings

  • Match within climate zones

    • IECC Climate Zones

    • IECC Moisture Regimes

    • Building America Climate Zones

    • California Building Climate Zone Areas

  • User-friendly SQLite database of metadata compiled from primary sources

    • US Census Bureau (ZCTAs, county shapefiles)

    • Building America climate zone county lists

    • NOAA NCEI Integrated Surface Database Station History

    • NREL TMY3 site

  • Plot maps of outputs

Contributing

Dev installation:

$ pipenv --python 3.6.4  # create virtualenv with python 3.6.4
$ pipenv install --dev   # install dev requirements with pipenv
$ pipenv install -e .    # install package in editable mode
$ pipenv shell           # activate pipenv virtual environment

Build docs:

$ make -C docs html

Autobuild docs:

$ make -C docs livehtml

Check spelling in docs:

$ make -C docs spelling

Run tests:

$ pytest

Run tests on multiple python versions:

$ tox

Upload to pypi (using twine):

$ python setup.py upload

Use with Docker

To use with docker-compose, use the following:

Run a tutorial notebook (copy link w/ token, open tutorial.ipynb):

$ docker-compose up jupyter

Live-edit docs:

$ docker-compose up docs

Open a shell:

$ docker-compose run --rm shell

Run tests:

$ docker-compose run --rm test

Run the CLI:

$ docker-compose run --rm eeweather --help

Notice Regarding CZ2010 Data

There may be conditions placed on their international commercial use. They can be used within the U.S. or for non-commercial international activities without restriction. The non-U.S. data cannot be redistributed for commercial purposes. Re-distribution of these data by others must provide this same notification.

See further explanation here.

Metadata Yearly Updates

Every year, the metadata database needs to be updated. This can be done by running:

` docker-compose run --rm eeweather rebuild-db `

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

eeweather-0.3.30.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

eeweather-0.3.30-py3-none-any.whl (4.2 MB view details)

Uploaded Python 3

File details

Details for the file eeweather-0.3.30.tar.gz.

File metadata

  • Download URL: eeweather-0.3.30.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for eeweather-0.3.30.tar.gz
Algorithm Hash digest
SHA256 56da7b541d9c8a18e8c232bf0b01beacdb57105308318b9ca810303368a96b35
MD5 d528eb8ff9d36bb0cf36dd53a4d97bfa
BLAKE2b-256 9bfcba7abfe93c78368495f595ae47301d917a0cb2bf7b7bcfa22a679b04e647

See more details on using hashes here.

Provenance

The following attestation bundles were made for eeweather-0.3.30.tar.gz:

Publisher: publish.yaml on opendsm/eeweather

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eeweather-0.3.30-py3-none-any.whl.

File metadata

  • Download URL: eeweather-0.3.30-py3-none-any.whl
  • Upload date:
  • Size: 4.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for eeweather-0.3.30-py3-none-any.whl
Algorithm Hash digest
SHA256 bd84025132a0ff0ae6f7dd0fc8b075c44b3a69db4dde3474da2326f6526826c2
MD5 f7bc345ec78c0392fc18ef8980ebac3b
BLAKE2b-256 70fbf0af15eb588bb737e3aec56072aaa4d46f56a2112b8d737ad68e8dc22fbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for eeweather-0.3.30-py3-none-any.whl:

Publisher: publish.yaml on opendsm/eeweather

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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