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

:honeybee: :blue_book: Python package for translating between Honeybee and OpenStudio
https://github.com/ladybug-tools/honeybee-openstudio

Last synced: 4 months ago
JSON representation

:honeybee: :blue_book: Python package for translating between Honeybee and OpenStudio

• Host: GitHub
• URL: https://github.com/ladybug-tools/honeybee-openstudio
• Owner: ladybug-tools
• License: agpl-3.0
• Created: 2024-12-16T21:45:39.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2026-01-30T18:01:27.000Z (4 months ago)
• Last Synced: 2026-01-31T11:02:44.945Z (4 months ago)
• Language: Python
• Homepage: https://www.ladybug.tools/honeybee-openstudio/docs/
• Size: 3.8 MB
• Stars: 0
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# honeybee-openstudio

[![Build Status](https://github.com/ladybug-tools/honeybee-openstudio/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-openstudio/actions)

[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/)

[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png) ![OpenStudio](https://nrel.github.io/OpenStudio-user-documentation/img/os_thumb.png)

Honeybee extension for translation to/from OpenStudio.

Specifically, this package extends [honeybee-core](https://github.com/ladybug-tools/honeybee-core) and [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy) to perform translations to/from OpenStudio using the [OpenStudio](https://github.com/NREL/OpenStudio) SDK.

## Installation

`pip install -U honeybee-openstudio`

## QuickStart

```console

import honeybee_openstudio

```

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

## Local Development

1. Clone this repo locally

```console

git clone git@github.com:ladybug-tools/honeybee-openstudio

# or

git clone https://github.com/ladybug-tools/honeybee-openstudio

```

2. Install dependencies:

```

cd honeybee-openstudio

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_openstudio

sphinx-build -b html ./docs ./docs/_build/docs

```