electricity-usage 0.1.0

The electricity_usage package provides a scheduler which will kick off processes only when there is a surplus in local energy production.

Welcome to electricity_usage

The electricity_usage package provides a scheduler which will kick off processes only when there is a surplus in local energy production. For more information see the usage documentation.

Installation

The Python package electricity_usage can be installed by cloning the git repository and installing it using pip install.

git clone https://github.com/weyandtim/electricity_usage
pip install electricity_usage

To fully utilize this package, you also need a subscription to Electricity Maps, available here <https://api-portal.electricitymaps.com/>.
Upon subscription, you'll receive an authentication token. This token is used to access additional electricity production and consumption data for specific locations from Electricity Maps.
We incorporate the token using an optional parameter --em_auth_token, in our start command.
Please note that the majority of locations do not require an authentication token.
More information about Electricity Maps can be found in :ref:api-ref.

Development installation

If you want to contribute to the development of electricity_usage, we recommend the following editable installation from this repository:

git clone https://github.com/weyandtim/electricity_usage
cd electricity_usage
python -m pip install --editable .[tests]

Having done so, the test suite can be run using pytest:

python -m pytest

Contributing

This project was done as a software practical by Tim Weyand and Nemo Glade, under supervision of Dominic Kempf.

If you wish to contribute to electricity_usage open an issue in the issue tracker of the GitHub project.

Acknowledgments

This repository was set up using the SSC Cookiecutter for Python Packages. The project relies on data from Electricity Maps.