ladybug-geometry-polyskel


Nameladybug-geometry-polyskel JSON
Version 1.7.13 PyPI version JSON
download
home_pagehttps://github.com/ladybug-tools/ladybug-geometry-polyskel
SummaryA library with poly skeleton methods using ladybug-geometry
upload_time2024-11-15 19:29:52
maintainerNone
docs_urlNone
authorLadybug Tools
requires_pythonNone
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel.svg?branch=master)](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-geometry-polyskel/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/ladybug-geometry-polyskel)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)

# 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](https://github.com/Botffy/polyskel)
by [Ármin Scipiades](https://github.com/Botffy) (@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](https://github.com/Botffy/polyskel/blob/master/doc/StraightSkeletonImplementation.pdf).

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

```console
pip install -U ladybug-geometry-polyskel
```

## QuickStart

```python
import ladybug_geometry_polyskel

```

## [API Documentation](http://ladybug-tools.github.io/ladybug-geometry-polyskel/docs)

## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/ladybug-geometry-polyskel

# or

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ladybug-tools/ladybug-geometry-polyskel",
    "name": "ladybug-geometry-polyskel",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Ladybug Tools",
    "author_email": "info@ladybug.tools",
    "download_url": "https://files.pythonhosted.org/packages/ef/95/73e76772e96877e0eacd119e9f001fe905dc9b53307a7415b736e6a4656c/ladybug_geometry_polyskel-1.7.13.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel.svg?branch=master)](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/ladybug-geometry-polyskel/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/ladybug-geometry-polyskel)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/) [![Python 2.7](https://img.shields.io/badge/python-2.7-green.svg)](https://www.python.org/downloads/release/python-270/) [![IronPython](https://img.shields.io/badge/ironpython-2.7-red.svg)](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# ladybug-geometry-polyskel\n\nA library with straight skeleton methods using ladybug-geometry.\n\n## Credits\n\nLadybug-geometry-polyskel is a derivative work of the the [polyskel package](https://github.com/Botffy/polyskel)\nby [\u00c1rmin Scipiades](https://github.com/Botffy) (@Bottfy), which is, itself, a Python 3\nimplementation of the straight skeleton algorithm as described by Felkel and Obdr\u017e\u00e1lek\nin their 1998 conference paper [Straight skeleton implementation](https://github.com/Botffy/polyskel/blob/master/doc/StraightSkeletonImplementation.pdf).\n\nKey differences between Bottfy's original implementation and this package are:\n\n* It has been modified for compatibility with both Python 2.7 and Python 3.7.\n* The code as been re-stylized to conform to the PEP8 style guide.\n* Modules have been added to extract core/perimeter polygons from the straight skeleton.\n\n## Installation\n\n```console\npip install -U ladybug-geometry-polyskel\n```\n\n## QuickStart\n\n```python\nimport ladybug_geometry_polyskel\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/ladybug-geometry-polyskel/docs)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/ladybug-geometry-polyskel\n\n# or\n\ngit clone https://github.com/ladybug-tools/ladybug-geometry-polyskel\n```\n2. Install dependencies:\n```console\ncd ladybug-geometry-polyskel\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_geometry_polyskel\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n\n## Copyright \n\nLadybug Geometry Polyskel, Copyright (c) 2021, \u00c1rmin Scipiades, Ladybug Tools LLC\nand other contributors. All rights reserved.\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0",
    "summary": "A library with poly skeleton methods using ladybug-geometry",
    "version": "1.7.13",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/ladybug-geometry-polyskel"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c69fc0f4c26a2839772708047669f2ffc9dd2d267d396ab36676e451a6aa8b2",
                "md5": "c84289ad41dcd7b9e9faa508b836cc5f",
                "sha256": "eb14aeda9eb814206a99b5596af108e916879da3dd311103be87d3ec50a7522f"
            },
            "downloads": -1,
            "filename": "ladybug_geometry_polyskel-1.7.13-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c84289ad41dcd7b9e9faa508b836cc5f",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 38698,
            "upload_time": "2024-11-15T19:29:51",
            "upload_time_iso_8601": "2024-11-15T19:29:51.002189Z",
            "url": "https://files.pythonhosted.org/packages/1c/69/fc0f4c26a2839772708047669f2ffc9dd2d267d396ab36676e451a6aa8b2/ladybug_geometry_polyskel-1.7.13-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef9573e76772e96877e0eacd119e9f001fe905dc9b53307a7415b736e6a4656c",
                "md5": "bc787da71bc78afa831165efd7596a3f",
                "sha256": "6753e21dcfa632cfc9984b1cc2334790d3f58c8c0ddde71981cbd44a7d54b839"
            },
            "downloads": -1,
            "filename": "ladybug_geometry_polyskel-1.7.13.tar.gz",
            "has_sig": false,
            "md5_digest": "bc787da71bc78afa831165efd7596a3f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 55001,
            "upload_time": "2024-11-15T19:29:52",
            "upload_time_iso_8601": "2024-11-15T19:29:52.740705Z",
            "url": "https://files.pythonhosted.org/packages/ef/95/73e76772e96877e0eacd119e9f001fe905dc9b53307a7415b736e6a4656c/ladybug_geometry_polyskel-1.7.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-15 19:29:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ladybug-tools",
    "github_project": "ladybug-geometry-polyskel",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ladybug-geometry-polyskel"
}
        
Elapsed time: 0.60318s