NeTrainSim [Network Trains Simulator]

GitHub All Releases

Download NeTrainSim | How to Install and Quick Overview | Documentation | Slack

Network Train Simulator (NeTrainSim)

NeTrainSim is an open-source train simulation software that allows users to simulate and analyse train operations on a large rail network. It is designed to be flexible, modular, and easy to use. It is built using Qt6 under the GNU General Public License (GPL) version 3.

How to Cite

@inproceedings{aredah2023netrainsim,
  title={NeTrainSim: A Network Freight Train Simulator for Estimating Energy/Fuel Consumption},
  author={Aredah, Ahmed and Fadhloun, Karim and Rakha, Hesham and List, George},
  booktitle={102nd Transportation Research Board Annual Meeting},
  year={2023}
}

Features

Accessible and affordable: NeTrainSim is freely accessible to anyone with internet and laptop access, without the need for costly commercial licenses.
Open-source development: NeTrainSim is an open-source project, allowing researchers to modify the code and collaborate easily.
Advanced network modeling: NeTrainSim can model entire rail networks, including country-scale simulations.
Versatile and adaptable: NeTrainSim can be adapted to various rail network types and configurations, providing flexibility in simulations.
Energy-efficient: NeTrainSim's Energy Consumption module supports a wide range of train technologies, accommodating future advancements.
Second-by-second data tracking: NeTrainSim provides detailed data, including energy consumption, on a second-by-second basis for each train.
Advanced train dynamics: NeTrainSim uses advanced train dynamics models, including operator aggressiveness, for accurate energy consumption representation.
Energy optimization: NeTrainSim includes an energy optimization module for optimizing individual or grouped trains (under development).

main NeTrainSim window

Getting Started

To get started with NeTrainSim, you will need to download and install the software on your computer. You can do this by downloading the latest release version on the releases page.

Prerequisites

There is no prerequisite required to run NeTrainSim as the installer has all the required 3rd party packages.

Installing

Once the file is downloaded on your hard drive. Double click the downloaded file and follow the instruction to install the application. The default installation folder is C:\Program Files\NeTrainSim; however, you can alter this installation path as you wish during the installation process.

Follow this video if you need a quick installation guidance: https://youtu.be/bbvnPn9zMsQ

Running

Using GUI interface

Please initiate the 'NeTrainSimGUI' application, which can be located either in the Windows Start menu or on your desktop.
Presented below is the primary user interface for the NeTrainSim application.

main NeTrainSim window

For a comprehensive understanding of the application and its functionalities, please refer to the relevant documentation available within the 'Help' section of the menu.

Using shell interface

Open a shell/command line window,
Navigate to the installation path using
```
cd "C:\Program Files\NeTrainSim"
```
if you changed the default installation path, make sure to replace C:\Program Files\NeTrainSim with your installation path.
To request help from NeTrainSim, type the following in the shell
```
NeTrainSim -h
```

NeTrainSim allows the following command flags. Flags with required values are necessary to run the simulator.

-h, --help, -?                          Display this help message.
-v, --version                           Displays version information.
-n, --nodes <nodesFile>                 [Required] the nodes filename.
-l, --links <linksFile>                 [Required] the links filename.
-t, --trains <trainsFile>               [Required] the trains filename.
-o, --output <outputLocation>           [Optional] the output folder address.
                                      Default is
                                      'C:\Users\<USERNAME>\Documents\NeTrain
                                      Sim\'.
-s, --summary <summaryFilename>         [Optional] the summary filename.
                                      Default is
                                      'trainSummary_timeStamp.txt'.
-a, --all <summarizeAllTrains>          [Optional] bool to show summary of
                                      all trains in the summary file.
                                      Default is 'false'.
-e, --export <exportTrajectoryOptions>  [Optional] bool to export
                                      instantaneous trajectory.
                                      Default is 'false'.
-i, --insta <instaTrajectoryFile>       [Optional] the instantaneous
                                      trajectory filename.
                                      Default is
                                      'trainTrajectory_timeStamp.csv'.
-p, --timeStep <simulatorTimeStep>      [Optional] the simulator time step.
                                      Default is '1.0'.

Example of a minimum-flag command

NeTrainSim.exe -n "path\to\nodes\file" -l "path\to\links\file" -t "path\to\trains\file"

In this case, the default output Location is C:\Users\<USERNAME>\Documents\NeTrainSim where <USERNAME> should be replaced with the current session user name.

Collaborators

The development of NeTrainSim has been a collaborative effort. The following individuals have contributed to the development and maintenance of the simulator:

Ahmed Aredah, M.Sc.:
- Ph.D. student, Dept. of Civil and Environmental Engineering, Virginia Tech
- M.Sc. Student, Dept. of Computer Science | Engineering, Virginia Tech
- Graduate Research Assistant at Virginia Tech Transportation Institute
Karim Fadhloun, Ph.D.:
- Research Associate at Virginia Tech Transportation Institute
Hesham A. Rakha, Ph.D. P.Eng., F.IEEE:
- Samuel Reynolds Pritchard Professor of Engineering, Charles E. Via, Jr. Dept. of Civil and Environmental Engineering
- Courtesy Professor, Bradley Department of Electrical and Computer Engineering
- Director, Center for Sustainable Mobility at the Virginia Tech Transportation Institute
- Fellow of Asia Pacific Artificial Intelligence Association
- Fellow of the American Society of Civil Engineers
- Fellow of the Canadian Academy of Engineering
- Fellow of IEEE

Contributors

Contributing

If you are interested in contributing to NeTrainSim, please read the CONTRIBUTING.md file for more information on how to get started.

License

This program is distributed under the terms of the GNU General Public License (GPL) version 3. Please see the LICENSE file for more information.

Publications

Aredah, A.S., Fadhloun, K. & Rakha, H.A. (2024) NeTrainSim: a network-level simulator for modeling freight train longitudinal motion and energy consumption. Railw. Eng. Sci. https://doi.org/10.1007/s40534-024-00331-x

Aredah, A., Fadhloun, K., & Rakha, H. A. (2024). Energy optimization in freight train operations: Algorithmic development and testing. Applied Energy, 364, 123111. https://doi.org/10.1016/j.apenergy.2024.123111

Aredah, A., Du, J., Hegazi, M., List, G., & Rakha, H. A. (2024). Comparative analysis of alternative powertrain technologies in freight trains: A numerical examination towards sustainable rail transport. Applied Energy, 356, 122411. https://doi.org/10.1016/j.apenergy.2023.122411

VTTI-CSM / NeTrainSim

readme