ladybug-geometry-polyskel

A library with straight skeleton methods using ladybug-geometry.

Credits

Ladybug-geometry-polyskel is a derivative work of the the polyskel package by Ármin Scipiades (@Bottfy), which is, itself, a Python 3 implementation of the straight skeleton algorithm as described by Felkel and Obdržálek in their 1998 conference paper Straight skeleton implementation.

Key differences between Bottfy's original implementation and this package are:

• It has been modified for compatibility with both Python 2.7 and Python 3.7.
• The code as been re-stylized to conform to the PEP8 style guide.
• Modules have been added to extract core/perimeter polygons from the straight skeleton.

Installation

pip install -U ladybug-geometry-polyskel

QuickStart

import ladybug_geometry_polyskel

API Documentation

Local Development

1. Clone this repo locally

git clone [email protected]:ladybug-tools/ladybug-geometry-polyskel

# or

git clone https://github.com/ladybug-tools/ladybug-geometry-polyskel

2. Install dependencies:

cd ladybug-geometry-polyskel
pip install -r dev-requirements.txt
pip install -r requirements.txt

3. Run Tests:

python -m pytest tests/

4. Generate Documentation:

sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_geometry_polyskel
sphinx-build -b html ./docs ./docs/_build/docs

Copyright

Ladybug Geometry Polyskel, Copyright (c) 2021, Ármin Scipiades, Ladybug Tools LLC and other contributors. All rights reserved.