[![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
```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/39/2f/38a21616e32bbbe710552acf9b0308daab3694feaae44e0651542dc3b9e4/ladybug-vtk-0.14.4.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```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.14.4",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/ladybug-vtk"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7414ff81743f7d5d1904fb79ae7134f82771f3634d691373b27135348b4f5136",
"md5": "e642c92cb38ad65cd9988589ac9aa2c9",
"sha256": "b8e4eff27532e603c10b420413812f058cb17dc5d933603209400d199ca6837b"
},
"downloads": -1,
"filename": "ladybug_vtk-0.14.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e642c92cb38ad65cd9988589ac9aa2c9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 827390,
"upload_time": "2024-08-14T14:07:01",
"upload_time_iso_8601": "2024-08-14T14:07:01.236186Z",
"url": "https://files.pythonhosted.org/packages/74/14/ff81743f7d5d1904fb79ae7134f82771f3634d691373b27135348b4f5136/ladybug_vtk-0.14.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "392f38a21616e32bbbe710552acf9b0308daab3694feaae44e0651542dc3b9e4",
"md5": "5a9c4ebc3a88a493512230fcef3d66f9",
"sha256": "850ddfb64728fbf9e23665e571097696f160ef7dc5c61fb489fd8f559b2e4d92"
},
"downloads": -1,
"filename": "ladybug-vtk-0.14.4.tar.gz",
"has_sig": false,
"md5_digest": "5a9c4ebc3a88a493512230fcef3d66f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1798523,
"upload_time": "2024-08-14T14:07:03",
"upload_time_iso_8601": "2024-08-14T14:07:03.332162Z",
"url": "https://files.pythonhosted.org/packages/39/2f/38a21616e32bbbe710552acf9b0308daab3694feaae44e0651542dc3b9e4/ladybug-vtk-0.14.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 14:07:03",
"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": [
{
"name": "ladybug-core",
"specs": [
[
">=",
"0.42.37"
]
]
},
{
"name": "ladybug-display-schema",
"specs": [
[
">=",
"0.7.8"
]
]
},
{
"name": "ladybug-display",
"specs": [
[
">=",
"0.11.2"
]
]
},
{
"name": "vtk",
"specs": [
[
">=",
"9.1.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"<",
"2.0"
]
]
}
],
"lcname": "ladybug-vtk"
}