Skip to content

Commit 9cab4d4

Browse files
committed
update README with the minimum info
1 parent c71c100 commit 9cab4d4

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# TAPLite
2+
3+
TAPLite is a lightweight traffic assignment and simulation engine for networks encoded in GMNS.
4+
5+
## Quick Start
6+
7+
### Installation
8+
```
9+
pip install taplite
10+
```
11+
12+
### Traffic Assignment
13+
14+
#### One-Time Call
15+
```
16+
import taplite as tap
17+
18+
tap.assignment()
19+
```
20+
21+
#### Recursive Call
22+
```
23+
import taplite as tap
24+
from multiprocessing import freeze_support
25+
26+
if __name__ == '__main__':
27+
freeze_support()
28+
29+
while True:
30+
tap.assignment()
31+
```
32+
33+
### Traffic Simulation
34+
35+
Note that assignment() must be invoked in the same code block prior to simulation().
36+
```
37+
import taplite as tap
38+
39+
tap.assignment()
40+
tap.simulation()
41+
```
42+
## Build TAPLite from Scratch
43+
44+
**1. Build the C++ Shared Library**
45+
46+
```
47+
# from the root directory of TAPLite
48+
cmake -S . -B build -DBUILD_EXE=OFF
49+
cmake --build build
50+
```
51+
**2. Build and Install the Python Package**
52+
```
53+
# from the root directory of TAPLite
54+
python -m pip install .
55+
```

0 commit comments

Comments
 (0)