![Build Status](https://github.com/ladybug-tools/ladybug-rhino/workflows/CI/badge.svg)
[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# ladybug-rhino
A library for communicating between Ladybug Tools core libraries and Rhinoceros CAD.
This library is used by both the Grasshopper and Rhino plugins to communicate with
the ladybug core Python library. Note that this library has dependencies
on Rhino SDK and Grasshopper SDK and is intended to contain all of such dependencies
for the LBT-Grasshopper plugin. It is NOT intended to be run with cPython with
the exceptions of running the CLI or when used with the cPython capabilities in Rhino 8.
## Installation
`pip install -U ladybug-rhino`
To check if Ladybug Rhino command line is installed correctly try `ladybug-rhino viz`
and you should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!
## [API Documentation](http://ladybug-tools.github.io/ladybug-rhino/docs/)
## Local Development
1. Clone this repo locally
```python
git clone git@github.com:ladybug-tools/ladybug-rhino
# or
git clone https://github.com/ladybug-tools/ladybug-rhino
```
2. Install dependencies
```console
cd ladybug-rhino
pip install -r dev-requirements.txt
pip install -r requirements.txt
pip install pythonnet
pip install rhinoinside
```
3. Generate Documentation
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_rhino
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/ladybug-rhino",
"name": "ladybug-rhino",
"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/5e/ef/ffff2dc8c86ff49f419e8ab627448349ba020c5d7bc226479090bd837ff1/ladybug_rhino-1.42.19.tar.gz",
"platform": null,
"description": "![Build Status](https://github.com/ladybug-tools/ladybug-rhino/workflows/CI/badge.svg)\n\n[![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# ladybug-rhino\n\nA library for communicating between Ladybug Tools core libraries and Rhinoceros CAD.\n\nThis library is used by both the Grasshopper and Rhino plugins to communicate with\nthe ladybug core Python library. Note that this library has dependencies\non Rhino SDK and Grasshopper SDK and is intended to contain all of such dependencies\nfor the LBT-Grasshopper plugin. It is NOT intended to be run with cPython with\nthe exceptions of running the CLI or when used with the cPython capabilities in Rhino 8.\n\n## Installation\n\n`pip install -U ladybug-rhino`\n\nTo check if Ladybug Rhino command line is installed correctly try `ladybug-rhino viz`\nand you should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!\n\n## [API Documentation](http://ladybug-tools.github.io/ladybug-rhino/docs/)\n\n## Local Development\n\n1. Clone this repo locally\n\n```python\ngit clone git@github.com:ladybug-tools/ladybug-rhino\n\n# or\n\ngit clone https://github.com/ladybug-tools/ladybug-rhino\n```\n\n2. Install dependencies\n\n```console\ncd ladybug-rhino\npip install -r dev-requirements.txt\npip install -r requirements.txt\npip install pythonnet\npip install rhinoinside\n```\n\n3. Generate Documentation\n\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_rhino\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A library for communicating between Ladybug Tools core libraries and Rhinoceros CAD.",
"version": "1.42.19",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/ladybug-rhino"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea5ce13a4052854f9dbf755f1e5f7ed7f999fa5bd3d4580263cff542530043bb",
"md5": "6be219f41964831b2a3902dd324cdd90",
"sha256": "16fad9c809e985b09c7b8254e0f70d32a49345fdcba8083d45d47a3ada5f2a88"
},
"downloads": -1,
"filename": "ladybug_rhino-1.42.19-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6be219f41964831b2a3902dd324cdd90",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 120122,
"upload_time": "2024-10-29T19:24:49",
"upload_time_iso_8601": "2024-10-29T19:24:49.982610Z",
"url": "https://files.pythonhosted.org/packages/ea/5c/e13a4052854f9dbf755f1e5f7ed7f999fa5bd3d4580263cff542530043bb/ladybug_rhino-1.42.19-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5eefffff2dc8c86ff49f419e8ab627448349ba020c5d7bc226479090bd837ff1",
"md5": "801dadf6230a971a922433be796737f1",
"sha256": "65392bbd3dcd42e6f1b3d68a5c2a2ff44696d9a55304f8a41d47da8a7bc0cb52"
},
"downloads": -1,
"filename": "ladybug_rhino-1.42.19.tar.gz",
"has_sig": false,
"md5_digest": "801dadf6230a971a922433be796737f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 155870,
"upload_time": "2024-10-29T19:24:51",
"upload_time_iso_8601": "2024-10-29T19:24:51.679173Z",
"url": "https://files.pythonhosted.org/packages/5e/ef/ffff2dc8c86ff49f419e8ab627448349ba020c5d7bc226479090bd837ff1/ladybug_rhino-1.42.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 19:24:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "ladybug-rhino",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ladybug-rhino"
}