Skip to content

Commit 001f2fe

Browse files
committed
update README for release
1 parent b5a204b commit 001f2fe

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Path4GMNS
22
[![platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-red)]()
3-
[![Downloads](https://pepy.tech/badge/path4gmns)](https://pepy.tech/project/path4gmns) [![GitHub release](https://img.shields.io/badge/release-v0.8.1-brightgreen)](https://img.shields.io/badge/release-v0.8.1-brightgreen)
4-
3+
[![Downloads](https://pepy.tech/badge/path4gmns)]() [![GitHub release](https://img.shields.io/badge/release-v0.8.2-brightgreen)]()
54

65
Path4GMNS is an open-source, cross-platform, lightweight, and fast Python path engine for networks encoded in [GMNS](https://github.com/zephyr-data-specs/GMNS). Besides finding static shortest paths for simple analyses, its main functionality is to provide an efficient and flexible framework for column-based (path-based) modeling and applications in transportation (e.g., activity-based demand modeling). Path4GMNS supports, in short,
76

@@ -17,16 +16,16 @@ Path4GMNS also serves as an API to the C++-based [DTALite](https://github.com/jd
1716
* Origin-Destination Matrix Estimation (ODME).
1817

1918
## Installation
20-
Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.8.1/), and can be installed using
19+
Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.8.2/), and can be installed using
2120
```
2221
$ pip install path4gmns
2322
```
24-
If you need a specific version of Path4GMNS, say, 0.8.1,
23+
If you need a specific version of Path4GMNS, say, 0.8.2,
2524
```
26-
$ pip install path4gmns==0.8.1
25+
$ pip install path4gmns==0.8.2
2726
```
2827

29-
v0.8.1 comes with performance improvement. All previous releases shall be deprecated for any purposes.
28+
v0.8.2 comes with major performance improvement in column generation module. All previous releases shall be **deprecated**.
3029

3130
### Dependency
3231
The Python modules are written in **Python 3.x**, which is the minimum requirement to explore the most of Path4GMNS. Some of its functions require further run-time support, which we will go through along with the corresponding use cases in the following section.
@@ -395,11 +394,11 @@ As **CMAKE_BUILD_TYPE** will be **IGNORED** for IDE (Integrated Development Envi
395394
# from the root directory of PATH4GMNS
396395
$ python setup.py sdist bdist_wheel
397396
$ cd dist
398-
# or python -m pip instal pypath4gmns-0.8.1-py3-none-any.whl
399-
$ python -m pip install path4gmns-0.8.1.tar.gz
397+
# or python -m pip instal pypath4gmns-0.8.2-py3-none-any.whl
398+
$ python -m pip install path4gmns-0.8.2.tar.gz
400399
```
401400

402-
Here, 0.8.1 is the version number. Replace it with the one specified in setup.py.
401+
Here, 0.8.2 is the version number. Replace it with the one specified in setup.py.
403402

404403
## Implementation Notes
405404

@@ -432,10 +431,10 @@ DTALite uses arrays rather than STL containers to store columns. These arrays ar
432431
13. Fix crucial bug in accessibility evaluation (v0.7.5)
433432
14. Deprecate node_sum as hash index in column generation (v0.8.0)
434433
15. Optimize class ColumnVec, setup_agents() in class Network, and column generation module (i.e., colgen.py) (v0.8.1)
434+
16. Deep code optimization in column generation module with significant performance improvement (v0.8.2)
435435

436436
Detailed update information can be found in [Releases](https://github.com/jdlph/Path4GMNS/releases).
437437

438-
439438
## Contribute
440439

441440
Any contributions are welcomed including advise new applications of Path4GMNS, enhance documentation (this guideline and [docstrings](https://docs.python-guide.org/writing/documentation/#writing-docstrings) in the source code), refactor and/or optimize the source code, report and/or resolve potential issues/bugs, suggest and/or add new functionalities, etc.
@@ -446,7 +445,7 @@ You are encouraged to join our Slack workspace for more discussions and collabor
446445

447446
## How to Cite
448447

449-
Li, P. and Zhou, X. (2022, April 9). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
448+
Li, P. and Zhou, X. (2022, April 30). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
450449

451450
## References
452451
Lu, C. C., Mahmassani, H. S., Zhou, X. (2009). Equivalent gap function-based reformulation and solution algorithm for the dynamic user equilibrium problem. Transportation Research Part B: Methodological, 43, 345-364.

0 commit comments

Comments
 (0)