BEAT: Building Experiment Assistant Toolkit

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is the repository for BEAT, a tool supporting the design and execution of thermo-physiological experiments in the built environment. We are currently developing the tool and are aiming to deploy a beta version soon. Feel free to test the tool locally by using the instructions below.

We found that the lack of standardization across thermo-physiological experiments in buidlings represents a barrier for advancing knowledge in the field. We hope that by gathering and interactively visualizing metadata on thermo-physiological experiments, we can support the development of more consistent and fruitful research in the field. The current dataset includes studies conducted between 2022 and 2024. We are actively working on extending the underlying database to include older studies.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Python 3.x
• pip (Python package installer)

1. Clone the repository to a local directory.

git clone

2. Create virtual environment. On MacOS/Linux:

python3 -m venv venv

• On Windows use the following command:

python -m venv venv

3. Activate the virtual environment. On MacOS/Linux:

source venv/bin/activate

• Windows:

venv\Scripts\activate

4. Install dependencies.

pip install -r requirements.txt

Then you can run the application using the following command:

python app.py

(back to top)

Usage

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature') using commit conventions.
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

(back to top)

Contact

Toby Kramer - t.kramer@berkeley.edu

Project Link: t-kramer/beat

(back to top)

Contributors

• Toby Kramer @ CBE, UC Berkeley | Web Tool Development & Data Analysis
• Bilge Kobas @ SenseLab, TU Munich | Literature Review, Data Analysis & Management

(back to top)