Metadata-Version: 2.4
Name: dragonfly-openstudio
Version: 0.2.2
Summary: Dragonfly extension for translating dragonfly-energy objects to OpenStudio.
Home-page: https://github.com/ladybug-tools/dragonfly-openstudio
Author: Ladybug Tools
Author-email: info@ladybug.tools
License: AGPL-3.0
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dragonfly-energy>=1.41.1
Requires-Dist: honeybee-openstudio>=0.4.19
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# dragonfly-openstudio
[![Build Status](https://github.com/ladybug-tools/dragonfly-openstudio/workflows/CI/badge.svg)](https://github.com/ladybug-tools/dragonfly-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/)

![Dragonfly](https://www.ladybug.tools/assets/img/dragonfly.png) <img src="https://global.discourse-cdn.com/sketchup/optimized/3X/9/9/99fa74426b043e577069fadc8ef493f3a399c1ff_2_500x500.jpeg" width="200" height="200">

Dragonfly extension for translation to OpenStudio.

Specifically, this package leverages [honeybee-openstudio](https://github.com/ladybug-tools/honeybee-openstudio) to extend [dragonfly-energy](https://github.com/ladybug-tools/dragonfly-energy) to perform translations to OpenStudio using the [OpenStudio](https://github.com/NREL/OpenStudio) SDK. Translation capabilities include translating dragonfly-energy District Energy Systems (DES) to OpenStudio models of the plant.

## Installation

`pip install -U dragonfly-openstudio`

## QuickStart

```console
import dragonfly_openstudio
```

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

## Local Development

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

# or

git clone https://github.com/ladybug-tools/dragonfly-openstudio
```
2. Install dependencies:
```
cd dragonfly-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 ./dragonfly_openstudio
sphinx-build -b html ./docs ./docs/_build/docs
```
