Skip to content

SunSpecOrangeButton/pyoblib

Repository files navigation

Orange Button Python Library (pyoblib)

License TravisCI Documentation Status codecov

The Orange Button Python Library, also called, pyoblib, provides functions to interact and work with the SunSpec Orange Button Taxonomy and provides capabilities that simplify working with Orange Button data.

Full Documentation can be found at Read the Docs.

Getting Started

Requirements

Python 3.4 - 3.6.

Installation

For instructions on how to install, refer to the Installation section on Read the Docs.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Authors

See the list of contributors who have participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Acknowledgments

We are greatly thankful to the contributors of the Orange Button Python Library for their hard work and dedication.

  • The Orange Button Specification was built by several organizations in the Orange Button Implementors Network with guidance by XBRL US.
  • Orange Button GitHub and tool accounts are supplied by SunSpec Alliance.
  • The procedures and infrastructure for this library are based upon pvlib. For more information see William F. Holmgren, Clifford W. Hansen, and Mark A. Mikofski. "pvlib python: a python package for modeling solar energy systems." Journal of Open Source Software, 3(29), 884, (2018). https://doi.org/10.21105/joss.00884