[](https://github.com/ladybug-tools/honeybee-core/actions)
[](https://coveralls.io/github/ladybug-tools/honeybee-core)
[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# honeybee-core
Honeybee is a collection of Python libraries to create representations of buildings
following [honeybee-schema](https://github.com/ladybug-tools/honeybee-schema/wiki).
This package is the core library that provides honeybee's common functionalities.
To extend these functionalities you should install available Honeybee extensions or write
your own.
Here are a number of frequently used extensions for Honeybee:
- [honeybee-radiance](https://github.com/ladybug-tools/honeybee-radiance): Adds daylight simulation to Honeybee.
- [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy): Adds Energy simulation to Honeybee.
- [honeybee-display](https://github.com/ladybug-tools/honeybee-display): Adds VTK visualization to Honeybee.
# Installation
To install the core library use:
`pip install -U honeybee-core`
To check if Honeybee command line interface is installed correctly use `honeybee viz` and you
should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response! :bee:
# [API Documentation](https://www.ladybug.tools/honeybee-core/docs/)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/honeybee-core.git
# or
git clone https://github.com/ladybug-tools/honeybee-core.git
```
2. Install dependencies:
```console
cd honeybee-core
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
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/honeybee-core",
"name": "honeybee-core",
"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/4f/53/3f7eadebfd77b5caa8f8c34d37408c20489363a40c4d2b119286432925cc/honeybee_core-1.58.58.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/ladybug-tools/honeybee-core/actions)\n[](https://coveralls.io/github/ladybug-tools/honeybee-core)\n\n[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# honeybee-core\n\nHoneybee is a collection of Python libraries to create representations of buildings\nfollowing [honeybee-schema](https://github.com/ladybug-tools/honeybee-schema/wiki).\n\nThis package is the core library that provides honeybee's common functionalities.\nTo extend these functionalities you should install available Honeybee extensions or write\nyour own.\n\nHere are a number of frequently used extensions for Honeybee:\n\n- [honeybee-radiance](https://github.com/ladybug-tools/honeybee-radiance): Adds daylight simulation to Honeybee.\n- [honeybee-energy](https://github.com/ladybug-tools/honeybee-energy): Adds Energy simulation to Honeybee.\n- [honeybee-display](https://github.com/ladybug-tools/honeybee-display): Adds VTK visualization to Honeybee.\n\n\n# Installation\n\nTo install the core library use:\n\n`pip install -U honeybee-core`\n\nTo check if Honeybee command line interface is installed correctly use `honeybee viz` and you\nshould get a `viiiiiiiiiiiiizzzzzzzzz!` back in response! :bee:\n\n# [API Documentation](https://www.ladybug.tools/honeybee-core/docs/)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/honeybee-core.git\n\n# or\n\ngit clone https://github.com/ladybug-tools/honeybee-core.git\n```\n2. Install dependencies:\n```console\ncd honeybee-core\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\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A library to create 3D building geometry for various types of environmental simulation.",
"version": "1.58.58",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f67aa65ceedefeb3a8ff4208598ac8384e92746fbc09433e8282943dfaa33aa",
"md5": "6edd501c8194ffda3fdcb30ae570f998",
"sha256": "17ede12f453b45208efea99cb23bf58283bb4ad1082c2ee0668e9aed38c22d32"
},
"downloads": -1,
"filename": "honeybee_core-1.58.58-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6edd501c8194ffda3fdcb30ae570f998",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 172053,
"upload_time": "2024-10-29T21:04:37",
"upload_time_iso_8601": "2024-10-29T21:04:37.012278Z",
"url": "https://files.pythonhosted.org/packages/7f/67/aa65ceedefeb3a8ff4208598ac8384e92746fbc09433e8282943dfaa33aa/honeybee_core-1.58.58-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f533f7eadebfd77b5caa8f8c34d37408c20489363a40c4d2b119286432925cc",
"md5": "5ee975c77e42456be57efbaa827324bd",
"sha256": "8cf692b8988392bb8a86ced2bfe61ef75ba73cc2d3592468f08cd364ce04de70"
},
"downloads": -1,
"filename": "honeybee_core-1.58.58.tar.gz",
"has_sig": false,
"md5_digest": "5ee975c77e42456be57efbaa827324bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 353126,
"upload_time": "2024-10-29T21:04:39",
"upload_time_iso_8601": "2024-10-29T21:04:39.125625Z",
"url": "https://files.pythonhosted.org/packages/4f/53/3f7eadebfd77b5caa8f8c34d37408c20489363a40c4d2b119286432925cc/honeybee_core-1.58.58.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 21:04:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "honeybee-core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ladybug-core",
"specs": [
[
"==",
"0.43.13"
]
]
},
{
"name": "ladybug-geometry-polyskel",
"specs": [
[
"==",
"1.7.11"
]
]
},
{
"name": "honeybee-schema",
"specs": [
[
"==",
"1.58.5"
]
]
}
],
"lcname": "honeybee-core"
}
JSON
