owg-digital / ireiat

Intermodal optimization

Home Page:https://ireiat.readthedocs.io/en/latest/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

Python License pre-commit Code style: black Documentation Status

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.

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.

Contributing

Please see how to contribute

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.

About

Intermodal optimization

https://ireiat.readthedocs.io/en/latest/

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Jupyter Notebook 99.4%Language:Python 0.5%Language:R 0.0%