Merge branch 'release/0.2.0'

CITATION.cff

@@ -7,12 +7,12 @@ authors:
   - family-names: "Koutsopoulos"
     given-names: "Haris N."
     orcid: "https://orcid.org/0000-0003-3830-9794"
-title: "RailSim: A Modern Rail Transit Simulation Platform"
+title: "TransitLab SimMETRO: A Modern Rail Transit Simulation Platform"
 version: 0.1.0
 doi: 10.5281/zenodo.13111727
 date-released: 2024-06-01
-url: "https://myousefi.github.io/rail-sim-docs/"
-repository-code: "https://github.com/myousefi/rail-sim-docs"
+url: "https://myousefi.github.io/transit-lab-SimMETRO-docs/"
+repository-code: "https://github.com/myousefi/transit-lab-SimMETRO-docs"
 keywords:
   - research
   - software
@@ -28,7 +28,7 @@ keywords:
   - moving-block
   - design pattern
 abstract: >
-  RailSim is an urban heavy-rail operations simulation model developed at the MIT Transit Lab, built upon decades of research. This repository contains a comprehensive documentation. While the full package may not be open-sourced soon, the documentation provides valuable insights into the capabilities of the simulation model.
+  TransitLab SimMETRO is an urban heavy-rail operations simulation model developed at the MIT Transit Lab, built upon decades of research. This repository contains a comprehensive documentation. While the full package may not be open-sourced soon, the documentation provides valuable insights into the capabilities of the simulation model.
 references:
   - type: article
     authors:

README.md

@@ -1,14 +1,14 @@
 **WARNING** This documentation is currently under active development. The content and structure may change as the project evolves. Please check back regularly for updates and improvements.
 
-# RailSim Documentation
+# TransitLab SimMETRO Documentation
 
-Welcome to the RailSim documentation! While the full package isn't open-source right now, this documentation is a great way to learn about the capabilities of the rail simulation tool. Built on decades of research at (MIT Transit Lab)[https://www.transitlab.mit.edu/], RailSim enables you to simulate operations of an urban rapid transit metro line operations under Fixed-block or Moving-block signal system, integrating real-time control strategies, and finally analyzing the performance of the system from operator's or passenger's perspective.
+Welcome to the TransitLab SimMETRO documentation! While the full package isn't open-source right now, this documentation is a great way to learn about the capabilities of the rail simulation tool. Built on decades of research at (MIT Transit Lab)[https://www.transitlab.mit.edu/], TransitLab SimMETRO enables you to simulate operations of an urban rapid transit metro line operations under Fixed-block or Moving-block signal system, integrating real-time control strategies, and finally analyzing the performance of the system from operator's or passenger's perspective.
 
-Whether you're a transportation professional, academic researcher, or just a rail enthusiast, this documentation will help you understand how RailSim works and what it can do. Check out the guides, dive into the architecture reference, and start exploring how RailSim could help with your own projects or research.
+Whether you're a transportation professional, academic researcher, or just a rail enthusiast, this documentation will help you understand how TransitLab SimMETRO works and what it can do. Check out the guides, dive into the architecture reference, and start exploring how TransitLab SimMETRO could help with your own projects or research.
 
 ## Key Documentation Files
 
