An open API service indexing awesome lists of open source software.

https://github.com/ladybug-tools/honeybee-doe2

:honeybee: 🗼 Honeybee extension for energy simulation with DOE2
https://github.com/ladybug-tools/honeybee-doe2

Last synced: 9 months ago
JSON representation

:honeybee: 🗼 Honeybee extension for energy simulation with DOE2

Awesome Lists containing this project

README

          

# honeybee-doe2

Honeybee extension for energy modeling with the DOE-2 engine.

[DOE-2](https://www.doe2.com/) is a widely used and accepted freeware building energy analysis program that can predict the energy use and cost for all types of buildings.

## Installation

`pip install -U honeybe-doe2`

## QuickStart

```console
import honeybee_doe2
```

## [API Documentation](http://ladybug-tools.github.io/honeybee-doe2/docs)

## Local Development

1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-doe2

# or

git clone https://github.com/ladybug-tools/honeybee-doe2
```
2. Install dependencies:
```
cd honeybee-doe2
pip install -r dev-requirements.txt
pip install -r requirements.txt
```

3. Run Tests:
```console
python -m pytest tests/
```

4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_doe2
sphinx-build -b html ./docs ./docs/_build/docs
```