honeybee-core


Namehoneybee-core JSON
Version 1.58.64 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/honeybee-core
SummaryA library to create 3D building geometry for various types of environmental simulation.
upload_time2024-11-20 00:18:48
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png)

[![Build Status](https://github.com/ladybug-tools/honeybee-core/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/honeybee-core/actions)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-core/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-core)

[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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/03/30/5327b72c57086769b464a87cb19c5d026af123e61c905ada7998348240d8/honeybee_core-1.58.64.tar.gz",
    "platform": null,
    "description": "![Honeybee](https://www.ladybug.tools/assets/img/honeybee.png)\n\n[![Build Status](https://github.com/ladybug-tools/honeybee-core/actions/workflows/ci.yaml/badge.svg)](https://github.com/ladybug-tools/honeybee-core/actions)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/honeybee-core/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/honeybee-core)\n\n[![Python 3.10](https://img.shields.io/badge/python-3.10-orange.svg)](https://www.python.org/downloads/release/python-3100/) [![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](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.64",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/honeybee-core"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6021bc1ad28463c78ffe7165236e19323179315f05bb646103c2039dc45a94a1",
                "md5": "0a99f047a381a7c2129af38af4e14c8c",
                "sha256": "92282e548cde4424f9fc3d457fc395a6bba8d3ab0ffa86e0a7a99d01b362581f"
            },
            "downloads": -1,
            "filename": "honeybee_core-1.58.64-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0a99f047a381a7c2129af38af4e14c8c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 172745,
            "upload_time": "2024-11-20T00:18:45",
            "upload_time_iso_8601": "2024-11-20T00:18:45.893089Z",
            "url": "https://files.pythonhosted.org/packages/60/21/bc1ad28463c78ffe7165236e19323179315f05bb646103c2039dc45a94a1/honeybee_core-1.58.64-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "03305327b72c57086769b464a87cb19c5d026af123e61c905ada7998348240d8",
                "md5": "0fa59375ce9b8e129354c06a8c030c27",
                "sha256": "8748b39bf3d1fa9334c652761fe369d0ac77aea7ffec7d1d99657b1756e07433"
            },
            "downloads": -1,
            "filename": "honeybee_core-1.58.64.tar.gz",
            "has_sig": false,
            "md5_digest": "0fa59375ce9b8e129354c06a8c030c27",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 353757,
            "upload_time": "2024-11-20T00:18:48",
            "upload_time_iso_8601": "2024-11-20T00:18:48.349427Z",
            "url": "https://files.pythonhosted.org/packages/03/30/5327b72c57086769b464a87cb19c5d026af123e61c905ada7998348240d8/honeybee_core-1.58.64.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-20 00:18:48",
    "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"
}
Ladybug Tools
Elapsed time: 0.45859s