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.13.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for ladybug_geometry_polyskel-1.7.13.tar.gz
Algorithm Hash digest
SHA256 6753e21dcfa632cfc9984b1cc2334790d3f58c8c0ddde71981cbd44a7d54b839
MD5 bc787da71bc78afa831165efd7596a3f
BLAKE2b-256 ef9573e76772e96877e0eacd119e9f001fe905dc9b53307a7415b736e6a4656c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ladybug_geometry_polyskel-1.7.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eb14aeda9eb814206a99b5596af108e916879da3dd311103be87d3ec50a7522f
MD5 c84289ad41dcd7b9e9faa508b836cc5f
BLAKE2b-256 1c69fc0f4c26a2839772708047669f2ffc9dd2d267d396ab36676e451a6aa8b2

See more details on using hashes here.

Supported by

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