eeweather

Fetch NCDC ISD, TMY3, or CZ2010 weather data that corresponds to ZIP Code Tabulation Areas or Latitude/Longitude.
https://github.com/opendsm/eeweather

Category: Atmosphere
Sub Category: Meteorological Observation and Forecast

Keywords

weather weather-data weather-station

Keywords from Contributors

building-energy efficiency energy-data energy-efficiency

Last synced: about 24 hours ago
JSON representation

Repository metadata

Fetch NCDC ISD, TMY3, or CZ2010 weather data that corresponds to ZIP Code Tabulation Areas or Latitude/Longitude.

• Host: GitHub
• URL: https://github.com/opendsm/eeweather
• Owner: opendsm
• License: apache-2.0
• Created: 2018-01-29T21:14:08.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-03-24T19:56:24.000Z (about 1 month ago)
• Last Synced: 2025-04-09T18:51:21.183Z (18 days ago)
• Topics: weather, weather-data, weather-station
• Language: HTML
• Homepage: http://eeweather.openee.io/
• Size: 30.1 MB
• Stars: 50
• Watchers: 8
• Forks: 19
• Open Issues: 11
• Releases: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

README.rst

          EEweather: Weather station wrangling for EEmeter
================================================

.. image:: https://travis-ci.org/openeemeter/eeweather.svg?branch=master
    :target: https://travis-ci.org/openeemeter/eeweather

.. image:: https://img.shields.io/github/license/openeemeter/eeweather.svg
    :target: https://github.com/openeemeter/eeweather

.. image:: https://readthedocs.org/projects/eeweather/badge/?version=latest
    :target: http://eeweather.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/v/eeweather.svg
    :target: https://pypi.python.org/pypi/eeweather

.. image:: https://codecov.io/gh/openeemeter/eeweather/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/openeemeter/eeweather

---------------

**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
```

        

---

Owner metadata

• Name: OpenDSM
• Login: opendsm
• Email: [email protected]
• Kind: organization
• Description: Collaboratively advancing the future of demand-side energy
• Website: https://lfenergy.org/projects/opendsm/
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/19336002?v=4
• Repositories: 3
• Last ynced at: 2025-02-04T14:43:20.546Z
• Profile URL: https://github.com/opendsm

---

GitHub Events

Total

• Delete event: 1
• Issue comment event: 4
• Push event: 3
• Pull request review event: 1
• Pull request event: 2
• Create event: 1

Last Year

• Delete event: 1
• Issue comment event: 4
• Push event: 3
• Pull request review event: 1
• Pull request event: 2
• Create event: 1

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
Phil Ngo	n****l@g****m	118
Stephen Suffian	s****e@o****o	57
Stephen Suffian	s****n@g****m	47
Jason Chulock	j****n@r****m	12
Craig Maloney	c****g@d****t	6
Steve	s****e@r****m	3
Arpan Kotecha	a****n@o****o	3
hshaban	h****n@g****m	1
Phil Ngo	p****l@r****m	1
Peter Karman	p****n@g****m	1
Cody Smith	c****y@c****y	1
Vikhyati Singh	v****i@o****o	1

Committer domains:

• recurve.com: 3
• openee.io: 3
• camus.energy: 1
• gridium.com: 1
• decafbad.net: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/opendsm/eeweather

---

---

---

Dependencies

Score: 6.595780513961312