Installation#

Stable release#

To install bauwerk, run this command in your terminal:

$ pip install bauwerk

This is the preferred method to install bauwerk, as it will always install the most recent stable release.

Note

All Bauwerk dependencies will be automatically installed via pip, no further installation steps are required. Bauwerk does not rely on external building simulation engines such as EnergyPlus.

If you want to use some of the advanced features you can use the following pip install commands with extras to get the relevant dependencies:

  • pip install bauwerk[opt]: all optimisation code (e.g. if you want to use bauwerk.solve()).

  • pip install bauwerk[widget]: anything to do with the game widget.

  • pip install bauwerk[exp]: for running experiments using the bauwerk-exp script.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources#

The sources for bauwerk can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/rdnfn/bauwerk

Or download the tarball:

$ curl -OJL https://github.com/rdnfn/bauwerk/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install