Package: eemeter
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 libraryAt time of writing (Sept 2018), the OpenEEmeter, as implemented in the eemeter
package and siblingeeweather package, contains the
most complete open source implementation of theCalTRACK Methods, 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.NotePlease 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 fordevelopment ofthe 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.InstallationEEmeter is a python package and can be installed with pip.$ pip install eemeterFeaturesReference implementation of standard methodsCalTRACK Daily MethodCalTRACK Monthly Billing MethodCalTRACK Hourly MethodFlexible sources of temperature data. SeeEEweather.Candidate model selectionData sufficiency checkingModel serializationFirst-class warnings reportingPandas dataframe supportVisualization toolsRoadmap for 2020 developmentThe OpenEEmeter project growth goals for the year fall into two categories:Community goals - we want help our community thrive and continue to grow.Technical goals - we want to keep building the library in new ways that make it
as easy as possible to use.Community goalsDevelop project documentation and tutorialsA 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.Make it easier to contributeAs 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 goalsImplement new CalTRACK recommendationsThe 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.Hourly model visualizationsThe 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.Weather normal and unusual scenariosThe 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.Greater weather coverageThe 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.LicenseThis project is licensed under [Apache 2.0](LICENSE).Other resourcesCONTRIBUTING: how to contribute to the project.MAINTAINERS: an ordered list of project maintainers.CHARTER: open source project charter.CODE_OF_CONDUCT: Code of conduct for contributors.