[![Build Status](https://github.com/ladybug-tools/ladybug-vtk/workflows/CI/badge.svg)](https://github.com/ladybug-tools/ladybug-vtk/actions)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
# ladybug-vtk
Provides methods for translating ladybug-geometry objects to VTK PolyData.
## Installation
To install the library use:
```console
pip install ladybug-vtk
```
## QuickStart
```python
import ladybug_vtk
```
## [API Documentation](http://ladybug-tools.github.io/ladybug-vtk/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/ladybug-vtk
# or
git clone https://github.com/ladybug-tools/ladybug-vtk
```
2. Install dependencies:
```console
cd ladybug-vtk
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 ./ladybug_vtk
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/ladybug-vtk",
"name": "ladybug-vtk",
"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/68/e9/4650c61c9d1706412d9ad9e33be5e9117bd5f5e82dd05b476843bb93a9c9/ladybug_vtk-0.15.1.tar.gz",
"platform": null,
"description": "[![Build Status](https://github.com/ladybug-tools/ladybug-vtk/workflows/CI/badge.svg)](https://github.com/ladybug-tools/ladybug-vtk/actions)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)\n\n# ladybug-vtk\n\nProvides methods for translating ladybug-geometry objects to VTK PolyData.\n\n## Installation\n\nTo install the library use:\n\n```console\npip install ladybug-vtk\n```\n\n## QuickStart\n```python\nimport ladybug_vtk\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/ladybug-vtk/docs)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/ladybug-vtk\n\n# or\n\ngit clone https://github.com/ladybug-tools/ladybug-vtk\n```\n2. Install dependencies:\n```console\ncd ladybug-vtk\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 ./ladybug_vtk\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Provides methods for translating ladybug-geometry objects to VTK PolyData.",
"version": "0.15.1",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/ladybug-vtk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8fcd480e3f139ad7da06ffcebe7e60f292334e76be7e0226dbec3529da30591",
"md5": "439e4a968197deceb4ffce09c5a3d7ae",
"sha256": "0ca8df6f18021ff90c0d28bf49b54498e190cfb158c019f8165c294e69faf659"
},
"downloads": -1,
"filename": "ladybug_vtk-0.15.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "439e4a968197deceb4ffce09c5a3d7ae",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 827891,
"upload_time": "2024-11-20T19:29:27",
"upload_time_iso_8601": "2024-11-20T19:29:27.689592Z",
"url": "https://files.pythonhosted.org/packages/d8/fc/d480e3f139ad7da06ffcebe7e60f292334e76be7e0226dbec3529da30591/ladybug_vtk-0.15.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "68e94650c61c9d1706412d9ad9e33be5e9117bd5f5e82dd05b476843bb93a9c9",
"md5": "60f63853da9d318e5f14885a1b88646b",
"sha256": "7eaf3566e63e620d0d6c016a9de8cde7e3b955a083e3ffc98bb83fb155662972"
},
"downloads": -1,
"filename": "ladybug_vtk-0.15.1.tar.gz",
"has_sig": false,
"md5_digest": "60f63853da9d318e5f14885a1b88646b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1800557,
"upload_time": "2024-11-20T19:29:29",
"upload_time_iso_8601": "2024-11-20T19:29:29.729660Z",
"url": "https://files.pythonhosted.org/packages/68/e9/4650c61c9d1706412d9ad9e33be5e9117bd5f5e82dd05b476843bb93a9c9/ladybug_vtk-0.15.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 19:29:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "ladybug-vtk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ladybug-vtk"
}