https://github.com/ladybug-tools/ladybug-vtk

🐞 🌐 Ladybug extension to translate Ladybug geometry to VTK format
https://github.com/ladybug-tools/ladybug-vtk

Last synced: 4 months ago
JSON representation

🐞 🌐 Ladybug extension to translate Ladybug geometry to VTK format

• Host: GitHub
• URL: https://github.com/ladybug-tools/ladybug-vtk
• Owner: ladybug-tools
• License: agpl-3.0
• Created: 2021-11-19T19:48:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-09-03T15:30:49.000Z (9 months ago)
• Last Synced: 2025-09-07T23:29:59.742Z (9 months ago)
• Language: HTML
• Homepage: https://www.ladybug.tools/ladybug-vtk/docs/
• Size: 3.85 MB
• Stars: 5
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![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

```