This is a public API for eGUIDE's energy models, currently providing eGUIDE's energy consumption prediction model.
The energy consumption prediction model uses satellite images of structures (buildings) to estimate the level of stable energy consumption post-electrification. An detailed explanation of this model and how to interpret the model results is available in the model documentation.
Hosted Developer documentation is now available on Spotlight. This is the recommended place to get started: https://stoplight.io/p/docs/gh/eguide/eguide-consumption-api
- July 2020 - v0.3 Beta users only. Please contact us to join the beta testing group.
- Sept 2020 - v1.0 Soft launch. Available to anyone upon request. This release will include data for all of Kenya.
To join the beta testing group, please contact us at firstname.lastname@example.org
Navigating this repository / Table of Contents
src/-- The codebase will be released once stable.
docs/-- Documentation on how to use and access the model API. Duplicated on Stoplight.io.
examples/-- Code snippets, Jupyter notebook, etc, utilizing the model.
Submitting issues and feature requests
You may submit issues on this github repository.
If you are new to github, this guide may be helpful: https://docs.github.com/en/github/managing-your-work-on-github/creating-an-issue
For further information contact eGUIDE at email@example.com .