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.
jdlph · Aug 16, 2023 · f8c1bdd · f8c1bdd
1 parent 20b7da4
commit f8c1bdd
Show file tree

Hide file tree

Showing 13 changed files with 16 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Path4GMNS
 [![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)
- [![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)
+ [![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)
 
 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,
 
@@ -19,16 +19,16 @@ Path4GMNS also serves as an API to the C++-based [DTALite](https://github.com/jd
 ![Architecture](/docs/source/imgs/architecture.png)
 
 ## Installation
-Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.4/), and can be installed using
+Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.5/), and can be installed using
 ```
 $ pip install path4gmns
 ```
-If you need a specific version of Path4GMNS, say, 0.9.4,
+If you need a specific version of Path4GMNS, say, 0.9.5,
 ```
-$ pip install path4gmns==0.9.4
+$ pip install path4gmns==0.9.5
 ```
 
-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**.
+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**.
 
 ### Dependency
 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
 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)
 44. Remove memory_blocks and its implementations (which were intended for multiprocessing) (v0.9.4)
 45. Bring back the postprocessing after UE in case users do not do column updating (i.e., column_update_num = 0) (v0.9.4)
+46. Drop the requirement that node id must be integer (v0.9.5)
+47. Drop the requirement that zone id must be integer (v0.9.5)
 
 Detailed update information can be found in [Releases](https://github.com/jdlph/Path4GMNS/releases).
 
@@ -111,7 +113,7 @@ You are encouraged to join our [Discord Channel](https://discord.gg/JGFMta7kxZ)
 
 ## How to Cite
 
-Li, P. and Zhou, X. (2023, August 1). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
+Li, P. and Zhou, X. (2023, August 15). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
 
 ## References
 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.

diff --git a/data/ASU/settings.yml b/data/ASU/settings.yml
@@ -22,6 +22,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/data/Braess_Paradox/settings.yml b/data/Braess_Paradox/settings.yml
@@ -22,6 +22,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/data/Chicago_Sketch/settings.yml b/data/Chicago_Sketch/settings.yml
@@ -22,6 +22,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/data/Lima_Network/settings.yml b/data/Lima_Network/settings.yml
@@ -15,6 +15,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/data/Sioux_Falls/settings.yml b/data/Sioux_Falls/settings.yml
@@ -22,6 +22,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/data/Two_Corridor/settings.yml b/data/Two_Corridor/settings.yml
@@ -22,6 +22,5 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,7 +26,7 @@
 author = 'Dr. Peiheng Li and Dr. Xuesong (Simon) Zhou'
 
 # The full version, including alpha/beta/rc tags
-release = 'v0.9.4'
+release = 'v0.9.5'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -2,17 +2,17 @@
 Installation
 ============
 
-Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.4/>`_, and can be installed using
+Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.5/>`_, and can be installed using
 
 .. code-block:: bash
 
     $ pip install path4gmns
 
-If you need a specific version of Path4GMNS, say, 0.9.4,
+If you need a specific version of Path4GMNS, say, 0.9.5,
 
 .. code-block:: bash
 
-    $ pip install path4gmns==0.9.4
+    $ pip install path4gmns==0.9.5
 
 
 Dependency
@@ -55,7 +55,7 @@ As CMAKE_BUILD_TYPE will be IGNORED for IDE (Integrated Development Environment)
     # from the root directory of PATH4GMNS
     $ python setup.py sdist bdist_wheel
     $ cd dist
-    # or python -m pip install path4gmns-0.9.4.tar.gz
-    $ python -m pip instal pypath4gmns-0.9.4-py3-none-any.whl
+    # or python -m pip install path4gmns-0.9.5.tar.gz
+    $ python -m pip instal pypath4gmns-0.9.5-py3-none-any.whl
 
-Here, 0.9.4 is the version number. Replace it with the one specified in setup.py.
+Here, 0.9.5 is the version number. Replace it with the one specified in setup.py.
diff --git a/docs/source/usecases.md b/docs/source/usecases.md
@@ -221,7 +221,7 @@ The OpenMP run-time library must be installed to utilize the built-in parallel c
 
 ***Windows Users***
 
-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.
+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).
 
 ***Linux Users***
 
@@ -264,7 +264,6 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
 ```
@@ -433,7 +432,6 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
 

diff --git a/path4gmns/utils.py b/path4gmns/utils.py
@@ -828,7 +828,6 @@ def read_settings(input_dir, assignment):
             demands = settings['demand_files']
             for i, d in enumerate(demands):
                 demand_file = d['file_name']
-                # demand_format_type = d['format_type']
                 demand_period = d['period']
                 demand_type = d['agent_type']
 

diff --git a/tests/settings.yml b/tests/settings.yml
@@ -34,7 +34,6 @@ demand_periods:
 
 demand_files:
   - file_name: demand.csv
-    format_type: column
     period: AM
     agent_type: a
 

diff --git a/tests/tutorial.ipynb b/tests/tutorial.ipynb
@@ -379,7 +379,6 @@
     "\n",
     "demand_files:\n",
     "  - file_name: demand.csv\n",
-    "    format_type: column\n",
     "    period: AM\n",
     "    agent_type: a\n",
     "```\n",
@@ -714,7 +713,6 @@
     "\n",
     "demand_files:\n",
     "  - file_name: demand.csv\n",
-    "    format_type: column\n",
     "    period: AM\n",
     "    agent_type: a\n",
     "\n",