EntropyEcosystem / Entropy

An innovative energy-aware IT ecosystem for motivating behavioural changes towards the adoption of energy efficient lifestyles

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Entropy

An innovative energy-aware IT ecosystem for motivating behavioural changes towards the adoption of energy efficient lifestyles.

The ENTROPY platform is one of the main outcomes of the ENTROPY H2020 project (https://entropy-project.eu/). This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 649849.

Prerequisites:

  1. Docker (https://docs.docker.com/install/linux/docker-ce/ubuntu/)
    Tip: upon installing docker, check that your user has permission to run docker commands. To do so, add your user to the docker group and reboot the virtual machine.
sudo groupadd docker
sudo usermod -aG docker your_username
sudo reboot now
  1. Docker Compose (https://docs.docker.com/compose/install/)
    Check your docker compose installation:
docker-compose --version

The current installation guide has been created with version docker-compose version 1.23.2, build 1110ad01

Installation:

  1. Create a folder and place into it the following docker-compose.yml file:
mkdir entropyproject
cd entropyproject
touch  docker-compose.yml

The docker-compose.yml file should contain:

version: '3'
services:
  # The pub/sub framework
  activemq:
    image: webcenter/activemq
    ports:
     - 8161:8161
    container_name: activemq
    restart: always
  mongo:
    image: mongo
    ports:
     - 27017:27017
    container_name: mongo
    restart: always
  entropy:
    image: entropyproject/entropy:firsttry
    ports:
     - 8080:8080
    container_name: entropy
    restart: always
  entropy-monitoring:
    image: entropyproject/entropy-monitoring:firsttry
    ports:
     - 8082:8082
    container_name: entropy-monitoring
    restart: always
  entropy-recommendation-engine:
    image: entropyproject/entropy-recommendation-engine:firsttry
    ports:
     - 8081:8081
    container_name: entropy-recommendation-engine
    restart: always
  1. Execute the docker-compose file
docker-compose up -d
  1. The Entropy platform is READY!!! Go to http://localhost:8080 to see it!

  2. The next step is to create an account with admin permisions. You have just to press the 'Select Account option' and create a new account

  3. You are very close! The last step is to log into the mongo container and give admin permisions to the user you have just created. (Don't worry this only happens the first time :-))

docker exec -it mongo bash
>mongo
>use entropy
>db.User.updateOne(
      { "username" : "your_username" },
      { $set: { "isenabled" : true,"isapproved" : true,"userrole" : "ROLE_ADMIN" } }
   );

  1. You are now ready to get into the Entropy platform and start registering your areas, sensors etc. For more info about how to use the Entropy platform please visit our Handbook : https://entropy-platform-handbook.readthedocs.io/en/latest/

If you are developer interested in using the ENTROPY APIs so as to build your application, service or mobile app upon the ENTROPY platform, you will find our wiki page extremely useful: https://github.com/EntropyEcosystem/Entropy/wiki

Repository Maintainers

The following persons are responsible for this repository and have admin rights. They can, for example, merge pull requests.

Feedback-Chanel

  • Please use the GitHub issues to report bugs.

Cite this Work

If you use this tool for your research, publications, or Smart building/IoT projects, please consider to cite the following paper:

Fotopoulou E, Zafeiropoulos A, Terroso-Sáenz F, Şimşek U, González-Vidal A, Tsiolis G, Gouvas P, Liapis P, Fensel A, Skarmeta A. Providing Personalized Energy Management and Awareness Services for Energy Efficiency in Smart Buildings. Sensors. 2017; 17(9):2054. doi:10.3390/s17092054 (https://www.mdpi.com/1424-8220/17/9/2054)

About

An innovative energy-aware IT ecosystem for motivating behavioural changes towards the adoption of energy efficient lifestyles