Home Comfort Dataset

Processing of the dataset gathered in the scope of the Smart Green Homes project.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Example
4. License
5. Acknowledgments

About The Project

Processing of the dataset gathered during the execution of the Smart Green Homes project. This dataset comprises of envioronmental collected from volunteers' homes, which can be used for researching and developing techonogy solutions for households, with the goal of raising standards of comfort, safety and user satisfaction.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

The steps to execute both the script to generate the charts and the script to generate a report on the dataset format are explained below.

Prerequisites

To run the script you need to have at least Python 3.8 installed on your machine. You can find out how in the official page.

Installation

1. Clone the repository

   git clone https://github.com/immarianaas/home-comfort-dataset.git

2. Install Python packages

   cd home-comfort-dataset
   python3 -m venv venv
   source venv/bin/activate
   python -m pip install -r requirements.txt

(back to top)

Usage

There are two scripts you can run.

plot.py wll produce the charts regarding the information in the dataset. Some arguments to keep in mind:

Positional arguments	Descriptions
DATASET PATH	path to directory where the dataset files are placed
SAVE IMAGES PATH	existing directory where the images are to be saved if ADDITIONAL DIRECTORY is not set

Optional arguments	Descriptions
-h, --help	shows a help message and exits
-d ADDITIONAL DIRECTORY	directory that might not exist (it will be created in that case); if set, they are to be saved on <SAVE IMAGES PATH>/<ADDITIONAL DIRECTORY>
--titles	charts are to be saved with titles (set by default)
--no-titles	charts are to be saved without titles

On the other hand, data.py displays information regarding the dataset structure and formats. It only requires the introduction of the dataset path:

Positional arguments	Descriptions
DATASET PATH	path to directory where the dataset files are placed

Example

# considering that '~/Documents/dataset' was the dataset files
# images should be saved on '~/Documents/plot_images'
python plot.py ~/Documents/dataset ~/Documents -d plot_images

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

This work is funded by FCT/MEC through national funds under the project PTDC/ EEI-TEL/30685/2017; and by FCT/MCTES through national funds and when applicable co-funded EU funds under the project UIDB/50008/2020-UIDP/50008/2020.

(back to top)