A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

BEMServer

An open source Python server to deploy energy management solutions for buildings.
https://github.com/HIT2GAP-EU-PROJECT/bemserver

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

measurements sanitation control training featured feature-flag feature-toggle

Last synced: about 7 hours ago
JSON representation

Repository metadata

An open source Python server to deploy energy management solutions for buildings

README.md

BEMServer is being fully refactorized! A newer version is under development here. The present version is now abandonned (on our side at least).

Table of Contents

  1. Description
    1. Technologies used
    2. Installation
  2. User guidelines
  3. Developer guidelines
  4. Related work

Description

BEMServer is an open source platform to ease the deployment of energy management software in monitored buildings.

Based on standard technologies (REST APIs, formal ontologies...) it is a Python software that is used to

  • collect data from buildings. Data are currently pushed to BEMServer through a specific REST API. Therefore, for smart meters, adapters need to be developed to connect the meters to BEMServer. For BMS, specific adapters need to be developed, or a third-party solution need to be used to collect data from proprietary protocols (KNX, BACNet...)
  • agregate data collected. Data in buildings are heterogeneous by nature, and come from a variety of sources (meters, sensors, but also human interactions, building descriptions, IFC files...). To ease data access, all data need first to be aggregated and aligned according to a specific model. We use our specific BEMOnt formal ontology to do so.
  • preprocess data. Data from sensors may not be as reliable as expected. In BEMServer we are continuously developing new algorithms to facilitate data access for software developers: data cleansing to avoid blanks and outliers, unit conversion, airhtmetic operations... are at the disposal to get the data as you need them.
  • present data. Through its REST APIs, data are exposed in a standard way to thrid-party developers.

Technologies used

BEMServer is a Python-based software. As a server is it developed using the flask library.

Additionally, its storage system uses 3 different technologies:

  • Apache Jena to store the metadata (i.e. data used to describe all relevant information, from the building, to the measures made by a sensor)
  • HDF5 file format to store timeseries, which are a big part of the data stored, coming from sensors and meters.
  • SQLite to store events. An event is typically generated by a service connected to BEMServer, and can be an alert (e.g. an abnormal energy consumption), or an advice (e.g. potential for energy saving).

Installation

Follow the guideline in INSTALL.md.

User guidelines

BEMServer is mainly dedicated to people and company who want to develop smart energy services for building. As such, it was already used as the support for load forecasting, fault detection and diagnosis, or confort simulation tools. In brief, BEMServer is a tool to be used for domain expert and software developers who do not want to become experts on how to collect data and access them.

In order to install BEMServer, please check the INSTALL.md file. Once up and running, simply use the online REST APIs to interact with your BEMServer instance.

Developer guidelines

Want to be part of the developing team? Want to contribute to the project and join effort in providing the community with an open source tool to deploy energy management softwares? Then, just download the project, fork it, start developing and make a pull request.

Also check the CONTRIBUTING.md file.

Related work

Also, see the presentation on slideShare


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 64
Total Committers: 8
Avg Commits per committer: 8.0
Development Distribution Score (DDS): 0.594

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
BONNAMY Pierre p****y@n****m 26
pbourreau p****u@n****m 10
BONNAMY Pierre p****y@n****m 9
David FREDERIQUE d****e@n****m 6
Jérôme Lafréchoux j****x@n****m 5
Pierre Bourreau p****u@n****m 4
Pierre Bourreau 2
h2g-platform-core h****e@b****g 2

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 7
Total pull requests: 2
Average time to close issues: about 6 hours
Average time to close pull requests: 8 minutes
Total issue authors: 4
Total pull request authors: 1
Average comments per issue: 2.86
Average comments per pull request: 0.0
Merged pull request: 2
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/HIT2GAP-EU-PROJECT/bemserver

Top Issue Authors

  • arunkollan (4)
  • ranusingh1993 (1)
  • LucFrachon (1)
  • s-khini (1)

Top Pull Request Authors

  • Pibmy (2)

Top Issue Labels

Top Pull Request Labels


Dependencies

Dockerfile docker
  • alpine 3.10 build
  • debian stretch-slim build
docker/docker-compose.yml docker
  • nbkinef4/bemserver latest
  • nbkinef4/bemserver-fuseki latest
app/dev-requirements.txt pypi
  • apispec >=0.38.0,<1.0.0 development
  • flake8 >=3.2.0 development
  • pytest >=5.0.0,<6.0.0 development
  • pytest-cov >=2.4.0 development
  • tox >=2.0 development
app/requirements.txt pypi
  • Werkzeug >=0.16.0,<0.17.0
  • apispec >=0.39.0,<1.0.0
  • flask >=1.1.0,<1.2.0
  • flask-jwt-simple >=0.0.3,<0.1.0
  • flask-migrate >=2.1.1,<2.6.0
  • flask-rest-api >=0.10.0,<0.11.0
  • flask-sqlalchemy >=2.3.2,<2.5.0
  • flask_marshmallow >=0.7.0
  • marshmallow >=2.15.2,<3.0.0
  • marshmallow-oneofschema >=1.0.5,<2.0.0
  • numpy >=1.14.0,<1.18.0
  • pandas >=0.25.0,<0.26.0
  • pint >0.7,<0.9
  • python-dateutil >=2.5.0,<2.9.0
  • python-dotenv >=0.8.2,<0.11.0
  • python3-saml >=1.4.1,<1.5
  • pytz ==2019.2
  • requests >=2.22.0,<2.23.0
  • sparqlwrapper >=1.8.4,<1.9.0
  • sqlalchemy >=1.2.5,<1.4.0
  • sqlalchemy-utils >=0.32.21,<0.35.0
  • tables >=3.3.0,<3.6.0
  • webargs >=5.1.3,<6.0
app/setup.py pypi
  • Werkzeug >=0.16.0,<0.17.0
  • apispec >=0.39.0,<1.0.0
  • flask >=1.1.0,<1.2.0
  • flask-jwt-simple >=0.0.3,<0.1.0
  • flask-migrate >=2.1.1,<2.6.0
  • flask-rest-api >=0.10.0,<0.11.0
  • flask-sqlalchemy >=2.3.2,<2.5.0
  • flask_marshmallow >=0.7.0
  • marshmallow >=2.15.2,<3.0.0
  • marshmallow-oneofschema >=1.0.5,<2.0.0
  • numpy >=1.14.0,<1.18.0
  • pandas >=0.25.0,<0.26.0
  • pint >0.7,<0.9
  • python-dateutil >=2.5.0,<2.9.0
  • python-dotenv >=0.8.2,<0.11.0
  • python3-saml >=1.4.1,<1.5
  • pytz ==2019.2
  • requests >=2.22.0,<2.23.0
  • sparqlwrapper >=1.8.4,<1.9.0
  • sqlalchemy >=1.2.5,<1.4.0
  • sqlalchemy-utils >=0.32.21,<0.35.0
  • tables >=3.3.0,<3.6.0
  • webargs >=5.1.3,<6.0

Score: 5.886104031450156