PreHEAT Open Python Package

This is the open Python package to consume Neogrids REST API.

For a quick introduction to how to use it on real-world data, see the quick start guide.

Installation and configuration

Simple installation:

Install the package directly from PyPi using:

pip install preheat_open

Configuring the toolbox

First, make sure that you have created an API key for your user. This can be done on your user profile page in the PreHEAT App.

Now, you can store the API key in a configuration file. This user configuration file should be created in the following places:

OS	User level (recommended)	Machine level
Windows	C:/Users/[your user]/.preheat/config.json	(unsupported)
Linux	~/.preheat/config.json	/etc[/opt]/preheat/config.json

The configuration files are read in the following priority order (using the first available):

1- User level

2- Machine level (Linux only): /etc/opt/preheat/config.json

3- Machine level (Linux only): /etc/preheat/config.json

And then add the following content in this file (adjusting with your API key):

{
  "PREHEAT_API_KEY": "YOUR_API_KEY_HERE"
}

Alternatively, you can also just import it explicitly in your code using the following command in your code (this is however not recommended, as you risk compromising your API key when sharing your code with others) :

from preheat_open import set_api_key

set_api_key("YOUR_API_KEY_HERE")

Additional Information

You can find additional information about the PreHeat API here.

Contributions

We encourage pull requests if you have developed new interesting features.

Contents:

• Quick start guide
  • Creating and setting up an API Key
  • Loading buildings and their data
  • Accessing the data in the building
  • Sending control signals
• Package Documentation
  • preheat_open
• Tutorials
  • Example of usage of data for further modelling
  • Quick start guide
  • Example of working with zone in buildings

• Index

• Module Index

• Search Page