Skip to main content

A library with poly skeleton methods using ladybug-geometry

Project description

Build Status Coverage Status

Python 3.7 Python 2.7 IronPython

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 git@github.com:ladybug-tools/ladybug-geometry-polyskel

# or

git clone https://github.com/ladybug-tools/ladybug-geometry-polyskel
  1. Install dependencies:
cd ladybug-geometry-polyskel
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_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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ladybug_geometry_polyskel-1.7.30.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

ladybug_geometry_polyskel-1.7.30-py2.py3-none-any.whl (38.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ladybug_geometry_polyskel-1.7.30.tar.gz.

File metadata

File hashes

Hashes for ladybug_geometry_polyskel-1.7.30.tar.gz
Algorithm Hash digest
SHA256 aa8de5b5a0da317256137e172df115997e50f95c8d936c468144dd544ba8c97b
MD5 e7ba114ef168fe01dca2f9231a954ac7
BLAKE2b-256 27e8b1cceb9c60a01b78ed474bde94b47139b7d33d4ba37ea08b233fece54542

See more details on using hashes here.

File details

Details for the file ladybug_geometry_polyskel-1.7.30-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ladybug_geometry_polyskel-1.7.30-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4ab9d9f013549fe461e050cbd5224c5a8f2b9e91e2696d91a2aa4647d2541e2c
MD5 1442871a595e3c4be3d330146eabff5d
BLAKE2b-256 438dd3718f553c96374570d5f1080cbe95dbdbd518a4f11934c56a8ebd57ec26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page