ireiat


Nameireiat JSON
Version 0.0.2rc0 PyPI version JSON
download
home_pageNone
SummaryIntermodal Routing and Environmental Impact Analysis Tool
upload_time2024-10-17 13:10:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseCopyright 2023 Oliver Wyman, Inc. 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.
keywords intermodal algorithm b ireiat transportation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # README

![Python](https://img.shields.io/badge/python-3.11-blue.svg)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Documentation Status](https://readthedocs.org/projects/ireiat/badge/?version=latest)](https://ireiat.readthedocs.io/en/latest/?badge=latest)

# Purpose

The Intermodal Routing and Environmental Impact Analysis Tool (IREIAT) is meant to enable its target user group,
infrastructure planners, to understand:
1. Expected flows on the US intermodal freight network given demand,
   intermodal costs (both direct financial and other costs), and network capacities
2. How cost, transit time, disruptions/resilience, and GHG emissions affect freight flows across the current and
   future intermodal network

# Quick start

The tool is meant to be a Python-based command line tool, so you should ensure
that you have Python 3.11 installed on your machine, which
can be downloaded [here](https://www.python.org/downloads/release/python-3117/).

Additionally, you need to download R and install:
* cppRouting
* igraph
* arrow

Once you have Python and R installed you should be able to install the package
with `pip install ireiat`. After which, you can just run `ireiat` from a command-line!

Run `ireiat --help` for CLI options or see the [full documentation](https://ireiat.readthedocs.io/en/latest/).

# Contributing

Please see [how to contribute](CONTRIBUTING.md)

# Acknowledgement

The information, data, or work presented herein was funded in part by the Advanced Research Projects Agency-Energy
(ARPA-E), U.S. Department of Energy, under Award Number DE-AR0001784. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ireiat",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "intermodal, algorithm b, ireiat, transportation",
    "author": null,
    "author_email": "Nick Padon <nicholas.padon@oliverwyman.com>, Marc Meketon <marc.meketon@oliverwyman.com>",
    "download_url": "https://files.pythonhosted.org/packages/b0/ab/028eb24a4ab834e504d0b15f1d820f124bd75c13ecfb7732cc9dd7c8dc10/ireiat-0.0.2rc0.tar.gz",
    "platform": null,
    "description": "# README\r\n\r\n![Python](https://img.shields.io/badge/python-3.11-blue.svg)\r\n[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\r\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\r\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\r\n[![Documentation Status](https://readthedocs.org/projects/ireiat/badge/?version=latest)](https://ireiat.readthedocs.io/en/latest/?badge=latest)\r\n\r\n# Purpose\r\n\r\nThe Intermodal Routing and Environmental Impact Analysis Tool (IREIAT) is meant to enable its target user group,\r\ninfrastructure planners, to understand:\r\n1. Expected flows on the US intermodal freight network given demand,\r\n   intermodal costs (both direct financial and other costs), and network capacities\r\n2. How cost, transit time, disruptions/resilience, and GHG emissions affect freight flows across the current and\r\n   future intermodal network\r\n\r\n# Quick start\r\n\r\nThe tool is meant to be a Python-based command line tool, so you should ensure\r\nthat you have Python 3.11 installed on your machine, which\r\ncan be downloaded [here](https://www.python.org/downloads/release/python-3117/).\r\n\r\nAdditionally, you need to download R and install:\r\n* cppRouting\r\n* igraph\r\n* arrow\r\n\r\nOnce you have Python and R installed you should be able to install the package\r\nwith `pip install ireiat`. After which, you can just run `ireiat` from a command-line!\r\n\r\nRun `ireiat --help` for CLI options or see the [full documentation](https://ireiat.readthedocs.io/en/latest/).\r\n\r\n# Contributing\r\n\r\nPlease see [how to contribute](CONTRIBUTING.md)\r\n\r\n# Acknowledgement\r\n\r\nThe information, data, or work presented herein was funded in part by the Advanced Research Projects Agency-Energy\r\n(ARPA-E), U.S. Department of Energy, under Award Number DE-AR0001784. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.\r\n",
    "bugtrack_url": null,
    "license": "Copyright 2023 Oliver Wyman, Inc.  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 \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. ",
    "summary": "Intermodal Routing and Environmental Impact Analysis Tool",
    "version": "0.0.2rc0",
    "project_urls": {
        "Source": "https://github.com/owg-digital/ireiat"
    },
    "split_keywords": [
        "intermodal",
        " algorithm b",
        " ireiat",
        " transportation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a27c1a1384a1e4ea26118a41200f90aa1f3eea3faf8feecda814ccd0974bf5d7",
                "md5": "8939bfcc06d996b731d7b7a0f0f01854",
                "sha256": "35587c3ea9e78837b3e890c287716902b79c10a5e71327557236cf51d44fdba9"
            },
            "downloads": -1,
            "filename": "ireiat-0.0.2rc0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8939bfcc06d996b731d7b7a0f0f01854",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 51296,
            "upload_time": "2024-10-17T13:10:02",
            "upload_time_iso_8601": "2024-10-17T13:10:02.604725Z",
            "url": "https://files.pythonhosted.org/packages/a2/7c/1a1384a1e4ea26118a41200f90aa1f3eea3faf8feecda814ccd0974bf5d7/ireiat-0.0.2rc0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b0ab028eb24a4ab834e504d0b15f1d820f124bd75c13ecfb7732cc9dd7c8dc10",
                "md5": "e6d778fac6cb60c67d78423fbfe3829b",
                "sha256": "2832682644191a24db4b1ba2b1cc1a7d1fb1686cdad8e00c9bd2993f8c9f9d07"
            },
            "downloads": -1,
            "filename": "ireiat-0.0.2rc0.tar.gz",
            "has_sig": false,
            "md5_digest": "e6d778fac6cb60c67d78423fbfe3829b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 38353,
            "upload_time": "2024-10-17T13:10:04",
            "upload_time_iso_8601": "2024-10-17T13:10:04.064117Z",
            "url": "https://files.pythonhosted.org/packages/b0/ab/028eb24a4ab834e504d0b15f1d820f124bd75c13ecfb7732cc9dd7c8dc10/ireiat-0.0.2rc0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-17 13:10:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "owg-digital",
    "github_project": "ireiat",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ireiat"
}
        
Elapsed time: 1.61159s