Skip to content

🐞 🌐 Ladybug extension to translate Ladybug geometry to VTK format

License

Notifications You must be signed in to change notification settings

ladybug-tools/ladybug-vtk

Repository files navigation

Build Status

Python 3.7

ladybug-vtk

Provides methods for translating ladybug-geometry objects to VTK PolyData.

Installation

To install the library use:

pip install ladybug-vtk

QuickStart

import ladybug_vtk

Local Development

  1. Clone this repo locally
git clone [email protected]:ladybug-tools/ladybug-vtk

# or

git clone https://github.com/ladybug-tools/ladybug-vtk
  1. Install dependencies:
cd ladybug-vtk
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_vtk
sphinx-build -b html ./docs ./docs/_build/docs