EEmeter: tools for calculating metered energy savings
=====================================================
.. image:: https://travis-ci.org/openeemeter/eemeter.svg?branch=master
:target: https://travis-ci.org/openeemeter/eemeter
:alt: Build Status
.. image:: https://img.shields.io/github/license/openeemeter/eemeter.svg
:target: https://github.com/openeemeter/eemeter
:alt: License
.. image:: https://readthedocs.org/projects/eemeter/badge/?version=master
:target: https://eemeter.readthedocs.io/?badge=master
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/v/eemeter.svg
:target: https://pypi.python.org/pypi/eemeter
:alt: PyPI Version
.. image:: https://codecov.io/gh/openeemeter/eemeter/branch/master/graph/badge.svg
:target: https://codecov.io/gh/openeemeter/eemeter
:alt: Code Coverage Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Code Style
---------------
**EEmeter** — an open source toolkit for implementing and developing standard
methods for calculating normalized metered energy consumption (NMEC) and
avoided energy use.
Background - why use the EEMeter library
----------------------------------------
At time of writing (Sept 2018), the OpenEEmeter, as implemented in the eemeter
package and sibling `eeweather package <http://eeweather.openee.io>`_, contains the
most complete open source implementation of the
`CalTRACK Methods <https://caltrack.org/>`_, which
specify a family of ways to calculate and aggregate estimates avoided energy
use at a single meter particularly suitable for use in pay-for-performance
(P4P) programs.
The eemeter package contains a toolkit written in the python langage which may
help in implementing a CalTRACK compliant analysis.
It contains a modular set of of functions, parameters, and classes which can be
configured to run the CalTRACK methods and close variants.
.. note::
Please keep in mind that use of the OpenEEmeter is neither necessary nor
sufficient for compliance with the CalTRACK method specification. For example,
while the CalTRACK methods set specific hard limits for the purpose of
standardization and consistency, the EEmeter library can be configured to edit
or entirely ignore those limits. This is becuase the emeter package is used not
only for compliance with, but also for *development of* the CalTRACK methods.
Please also keep in mind that the EEmeter assumes that certain data cleaning
tasks specified in the CalTRACK methods have occurred prior to usage with the
eemeter. The package proactively exposes warnings to point out issues of this
nature where possible.
Installation
------------
EEmeter is a python package and can be installed with pip.
::
$ pip install eemeter
Features
--------
- Reference implementation of standard methods
- CalTRACK Daily Method
- CalTRACK Monthly Billing Method
- CalTRACK Hourly Method
- Flexible sources of temperature data. See `EEweather <https://eeweather.openee.io>`_.
- Candidate model selection
- Data sufficiency checking
- Model serialization
- First-class warnings reporting
- Pandas dataframe support
- Visualization tools
Roadmap for 2020 development
----------------------------
The OpenEEmeter project growth goals for the year fall into two categories:
1. Community goals - we want help our community thrive and continue to grow.
2. Technical goals - we want to keep building the library in new ways that make it
as easy as possible to use.
Community goals
~~~~~~~~~~~~~~~
1. Develop project documentation and tutorials
A number of users have expressed how hard it is to get started when tutorials are
out of date. We will dedicate time and energy this year to help create high quality
tutorials that build upon the API documentation and existing tutorials.
2. Make it easier to contribute
As our user base grows, the need and desire for users to contribute back to the library
also grows, and we want to make this as seamless as possible. This means writing and
maintaining contribution guides, and creating checklists to guide users through the
process.
Technical goals
~~~~~~~~~~~~~~~
1. Implement new CalTRACK recommendations
The CalTRACK process continues to improve the underlying methods used in the
OpenEEmeter. Our primary technical goal is to keep up with these changes and continue
to be a resource for testing and experimentation during the CalTRACK methods setting
process.
2. Hourly model visualizations
The hourly methods implemented in the OpenEEMeter library are not yet packaged with
high quality visualizations like the daily and billing methods are. As we build and
package new visualizations with the library, more users will be able to understand,
deploy, and contribute to the hourly methods.
3. Weather normal and unusual scenarios
The EEweather package, which supports the OpenEEmeter, comes packaged with publicly
available weather normal scenarios, but one feature that could help make that easier
would be to package methods for creating custom weather year scenarios.
4. Greater weather coverage
The weather station coverage in the EEweather package includes full coverage of US and
Australia, but with some technical work, it could be expanded to include greater, or
even worldwide coverage.
License
-------
This project is licensed under [Apache 2.0](LICENSE).
Other resources
---------------
- `CONTRIBUTING <CONTRIBUTING.md>`_: how to contribute to the project.
- `MAINTAINERS <MAINTAINERS.md>`_: an ordered list of project maintainers.
- `CHARTER <CHARTER.md>`_: open source project charter.
- `CODE_OF_CONDUCT <CODE_OF_CONDUCT.md>`_: Code of conduct for contributors.
Raw data
{
"_id": null,
"home_page": "http://github.com/openeemeter/eemeter",
"name": "eemeter",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Phil Ngo",
"author_email": "admin@openee.io",
"download_url": "https://files.pythonhosted.org/packages/2c/8b/3f7ca8faf98869e6d04411f930f2ce96d5ddab2ab96a226a13f2095432cb/eemeter-4.0.1.tar.gz",
"platform": null,
"description": "\nEEmeter: tools for calculating metered energy savings\n=====================================================\n\n.. image:: https://travis-ci.org/openeemeter/eemeter.svg?branch=master\n :target: https://travis-ci.org/openeemeter/eemeter\n :alt: Build Status\n\n.. image:: https://img.shields.io/github/license/openeemeter/eemeter.svg\n :target: https://github.com/openeemeter/eemeter\n :alt: License\n\n.. image:: https://readthedocs.org/projects/eemeter/badge/?version=master\n :target: https://eemeter.readthedocs.io/?badge=master\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/eemeter.svg\n :target: https://pypi.python.org/pypi/eemeter\n :alt: PyPI Version\n\n.. image:: https://codecov.io/gh/openeemeter/eemeter/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/openeemeter/eemeter\n :alt: Code Coverage Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n :alt: Code Style\n\n---------------\n\n**EEmeter** \u2014 an open source toolkit for implementing and developing standard\nmethods for calculating normalized metered energy consumption (NMEC) and\navoided energy use.\n\nBackground - why use the EEMeter library\n----------------------------------------\n\nAt time of writing (Sept 2018), the OpenEEmeter, as implemented in the eemeter\npackage and sibling `eeweather package <http://eeweather.openee.io>`_, contains the\nmost complete open source implementation of the\n`CalTRACK Methods <https://caltrack.org/>`_, which\nspecify a family of ways to calculate and aggregate estimates avoided energy\nuse at a single meter particularly suitable for use in pay-for-performance\n(P4P) programs.\n\nThe eemeter package contains a toolkit written in the python langage which may\nhelp in implementing a CalTRACK compliant analysis.\n\nIt contains a modular set of of functions, parameters, and classes which can be\nconfigured to run the CalTRACK methods and close variants.\n\n.. note::\n\n Please keep in mind that use of the OpenEEmeter is neither necessary nor\n sufficient for compliance with the CalTRACK method specification. For example,\n while the CalTRACK methods set specific hard limits for the purpose of\n standardization and consistency, the EEmeter library can be configured to edit\n or entirely ignore those limits. This is becuase the emeter package is used not\n only for compliance with, but also for *development of* the CalTRACK methods.\n\n Please also keep in mind that the EEmeter assumes that certain data cleaning\n tasks specified in the CalTRACK methods have occurred prior to usage with the\n eemeter. The package proactively exposes warnings to point out issues of this\n nature where possible.\n\nInstallation\n------------\n\nEEmeter is a python package and can be installed with pip.\n\n::\n\n $ pip install eemeter\n\nFeatures\n--------\n\n- Reference implementation of standard methods\n\n - CalTRACK Daily Method\n - CalTRACK Monthly Billing Method\n - CalTRACK Hourly Method\n\n- Flexible sources of temperature data. See `EEweather <https://eeweather.openee.io>`_.\n- Candidate model selection\n- Data sufficiency checking\n- Model serialization\n- First-class warnings reporting\n- Pandas dataframe support\n- Visualization tools\n\nRoadmap for 2020 development\n----------------------------\n\nThe OpenEEmeter project growth goals for the year fall into two categories:\n\n1. Community goals - we want help our community thrive and continue to grow.\n2. Technical goals - we want to keep building the library in new ways that make it\n as easy as possible to use.\n\nCommunity goals\n~~~~~~~~~~~~~~~\n\n1. Develop project documentation and tutorials\n\nA number of users have expressed how hard it is to get started when tutorials are\nout of date. We will dedicate time and energy this year to help create high quality\ntutorials that build upon the API documentation and existing tutorials.\n\n2. Make it easier to contribute\n\nAs our user base grows, the need and desire for users to contribute back to the library\nalso grows, and we want to make this as seamless as possible. This means writing and\nmaintaining contribution guides, and creating checklists to guide users through the\nprocess.\n\n\nTechnical goals\n~~~~~~~~~~~~~~~\n\n1. Implement new CalTRACK recommendations\n\nThe CalTRACK process continues to improve the underlying methods used in the\nOpenEEmeter. Our primary technical goal is to keep up with these changes and continue\nto be a resource for testing and experimentation during the CalTRACK methods setting\nprocess.\n\n2. Hourly model visualizations\n\nThe hourly methods implemented in the OpenEEMeter library are not yet packaged with\nhigh quality visualizations like the daily and billing methods are. As we build and\npackage new visualizations with the library, more users will be able to understand,\ndeploy, and contribute to the hourly methods.\n\n3. Weather normal and unusual scenarios\n\nThe EEweather package, which supports the OpenEEmeter, comes packaged with publicly\navailable weather normal scenarios, but one feature that could help make that easier\nwould be to package methods for creating custom weather year scenarios.\n\n4. Greater weather coverage\n\nThe weather station coverage in the EEweather package includes full coverage of US and\nAustralia, but with some technical work, it could be expanded to include greater, or\neven worldwide coverage.\n\nLicense\n-------\n\nThis project is licensed under [Apache 2.0](LICENSE).\n\nOther resources\n---------------\n\n- `CONTRIBUTING <CONTRIBUTING.md>`_: how to contribute to the project.\n- `MAINTAINERS <MAINTAINERS.md>`_: an ordered list of project maintainers.\n- `CHARTER <CHARTER.md>`_: open source project charter.\n- `CODE_OF_CONDUCT <CODE_OF_CONDUCT.md>`_: Code of conduct for contributors.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Open Energy Efficiency Meter",
"version": "4.0.1",
"project_urls": {
"Homepage": "http://github.com/openeemeter/eemeter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da455f919e83ed826dd4f823fc0b04008304ee623c939ab0eade768cbed5f964",
"md5": "f76acc08f7d8f6402cb71b8a0fbc1620",
"sha256": "8e86e31ed38b283c5ab39ca8216ae2417ad5301c2428c95f275c2cf941696488"
},
"downloads": -1,
"filename": "eemeter-4.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f76acc08f7d8f6402cb71b8a0fbc1620",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 1416923,
"upload_time": "2024-03-04T19:25:21",
"upload_time_iso_8601": "2024-03-04T19:25:21.312338Z",
"url": "https://files.pythonhosted.org/packages/da/45/5f919e83ed826dd4f823fc0b04008304ee623c939ab0eade768cbed5f964/eemeter-4.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c8b3f7ca8faf98869e6d04411f930f2ce96d5ddab2ab96a226a13f2095432cb",
"md5": "863bdde84dcfc8e0fb3e2151b56b069b",
"sha256": "8030c6f4db1b399ae5a87377009a029293654226649d0fecd04a81a95466fd73"
},
"downloads": -1,
"filename": "eemeter-4.0.1.tar.gz",
"has_sig": false,
"md5_digest": "863bdde84dcfc8e0fb3e2151b56b069b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1411545,
"upload_time": "2024-03-04T19:25:23",
"upload_time_iso_8601": "2024-03-04T19:25:23.931935Z",
"url": "https://files.pythonhosted.org/packages/2c/8b/3f7ca8faf98869e6d04411f930f2ce96d5ddab2ab96a226a13f2095432cb/eemeter-4.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 19:25:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openeemeter",
"github_project": "eemeter",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "eemeter"
}
JSON
