NREL / alfalfa

Alfalfa is a web service that enables runtime interaction with building energy models (OpenStudio/EnergyPlus and FMUs compiled from Modelica or Spawn) over REST APIs.
Other
43 stars 13 forks source link

Alfalfa Virtual Building Service

Alfalfa is an open source web application forged in the melting pot of Building Energy Modeling (BEM), Building Controls, and Software Engineering domain expertise. Alfalfa transforms Building Energy Models (BEMs) into virtual buildings by providing industry standard building control interfaces for interacting with models as they run. From a software engineering perspective, Alfalfa leverages widely adopted open source products and is architected according to best practices for a robust, modular, and scalable architecture.

User Documentation

Documentation resides in the GitHub wiki!

Developer Documentation

We are currently working on increasing our developer documentation. See how to run the tests on the GitHub wiki. For releasing, see the wiki's release instructions.

Related Repositories

Docker Images

There are several docker images that are provided for easy deployment using Alfalfa through Helm or other docker services. The images include:

Python Notebooks

An Alfalfa Python Notebook repository contains examples on how to interact with Alfalfa.

Alfalfa Client

The Alfalfa Client is a Python library for making API calls to Alfalfa easier. The source code is available on GitHub and the package is released through PyPi.