Skip to content

Commit f5605ce

Browse files
authored
Merge pull request #254 from toruseo/develop
update README.md
2 parents f2f2edf + 07159a3 commit f5605ce

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
[![Static Badge](https://img.shields.io/badge/docs-%F0%9F%93%96-lightblue)](https://toruseo.jp/UXsim/docs/)
1212

1313
*UXsim* is a lightweight traffic flow simulator in pure Python.
14-
It enables users to model various traffic scenarios, from small toy networks to large metropolitan areas, without external dependencies.
15-
Especially ideal for academic research and educational use.
14+
You can model various traffic scenarios, from small toy networks to large metropolitan areas, by intuitive Python coding.
15+
Especially useful for academic research and educational use.
1616

1717
## Quick Start
1818
### Install
@@ -49,7 +49,7 @@ W.analyzer.network_fancy()
4949

5050
Traffic congestion caused by the bottleneck
5151

52-
![anim_network_fancy](https://github.com/user-attachments/assets/ab5e5fac-e2b3-4548-90ac-e4a5d7d302b0)
52+
<img src="https://github.com/toruseo/UXsim/blob/images/anim_network_fancy_simple.gif"/>
5353

5454
## Simulation Examples
5555

@@ -138,13 +138,13 @@ A [Jupyter Notebook of this example](https://github.com/toruseo/UXsim/blob/main/
138138

139139
## Main Features
140140

141-
- Lightweight, dependency-free, and fast mesoscopic simulation
142-
- Simulate large-scale traffic networks with 1 million vehicles in a minute
141+
- Lightweight, pure-Python, and fast mesoscopic simulation
142+
- Simulate large-scale traffic networks, such as metropolitan areas with 1 million vehicles in a minute
143143
- Based on theoretically valid models used in transportation research
144144
- Apply traffic control mechanisms such as signals, tolls, and shared mobility
145145
- Fully written in Python (core code ~1200 lines), easy to read and modify
146146
- Supports approximate solvers for Dynamic User Equilibrium and Dynamic System Optimum
147-
- Built-in analysis tool using `matplotlib` and `pandas`
147+
- Includes built-in analysis tools using `matplotlib` and `pandas`
148148

149149
## Further Reading
150150

@@ -176,6 +176,7 @@ When publishing works based on UXsim, please cite:
176176
url = {https://doi.org/10.21105/joss.07617},
177177
}
178178
```
179+
179180
Works using UXsim are summarized on the [Github Wiki page](https://github.com/toruseo/UXsim/wiki). Please feel free to edit.
180181

181182
## Contributing and Discussion

0 commit comments

Comments
 (0)