[](https://travis-ci.com/ladybug-tools/honeybee-core)
[](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-energy](https://github.com/ladybug-tools/honeybee-energy): Adds Energy simulation to Honeybee.
- [honeybee-radiance](https://github.com/ladybug-tools/honeybee-radiance): Adds daylight simulation 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/ac/83/1514be5ac1ac17f2cde56c80a49fba5f37e0e70af5581b77369cc498edcf/honeybee-core-1.58.4.tar.gz",
"platform": null,
"description": "\n\n[](https://travis-ci.com/ladybug-tools/honeybee-core)\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-energy](https://github.com/ladybug-tools/honeybee-energy): Adds Energy simulation to Honeybee.\n- [honeybee-radiance](https://github.com/ladybug-tools/honeybee-radiance): Adds daylight simulation to Honeybee.\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.4",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/honeybee-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e6dd9f8c9e2fb9723110d876423dd9bf20d4cabb18d96c123bb7b4e581b761c3",
"md5": "9e6e9dc0ec73fbdac4c44a0db13def28",
"sha256": "1af20fd62819f4f40b4d4ba193b01caa870c7ec2ade10e730e5ff581715fc327"
},
"downloads": -1,
"filename": "honeybee_core-1.58.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e6e9dc0ec73fbdac4c44a0db13def28",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 167771,
"upload_time": "2024-04-23T15:34:44",
"upload_time_iso_8601": "2024-04-23T15:34:44.449649Z",
"url": "https://files.pythonhosted.org/packages/e6/dd/9f8c9e2fb9723110d876423dd9bf20d4cabb18d96c123bb7b4e581b761c3/honeybee_core-1.58.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac831514be5ac1ac17f2cde56c80a49fba5f37e0e70af5581b77369cc498edcf",
"md5": "e9b675e9c6ff0fd91fb98c5fbd64e5a2",
"sha256": "3a68e7ea51c03b621b4e499c6d2e9b3926a61af3fb2d163ab011bafdac8494c6"
},
"downloads": -1,
"filename": "honeybee-core-1.58.4.tar.gz",
"has_sig": false,
"md5_digest": "e9b675e9c6ff0fd91fb98c5fbd64e5a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 345351,
"upload_time": "2024-04-23T15:34:49",
"upload_time_iso_8601": "2024-04-23T15:34:49.481784Z",
"url": "https://files.pythonhosted.org/packages/ac/83/1514be5ac1ac17f2cde56c80a49fba5f37e0e70af5581b77369cc498edcf/honeybee-core-1.58.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 15:34:49",
"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": [],
"lcname": "honeybee-core"
}
JSON