-The complete documentation is available as a PDF file: [RailSim Documentation](_build/latex/railsim.pdf).
+The complete documentation is available as a PDF file: [TransitLab SimMETRO Documentation](_build/latex/railsim.pdf).
 
 An online version is also available through Github Pages at [myousefi.github.io/rail-sim-docs/](https://myousefi.github.io/rail-sim-docs/).
 
@@ -18,7 +18,7 @@ For further information and resources, refer to the appendix. It contains a glos
 
 If you have any questions or need assistance, please reach out to Mojtaba Yousefi at [[email protected]](mailto:[email protected]).
 
-Happy learning with RailSim!
+Happy learning with TransitLab SimMETRO!
 
 ## Citation
 
@@ -27,15 +27,15 @@ If you use this software in your research, please cite it as:
 ### APA Format
 
 ```
-Yousefi, M., & Koutsopoulos, H. N. (2024). RailSim: A Modern Rail Transit Simulation Platform (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.13111727
+Yousefi, M., & Koutsopoulos, H. N. (2024). TransitLab SimMETRO: A Modern Rail Transit Simulation Platform (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.13111727
 ```
 
 ### BibTeX Format
 
 ```
-@software{Yousefi_RailSim_2024,
+@software{Yousefi_TransitLab SimMETRO_2024,
 author = {Yousefi, Mojtaba and Koutsopoulos, Haris N.},
-title = {{RailSim: A Modern Rail Transit Simulation Platform}},
+title = {{TransitLab SimMETRO: A Modern Rail Transit Simulation Platform}},
 version = {0.1.0},
 date = {2024-06-01},
 doi = {10.5281/zenodo.13111727},
@@ -46,17 +46,17 @@ url = {https://myousefi.github.io/rail-sim-docs/}
 ### Chicago Style
 
 ```
-Yousefi, Mojtaba, and Haris N. Koutsopoulos. 2024. RailSim: A Modern Rail Transit Simulation Platform. Version 0.1.0. https://doi.org/10.5281/zenodo.13111727.
+Yousefi, Mojtaba, and Haris N. Koutsopoulos. 2024. TransitLab SimMETRO: A Modern Rail Transit Simulation Platform. Version 0.1.0. https://doi.org/10.5281/zenodo.13111727.
 ```
 
 ### MLA Format
 
 ```
-Yousefi, Mojtaba, and Haris N. Koutsopoulos. RailSim: A Modern Rail Transit Simulation Platform. Version 0.1.0, 2024, https://doi.org/10.5281/zenodo.13111727.
+Yousefi, Mojtaba, and Haris N. Koutsopoulos. TransitLab SimMETRO: A Modern Rail Transit Simulation Platform. Version 0.1.0, 2024, https://doi.org/10.5281/zenodo.13111727.
 ```
 
 ### IEEE Format
 
 ```
-M. Yousefi and H. N. Koutsopoulos, "RailSim: A Modern Rail Transit Simulation Platform," version 0.1.0, Jun. 2024. [Online]. Available: https://doi.org/10.5281/zenodo.13111727.
+M. Yousefi and H. N. Koutsopoulos, "TransitLab SimMETRO: A Modern Rail Transit Simulation Platform," version 0.1.0, Jun. 2024. [Online]. Available: https://doi.org/10.5281/zenodo.13111727.
 ```

conf.py

@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "RailSim"
+project = "TransitLab SimMETRO"
 copyright = "2024, Transit Mobility Lab"
 author = "Mojtaba Yousefi"
 

index.rst

@@ -1,9 +1,9 @@
-.. RailSim documentation master file, created by
+.. TransitLab SimMETRO documentation master file, created by
    sphinx-quickstart on Mon Apr 15 23:02:58 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to RailSim's documentation!
+Welcome to TransitLab SimMETRO's documentation!
 =======================================
 
 .. toctree::

introduction.rst

@@ -3,11 +3,11 @@ Introduction
 
 Project Overview
 ----------------
-RailSim is a sophisticated simulation tool developed upon decades of research (:cite:t:`koutsopoulos2007simulation` and :cite:t:`zhou2022urban`) and development to address the operational challenges faced by heavy rail systems in major metropolitan areas, particularly during peak periods when demand is highest. This tool provide microscopic simulation model for heavy rail systems, enabling detailed analysis of train behaviors, signaling systems (fixed-block and moving block), and interactions between trains and passengers. By employing RailSim, reseachers can evaluate various operating strategies such as skip-stop, station consolidation, and dwell control to mitigate capacity bottlenecks. 
+TransitLab SimMETRO is a sophisticated simulation tool developed upon decades of research (:cite:t:`koutsopoulos2007simulation` and :cite:t:`zhou2022urban`) and development to address the operational challenges faced by heavy rail systems in major metropolitan areas, particularly during peak periods when demand is highest. This tool provide microscopic simulation model for heavy rail systems, enabling detailed analysis of train behaviors, signaling systems (fixed-block and moving block), and interactions between trains and passengers. By employing TransitLab SimMETRO, reseachers can evaluate various operating strategies such as skip-stop, station consolidation, and dwell control to mitigate capacity bottlenecks. 
 
 The simulation framework is built using Python in a unix environment, ensuring robust performance and flexibility. The model's accuracy and reliability can be further enhanced through a calibration process using data from Operational Control Systems :cite:p:`wang2011calibration`. Numerous visualization tools allow users to analyze simulation outputs.
 
-Numerous case studies (see :cite:t:`zhou2020evaluation` and :cite:t:`zhou2022schedule`) demonstrate how MIT RailSim has helped agencies address congestion, improve service reliability, and support long-term planning decisions.
+Numerous case studies (see :cite:t:`zhou2020evaluation` and :cite:t:`zhou2022schedule`) demonstrate how MIT TransitLab SimMETRO has helped agencies address congestion, improve service reliability, and support long-term planning decisions.
 
 Features
 --------