.. IREIAT documentation master file, created by
   sphinx-quickstart on Mon Jan 22 15:08:54 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to IREIAT's documentation!
==================================

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


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   cli/commands
   demand/faf
   network/index


**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.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`