extremitypathfinder


Nameextremitypathfinder JSON
Version 2.7.2 PyPI version JSON
download
home_pagehttps://extremitypathfinder.readthedocs.io/en/latest/
Summarypython package for fast shortest path computation on 2D polygon or grid maps
upload_time2024-04-10 10:08:39
maintainerNone
docs_urlNone
authorjannikmi
requires_python<4,>=3.8
licenseMIT
keywords path-planning path-finding shortest-path visibility graph polygon grid map robotics navigation offline
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ===================
extremitypathfinder
===================

..
    Note: can't include the badges file from the docs here, as it won't render on PyPI -> sync manually


.. image:: https://github.com/jannikmi/extremitypathfinder/actions/workflows/build.yml/badge.svg?branch=master
    :target: https://github.com/jannikmi/extremitypathfinder/actions?query=branch%3Amaster

.. image:: https://readthedocs.org/projects/extremitypathfinder/badge/?version=latest
    :alt: documentation status
    :target: https://extremitypathfinder.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/wheel/extremitypathfinder.svg
    :target: https://pypi.python.org/pypi/extremitypathfinder

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

.. image:: https://pepy.tech/badge/extremitypathfinder
    :alt: Total PyPI downloads
    :target: https://pepy.tech/project/extremitypathfinder

.. image:: https://img.shields.io/pypi/v/extremitypathfinder.svg
    :alt: latest version on PyPI
    :target: https://pypi.python.org/pypi/extremitypathfinder

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

python package for fast geometric shortest path computation in 2D multi-polygon or grid environments based on visibility graphs.


.. image:: ./docs/_static/title_demo_plot.png


Quick Guide:

Install the package with the optional Numba extra for a significant speedup:

.. code-block:: console

    pip install extremitypathfinder[numba]


.. code-block:: python

    from extremitypathfinder import PolygonEnvironment

    environment = PolygonEnvironment()
    # counter clockwise vertex numbering!
    boundary_coordinates = [(0.0, 0.0), (10.0, 0.0), (9.0, 5.0), (10.0, 10.0), (0.0, 10.0)]
    # clockwise numbering!
    list_of_holes = [
        [
            (3.0, 7.0),
            (5.0, 9.0),
            (4.5, 7.0),
            (5.0, 4.0),
        ],
    ]
    environment.store(boundary_coordinates, list_of_holes, validate=False)
    start_coordinates = (4.5, 1.0)
    goal_coordinates = (4.0, 8.5)
    path, length = environment.find_shortest_path(start_coordinates, goal_coordinates)


For more refer to the `documentation <https://extremitypathfinder.readthedocs.io/en/latest/>`__.


Also see:
`GitHub <https://github.com/jannikmi/extremitypathfinder>`__,
`PyPI <https://pypi.python.org/pypi/extremitypathfinder/>`__


            

