# <img src="docs/images/routeelogo.png" alt="Routee Compass" width="100"/>
<div align="left">
<img src="https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue"/>
<a href="https://anaconda.org/conda-forge/nrel.routee.compass">
<img src="https://img.shields.io/conda/v/conda-forge/nrel.routee.compass" alt="Conda Latest Release"/>
</a>
<a href="https://pypi.org/project/nrel.routee.compass/">
<img src="https://img.shields.io/pypi/v/nrel.routee.compass" alt="PyPi Latest Release"/>
</a>
<a href="https://crates.io/crates/routee-compass">
<img src="https://img.shields.io/crates/v/routee-compass" alt="Crates.io Latest Release"/>
</a>
</div>
RouteE Compass is an energy-aware routing engine for the RouteE ecosystem of software tools with the following key features:
- Dynamic and extensible search objectives that allow customized blends of distance, time, cost, and energy (via RouteE Powertrain) at query-time
- Core engine written in Rust for improved runtimes, parallel query execution, and the ability to load nation-sized road networks into memory
- Rust, HTTP, and Python APIs for integration into different research pipelines and other software
RouteE Compass is a part of the [RouteE](https://www.nrel.gov/transportation/route-energy-prediction-model.html) family of mobility tools created at the National Renewable Energy Laboratory and uses [RouteE Powertrain](https://github.com/NREL/routee-powertrain) to predict vehicle energy during the search.
## Installation
See the [installation](https://nrel.github.io/routee-compass/installation.html) guide for installing RouteE Compass
## Usage
See the [documentation](https://nrel.github.io/routee-compass/) for more information.
## Contributors
RouteE Compass is currently maintained by Nick Reinicke ([@nreinicke](https://github.com/nreinicke)) and Rob Fitzgerald ([@robfitzgerald](https://github.com/robfitzgerald)).
If you're interested in contributing, please checkout the [contributing](https://nrel.github.io/routee-compass/developers/contributing.html) guide.
## License
Copyright 2023 Alliance for Sustainable Energy, LLC
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://nrel.github.io/routee-compass",
"name": "nrel.routee.compass",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "eco routing",
"author": "National Renewable Energy Laboratory",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# <img src=\"docs/images/routeelogo.png\" alt=\"Routee Compass\" width=\"100\"/>\n\n<div align=\"left\">\n <img src=\"https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue\"/>\n <a href=\"https://anaconda.org/conda-forge/nrel.routee.compass\">\n <img src=\"https://img.shields.io/conda/v/conda-forge/nrel.routee.compass\" alt=\"Conda Latest Release\"/>\n </a>\n <a href=\"https://pypi.org/project/nrel.routee.compass/\">\n <img src=\"https://img.shields.io/pypi/v/nrel.routee.compass\" alt=\"PyPi Latest Release\"/>\n </a>\n <a href=\"https://crates.io/crates/routee-compass\">\n <img src=\"https://img.shields.io/crates/v/routee-compass\" alt=\"Crates.io Latest Release\"/>\n </a>\n</div>\n\nRouteE Compass is an energy-aware routing engine for the RouteE ecosystem of software tools with the following key features:\n\n- Dynamic and extensible search objectives that allow customized blends of distance, time, cost, and energy (via RouteE Powertrain) at query-time\n- Core engine written in Rust for improved runtimes, parallel query execution, and the ability to load nation-sized road networks into memory\n- Rust, HTTP, and Python APIs for integration into different research pipelines and other software\n\nRouteE Compass is a part of the [RouteE](https://www.nrel.gov/transportation/route-energy-prediction-model.html) family of mobility tools created at the National Renewable Energy Laboratory and uses [RouteE Powertrain](https://github.com/NREL/routee-powertrain) to predict vehicle energy during the search.\n\n## Installation\n\nSee the [installation](https://nrel.github.io/routee-compass/installation.html) guide for installing RouteE Compass\n\n## Usage\n\nSee the [documentation](https://nrel.github.io/routee-compass/) for more information.\n\n## Contributors\n\nRouteE Compass is currently maintained by Nick Reinicke ([@nreinicke](https://github.com/nreinicke)) and Rob Fitzgerald ([@robfitzgerald](https://github.com/robfitzgerald)).\n\nIf you're interested in contributing, please checkout the [contributing](https://nrel.github.io/routee-compass/developers/contributing.html) guide.\n\n## License\n\nCopyright 2023 Alliance for Sustainable Energy, LLC\n\nRedistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Alliance for Sustainable Energy, LLC",
"summary": "An eco-routing tool build upon RouteE-Powertrain",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/NREL/routee-compass"
},
"split_keywords": [
"eco",
"routing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "54cecb20ac3ac6ecdfbe0d4982266e1f2f8a4c5fe380022b0099141dc6bbab57",
"md5": "e7a485e0b45687c7cd11e759411f9773",
"sha256": "088743959586278e4b76441b386279867aa51d4d2b0a730c6d70b7c17bbcbfb9"
},
"downloads": -1,
"filename": "nrel.routee.compass-0.8.1-cp310-cp310-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"has_sig": false,
"md5_digest": "e7a485e0b45687c7cd11e759411f9773",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 14082063,
"upload_time": "2024-05-30T16:59:43",
"upload_time_iso_8601": "2024-05-30T16:59:43.041069Z",
"url": "https://files.pythonhosted.org/packages/54/ce/cb20ac3ac6ecdfbe0d4982266e1f2f8a4c5fe380022b0099141dc6bbab57/nrel.routee.compass-0.8.1-cp310-cp310-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6893b70fb49ef2ea335c438432092a16d239f485d2d8e38cd52328ea29afd295",
"md5": "7bd4b468e7c8220c891074a731765430",
"sha256": "1a6182f2ae6a53f27af1d13487d0d353603b3b6268e3c769e50a76da59b3bd39"
},
"downloads": -1,
"filename": "nrel.routee.compass-0.8.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "7bd4b468e7c8220c891074a731765430",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.9",
"size": 12114824,
"upload_time": "2024-05-30T16:59:45",
"upload_time_iso_8601": "2024-05-30T16:59:45.695367Z",
"url": "https://files.pythonhosted.org/packages/68/93/b70fb49ef2ea335c438432092a16d239f485d2d8e38cd52328ea29afd295/nrel.routee.compass-0.8.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-30 16:59:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NREL",
"github_project": "routee-compass",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nrel.routee.compass"
}
JSON
