honeybee-openstudio


Namehoneybee-openstudio JSON
Version 0.3.14 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/honeybee-openstudio
SummaryHoneybee extension for translating HBJSON models to OpenStudio (for OSM, IDF and gbXML).
upload_time2025-08-29 22:44:02
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements honeybee-energy openstudio
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # honeybee-openstudio

![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png)

[![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 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
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools/honeybee-openstudio",
    "name": "honeybee-openstudio",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Ladybug Tools",
    "author_email": "info@ladybug.tools",
    "download_url": "https://files.pythonhosted.org/packages/43/c0/0fc76dfba2079433fb7fdcf5ecd8ef8923f7953d2cc49c64bd8d87e9a644/honeybee_openstudio-0.3.14.tar.gz",
    "platform": null,
    "description": "# honeybee-openstudio\n\n![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png)\n\n[![Build Status](https://github.com/ladybug-tools/honeybee-openstudio/workflows/CI/badge.svg)](https://github.com/ladybug-tools/honeybee-openstudio/actions)\n\n[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/)\n[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\nHoneybee extension for translation to/from OpenStudio.\n\nSpecifically, 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.\n\n## Installation\n\n`pip install -U honeybee-openstudio`\n\n## QuickStart\n\n```console\nimport honeybee_openstudio\n```\n\n## [API Documentation](http://ladybug-tools.github.io/honeybee-openstudio/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-openstudio\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-openstudio\n```\n2. Install dependencies:\n```\ncd honeybee-openstudio\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./honeybee_openstudio\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "Honeybee extension for translating HBJSON models to OpenStudio (for OSM, IDF and gbXML).",
    "version": "0.3.14",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/honeybee-openstudio"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b2b3471c635fe4a041ce562f11b356781f9b0b1b10243df4c20eb254a893678d",
                "md5": "108da2f145eebb6badcd038ec6c14a29",
                "sha256": "6bdd7dd65bfc79f6a161155d421c46aa3aa567d48365be9dc47dd1961b4d23e8"
            },
            "downloads": -1,
            "filename": "honeybee_openstudio-0.3.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "108da2f145eebb6badcd038ec6c14a29",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 169742,
            "upload_time": "2025-08-29T22:44:01",
            "upload_time_iso_8601": "2025-08-29T22:44:01.145427Z",
            "url": "https://files.pythonhosted.org/packages/b2/b3/471c635fe4a041ce562f11b356781f9b0b1b10243df4c20eb254a893678d/honeybee_openstudio-0.3.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "43c00fc76dfba2079433fb7fdcf5ecd8ef8923f7953d2cc49c64bd8d87e9a644",
                "md5": "9816f5cb4c7f38a7292f11670f3baa00",
                "sha256": "c22148505dcf12c6a80ff74b8ee195b5f5078fb27b70b6f83949fe83cd66e952"
            },
            "downloads": -1,
            "filename": "honeybee_openstudio-0.3.14.tar.gz",
            "has_sig": false,
            "md5_digest": "9816f5cb4c7f38a7292f11670f3baa00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 159080,
            "upload_time": "2025-08-29T22:44:02",
            "upload_time_iso_8601": "2025-08-29T22:44:02.199501Z",
            "url": "https://files.pythonhosted.org/packages/43/c0/0fc76dfba2079433fb7fdcf5ecd8ef8923f7953d2cc49c64bd8d87e9a644/honeybee_openstudio-0.3.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-29 22:44:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ladybug-tools",
    "github_project": "honeybee-openstudio",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "honeybee-energy",
            "specs": [
                [
                    ">=",
                    "1.112.4"
                ]
            ]
        },
        {
            "name": "openstudio",
            "specs": [
                [
                    "==",
                    "3.9.0"
                ]
            ]
        }
    ],
    "lcname": "honeybee-openstudio"
}
        
Elapsed time: 2.30169s