Raw data

            {
    "_id": null,
    "home_page": "https://extremitypathfinder.readthedocs.io/en/latest/",
    "name": "extremitypathfinder",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "path-planning, path-finding, shortest-path, visibility, graph, polygon, grid, map, robotics, navigation, offline",
    "author": "jannikmi",
    "author_email": "github@michelfe.it",
    "download_url": "https://files.pythonhosted.org/packages/5c/5a/8692b0a56aca8f51fb5d839d2607ff71b95fd6ba6540784666e09668ac4f/extremitypathfinder-2.7.2.tar.gz",
    "platform": null,
    "description": "===================\nextremitypathfinder\n===================\n\n..\n    Note: can't include the badges file from the docs here, as it won't render on PyPI -> sync manually\n\n\n.. image:: https://github.com/jannikmi/extremitypathfinder/actions/workflows/build.yml/badge.svg?branch=master\n    :target: https://github.com/jannikmi/extremitypathfinder/actions?query=branch%3Amaster\n\n.. image:: https://readthedocs.org/projects/extremitypathfinder/badge/?version=latest\n    :alt: documentation status\n    :target: https://extremitypathfinder.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/pypi/wheel/extremitypathfinder.svg\n    :target: https://pypi.python.org/pypi/extremitypathfinder\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n   :target: https://github.com/pre-commit/pre-commit\n   :alt: pre-commit\n\n.. image:: https://pepy.tech/badge/extremitypathfinder\n    :alt: Total PyPI downloads\n    :target: https://pepy.tech/project/extremitypathfinder\n\n.. image:: https://img.shields.io/pypi/v/extremitypathfinder.svg\n    :alt: latest version on PyPI\n    :target: https://pypi.python.org/pypi/extremitypathfinder\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n\npython package for fast geometric shortest path computation in 2D multi-polygon or grid environments based on visibility graphs.\n\n\n.. image:: ./docs/_static/title_demo_plot.png\n\n\nQuick Guide:\n\nInstall the package with the optional Numba extra for a significant speedup:\n\n.. code-block:: console\n\n    pip install extremitypathfinder[numba]\n\n\n.. code-block:: python\n\n    from extremitypathfinder import PolygonEnvironment\n\n    environment = PolygonEnvironment()\n    # counter clockwise vertex numbering!\n    boundary_coordinates = [(0.0, 0.0), (10.0, 0.0), (9.0, 5.0), (10.0, 10.0), (0.0, 10.0)]\n    # clockwise numbering!\n    list_of_holes = [\n        [\n            (3.0, 7.0),\n            (5.0, 9.0),\n            (4.5, 7.0),\n            (5.0, 4.0),\n        ],\n    ]\n    environment.store(boundary_coordinates, list_of_holes, validate=False)\n    start_coordinates = (4.5, 1.0)\n    goal_coordinates = (4.0, 8.5)\n    path, length = environment.find_shortest_path(start_coordinates, goal_coordinates)\n\n\nFor more refer to the `documentation <https://extremitypathfinder.readthedocs.io/en/latest/>`__.\n\n\nAlso see:\n`GitHub <https://github.com/jannikmi/extremitypathfinder>`__,\n`PyPI <https://pypi.python.org/pypi/extremitypathfinder/>`__\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "python package for fast shortest path computation on 2D polygon or grid maps",
    "version": "2.7.2",
    "project_urls": {
        "Documentation": "https://extremitypathfinder.readthedocs.io/en/latest/",
        "Homepage": "https://extremitypathfinder.readthedocs.io/en/latest/",
        "Repository": "https://github.com/jannikmi/extremitypathfinder"
    },
    "split_keywords": [
        "path-planning",
        " path-finding",
        " shortest-path",
        " visibility",
        " graph",
        " polygon",
        " grid",
        " map",
        " robotics",
        " navigation",
        " offline"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "27bd426d797f117e6df0b17045f8640ef5da232bcd1b2ba4f7e38e103b6185de",
                "md5": "26cfe6329371610154e2ddc41b3d18e6",
                "sha256": "e17d6a3f29d54b240825450e3dac2fc332bfdff62c8247bcddcc007fa38f7151"
            },
            "downloads": -1,
            "filename": "extremitypathfinder-2.7.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "26cfe6329371610154e2ddc41b3d18e6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 47943,
            "upload_time": "2024-04-10T10:08:37",
            "upload_time_iso_8601": "2024-04-10T10:08:37.755306Z",
            "url": "https://files.pythonhosted.org/packages/27/bd/426d797f117e6df0b17045f8640ef5da232bcd1b2ba4f7e38e103b6185de/extremitypathfinder-2.7.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c5a8692b0a56aca8f51fb5d839d2607ff71b95fd6ba6540784666e09668ac4f",
                "md5": "9e9bf8c3be23307cb911672ed2a41b29",
                "sha256": "903498578db6dfaca3e7cbe8279f2e13baa2043660084fb4455f6588af4d93f1"
            },
            "downloads": -1,
            "filename": "extremitypathfinder-2.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9e9bf8c3be23307cb911672ed2a41b29",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 40322,
            "upload_time": "2024-04-10T10:08:39",
            "upload_time_iso_8601": "2024-04-10T10:08:39.488066Z",
            "url": "https://files.pythonhosted.org/packages/5c/5a/8692b0a56aca8f51fb5d839d2607ff71b95fd6ba6540784666e09668ac4f/extremitypathfinder-2.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-10 10:08:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jannikmi",
    "github_project": "extremitypathfinder",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "extremitypathfinder"
}
        
Elapsed time: 0.28022s