Changes for README.md: 15 added lines, 5 removed lines.
Original line number
Diff line number
Diff line
@@ -10,7 +10,13 @@ Smart control of HVAC systems using data-driven methods.
## About
This repository contains code for analysis and control of various HVAC systems at Engineering Science Building.
This repository contains code for analysis and control of various HVAC systems at Engineering Science Building. It contains:
1. Controller scripts which are run in production.
2. Jupyter notebooks used for data analysis and machine learning.
3. Python packages for data-preprocessing and defining various functions for the above 2.
## Installation and Use
@@ -20,7 +26,7 @@ This repository can be downloaded via `git clone` or [directly as a zip file her
### Installation for ESB condenser water control
The controller imports measurements from BDX (Buildinglogix Data eXchange), and writes a setpoint to a text file. Access to BDX requires login credentials.
The controller (`src/controller.py`) imports measurements from BDX (Buildinglogix Data eXchange), and writes a setpoint to a text file. Access to BDX requires login credentials.
To run the controller, (1) review control settings, (2) create the production environment, (3) activate it, and (4) call the script.
@@ -80,15 +86,19 @@ Example commands:
conda activate esb-prod
# Take action every 300s and output to out.txt. Logs default to ./logs.txt
# Uses settings from the default location (src/settings.ini)