Skip to content

Commit f8c1bdd

Browse files
committed
update README and docs for release
- remove format_type: column from demand_files in settings.yml and anywhere else in the documents; - remove its implementation from read_settings() in utils.py.
1 parent 20b7da4 commit f8c1bdd

File tree

13 files changed

+16
-26
lines changed

13 files changed

+16
-26
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Path4GMNS
22
[![platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-red)](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.9.4-brightgreen)](https://img.shields.io/badge/release-v0.8.2-brightgreen) ![Read the Docs](https://img.shields.io/readthedocs/path4gmns)
3+
[![Downloads](https://pepy.tech/badge/path4gmns)](https://pepy.tech/project/path4gmns) [![GitHub release](https://img.shields.io/badge/release-v0.9.5-brightgreen)](https://img.shields.io/badge/release-v0.8.2-brightgreen) ![Read the Docs](https://img.shields.io/readthedocs/path4gmns)
44

55
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,
66

@@ -19,16 +19,16 @@ Path4GMNS also serves as an API to the C++-based [DTALite](https://github.com/jd
1919
![Architecture](/docs/source/imgs/architecture.png)
2020

2121
## Installation
22-
Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.4/), and can be installed using
22+
Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.5/), and can be installed using
2323
```
2424
$ pip install path4gmns
2525
```
26-
If you need a specific version of Path4GMNS, say, 0.9.4,
26+
If you need a specific version of Path4GMNS, say, 0.9.5,
2727
```
28-
$ pip install path4gmns==0.9.4
28+
$ pip install path4gmns==0.9.5
2929
```
3030

31-
v0.9.4 fixes crucial bugs in the simulation module. Any versions prior to v0.9.4 will generate INCORRECT simulation results. Please **update to or install the latest version** and **discard all old versions**.
31+
v0.9.5 enhances v0.9.4 by taking any arbitrary node id's and zone id's from input files. Previous versions can only take integer values. Note that any versions prior to v0.9.4 will generate INCORRECT simulation results. Please **update to or install the latest version** and **discard all old versions**.
3232

3333
### Dependency
3434
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](https://path4gmns.readthedocs.io/en/latest/)**.
@@ -98,6 +98,8 @@ DTALite uses arrays rather than STL containers to store columns. These arrays ar
9898
43. Fix multiple bugs related to simulation including calculation of agent arrival time and agent waiting time, link traverse time, and link outflow cap (v0.9.4)
9999
44. Remove memory_blocks and its implementations (which were intended for multiprocessing) (v0.9.4)
100100
45. Bring back the postprocessing after UE in case users do not do column updating (i.e., column_update_num = 0) (v0.9.4)
101+
46. Drop the requirement that node id must be integer (v0.9.5)
102+
47. Drop the requirement that zone id must be integer (v0.9.5)
101103

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

@@ -111,7 +113,7 @@ You are encouraged to join our [Discord Channel](https://discord.gg/JGFMta7kxZ)
111113

112114
## How to Cite
113115

114-
Li, P. and Zhou, X. (2023, August 1). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
116+
Li, P. and Zhou, X. (2023, August 15). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
115117

116118
## References
117119
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.

data/ASU/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ demand_periods:
2222

2323
demand_files:
2424
- file_name: demand.csv
25-
format_type: column
2625
period: AM
2726
agent_type: a

data/Braess_Paradox/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ demand_periods:
2222

2323
demand_files:
2424
- file_name: demand.csv
25-
format_type: column
2625
period: AM
2726
agent_type: a

data/Chicago_Sketch/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ demand_periods:
2222

2323
demand_files:
2424
- file_name: demand.csv
25-
format_type: column
2625
period: AM
2726
agent_type: a

data/Lima_Network/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,5 @@ demand_periods:
1515

1616
demand_files:
1717
- file_name: demand.csv
18-
format_type: column
1918
period: AM
2019
agent_type: a

data/Sioux_Falls/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ demand_periods:
2222

2323
demand_files:
2424
- file_name: demand.csv
25-
format_type: column
2625
period: AM
2726
agent_type: a

data/Two_Corridor/settings.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ demand_periods:
2222

2323
demand_files:
2424
- file_name: demand.csv
25-
format_type: column
2625
period: AM
2726
agent_type: a

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
author = 'Dr. Peiheng Li and Dr. Xuesong (Simon) Zhou'
2727

2828
# The full version, including alpha/beta/rc tags
29-
release = 'v0.9.4'
29+
release = 'v0.9.5'
3030

3131

3232
# -- General configuration ---------------------------------------------------

docs/source/installation.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
Installation
33
============
44

5-
Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.4/>`_, and can be installed using
5+
Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.5/>`_, and can be installed using
66

77
.. code-block:: bash
88
99
$ pip install path4gmns
1010
11-
If you need a specific version of Path4GMNS, say, 0.9.4,
11+
If you need a specific version of Path4GMNS, say, 0.9.5,
1212

1313
.. code-block:: bash
1414
15-
$ pip install path4gmns==0.9.4
15+
$ pip install path4gmns==0.9.5
1616
1717
1818
Dependency
@@ -55,7 +55,7 @@ As CMAKE_BUILD_TYPE will be IGNORED for IDE (Integrated Development Environment)
5555
# from the root directory of PATH4GMNS
5656
$ python setup.py sdist bdist_wheel
5757
$ cd dist
58-
# or python -m pip install path4gmns-0.9.4.tar.gz
59-
$ python -m pip instal pypath4gmns-0.9.4-py3-none-any.whl
58+
# or python -m pip install path4gmns-0.9.5.tar.gz
59+
$ python -m pip instal pypath4gmns-0.9.5-py3-none-any.whl
6060
61-
Here, 0.9.4 is the version number. Replace it with the one specified in setup.py.
61+
Here, 0.9.5 is the version number. Replace it with the one specified in setup.py.

docs/source/usecases.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ The OpenMP run-time library must be installed to utilize the built-in parallel c
221221

222222
***Windows Users***
223223

224-
Download [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#microsoft-visual-c-redistributable-for-visual-studio-2019) and check [here](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for more information and earlier versions.
224+
Download and install [Microsoft Visual C++ Redistributable for Visual Studio](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0).
225225

226226
***Linux Users***
227227

@@ -264,7 +264,6 @@ demand_periods:
264264

265265
demand_files:
266266
- file_name: demand.csv
267-
format_type: column
268267
period: AM
269268
agent_type: a
270269
```
@@ -433,7 +432,6 @@ demand_periods:
433432

434433
demand_files:
435434
- file_name: demand.csv
436-
format_type: column
437435
period: AM
438436
agent_type: a
439437

0 commit comments

Comments
 (0)