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. <https://eeweather.readthedocs.org/>`_
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 <http://weather.whiteboxtechnologies.com/faq#Q12/>`_ 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
```
Raw data
{
"_id": null,
"home_page": "http://github.com/openeemeter/eeweather",
"name": "eeweather",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Phil Ngo",
"author_email": "phil@openee.io",
"download_url": "https://files.pythonhosted.org/packages/95/d8/c6ba2a92bcb6503010eaea8eb194be9b64bd940bc5b699d5f9383cf62201/eeweather-0.3.29.tar.gz",
"platform": null,
"description": "\nEEweather: Weather station wrangling for EEmeter\n================================================\n\n.. image:: https://travis-ci.org/openeemeter/eeweather.svg?branch=master\n :target: https://travis-ci.org/openeemeter/eeweather\n\n.. image:: https://img.shields.io/github/license/openeemeter/eeweather.svg\n :target: https://github.com/openeemeter/eeweather\n\n.. image:: https://readthedocs.org/projects/eeweather/badge/?version=latest\n :target: http://eeweather.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/pypi/v/eeweather.svg\n :target: https://pypi.python.org/pypi/eeweather\n\n.. image:: https://codecov.io/gh/openeemeter/eeweather/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/openeemeter/eeweather\n\n---------------\n\n**EEweather** \u2014 tools for matching to and fetching data from NCEI ISD, TMY3, or CZ2010 weather stations.\n\nEEweather 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.\n\n`Read the docs. <https://eeweather.readthedocs.org/>`_\n\nInstallation\n------------\n\nEEweather is a python package and can be installed with pip.\n\n::\n\n $ pip install eeweather\n\nSupported Sources of Weather Data\n---------------------------------\n\n- NCEI Integrated Surface Database (ISD)\n- Global Summary of the Day (GSOD)\n- NREL Typical Meteorological Year 3 (TMY3)\n- California Energy Commission 1998-2009 Weather Normals (CZ2010)\n\nFeatures\n--------\n\n- Match by ZIP code (ZCTA) or by lat/long coordinates\n- Use user-supplied weather station mappings\n- Match within climate zones\n\n - IECC Climate Zones\n - IECC Moisture Regimes\n - Building America Climate Zones\n - California Building Climate Zone Areas\n\n- User-friendly SQLite database of metadata compiled from primary sources\n\n - US Census Bureau (ZCTAs, county shapefiles)\n - Building America climate zone county lists\n - NOAA NCEI Integrated Surface Database Station History\n - NREL TMY3 site\n\n- Plot maps of outputs\n\nContributing\n------------\n\nDev installation::\n\n $ pipenv --python 3.6.4 # create virtualenv with python 3.6.4\n $ pipenv install --dev # install dev requirements with pipenv\n $ pipenv install -e . # install package in editable mode\n $ pipenv shell # activate pipenv virtual environment\n\nBuild docs::\n\n $ make -C docs html\n\nAutobuild docs::\n\n $ make -C docs livehtml\n\nCheck spelling in docs::\n\n $ make -C docs spelling\n\nRun tests::\n\n $ pytest\n\nRun tests on multiple python versions::\n\n $ tox\n\nUpload to pypi (using twine)::\n\n $ python setup.py upload\n\nUse with Docker\n---------------\n\nTo use with docker-compose, use the following:\n\nRun a tutorial notebook (copy link w/ token, open tutorial.ipynb)::\n\n $ docker-compose up jupyter\n\nLive-edit docs::\n\n $ docker-compose up docs\n\nOpen a shell::\n\n $ docker-compose run --rm shell\n\nRun tests::\n\n $ docker-compose run --rm test\n\nRun the CLI::\n\n $ docker-compose run --rm eeweather --help\n\n\nNotice Regarding CZ2010 Data\n----------------------------\n\nThere may be conditions placed on their international commercial use.\nThey can be used within the U.S. or for non-commercial international activities without restriction.\nThe non-U.S. data cannot be redistributed for commercial purposes.\nRe-distribution of these data by others must provide this same notification.\n\nSee `further explanation <http://weather.whiteboxtechnologies.com/faq#Q12/>`_ here. \n\nMetadata Yearly Updates\n-----------------------\nEvery year, the metadata database needs to be updated. This can be done by running:\n\n```\ndocker-compose run --rm eeweather rebuild-db\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Weather for Open Energy Efficiency Meter",
"version": "0.3.29",
"project_urls": {
"Homepage": "http://github.com/openeemeter/eeweather"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a75d5428e57e81879e24d503aa2978dec1be18a294a0f559b89a9e10b6d1904",
"md5": "5112458ed5fed6cbe0ed2dca93fa8002",
"sha256": "6773841b392026e2c683756a5725e5612948d6bc425a526e6ccdd7f9207ab5d8"
},
"downloads": -1,
"filename": "eeweather-0.3.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5112458ed5fed6cbe0ed2dca93fa8002",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4136926,
"upload_time": "2025-01-23T21:59:14",
"upload_time_iso_8601": "2025-01-23T21:59:14.146903Z",
"url": "https://files.pythonhosted.org/packages/2a/75/d5428e57e81879e24d503aa2978dec1be18a294a0f559b89a9e10b6d1904/eeweather-0.3.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95d8c6ba2a92bcb6503010eaea8eb194be9b64bd940bc5b699d5f9383cf62201",
"md5": "3324fc799a5b9b86c6a0bd464d0abb02",
"sha256": "3f9c7b773afb071da61de92e9713388a1ec15d41de90f53f7571703199a7afdb"
},
"downloads": -1,
"filename": "eeweather-0.3.29.tar.gz",
"has_sig": false,
"md5_digest": "3324fc799a5b9b86c6a0bd464d0abb02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4136898,
"upload_time": "2025-01-23T21:59:16",
"upload_time_iso_8601": "2025-01-23T21:59:16.696584Z",
"url": "https://files.pythonhosted.org/packages/95/d8/c6ba2a92bcb6503010eaea8eb194be9b64bd940bc5b699d5f9383cf62201/eeweather-0.3.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 21:59:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openeemeter",
"github_project": "eeweather",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "eeweather"
}
JSON
