update docs for release

Author: jdlph

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://static.pepy.tech/badge/path4gmns)](https://pepy.tech/project/path4gmns) [![GitHub release](https://img.shields.io/badge/release-v0.9.9-brightgreen)](https://img.shields.io/badge/release-v0.8.2-brightgreen) ![Read the Docs](https://img.shields.io/readthedocs/path4gmns)
+[![Downloads](https://static.pepy.tech/badge/path4gmns)](https://pepy.tech/project/path4gmns) [![GitHub release](https://img.shields.io/badge/release-v0.9.9.post1-brightgreen)](https://img.shields.io/badge/release-v0.8.2-brightgreen) ![Read the Docs](https://img.shields.io/readthedocs/path4gmns)
 [![](https://dcbadge.vercel.app/api/server/JGFMta7kxZ?style=flast)](https://discord.gg/JGFMta7kxZ)
 
 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,
@@ -29,16 +29,16 @@ Path4GMNS also serves as an API to the C++-based [DTALite](https://github.com/jd
 We highly recommend that you go through the above [Tutorial](https://github.com/jdlph/Path4GMNS/blob/master/tutorial/tutorial.ipynb), no matter you are one of the existing users or new to Path4GMNS.
 
 ## Installation
-Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.9/), and can be installed using
+Path4GMNS has been published on [PyPI](https://pypi.org/project/path4gmns/0.9.9.post1/), and can be installed using
 ```
 $ pip install path4gmns
 ```
 
 > [!IMPORTANT]
-v0.9.9 comes with bug fixes, new functionality, and performance improvement. Please **discard all old versions**.
+v0.9.9.post1 serves as a hotfix over v0.9.9. It reestablishes zone id cross-validation (between node.csv and demand.csv) and resolves network inconsistency by invoking find_shortest_path() and find_ue() in the same code snippet (see [Issue #51](https://github.com/jdlph/Path4GMNS/issues/51) for details). Please **discard all old versions**.
 
-> [!NOTE]
-> ODME is now available with v0.9.9.
+> [!WARNING]
+> The foregoing network inconsistency will lead to [OSError: exception: access violation reading ...](https://github.com/jdlph/Path4GMNS/issues/51#issue-2601430024) for v0.9.9 and any version before.
 
 > [!CAUTION]
 > Any version prior to v0.9.4 will generate INCORRECT simulation results.
@@ -49,12 +49,15 @@ v0.9.9 comes with bug fixes, new functionality, and performance improvement. Ple
 > [!CAUTION]
 > Zone and demand synthesis is PROBLEMATIC for any version before v0.9.9.
 
+> [!NOTE]
+> ODME is now available with v0.9.9 and v0.9.9.post1.
+
 ### 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/stable/)**.
 
 ## How to Cite
 
-Li, P. and Zhou, X. (2024, October 17). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
+Li, P. and Zhou, X. (2024, November 26). *Path4GMNS*. Retrieved from https://github.com/jdlph/Path4GMNS
 
 ## Please Contribute
 

docs/source/conf.py

@@ -28,7 +28,7 @@
 author = 'Dr. Peiheng Li and Dr. Xuesong (Simon) Zhou'
 
 # The full version, including alpha/beta/rc tags
-release = 'v0.9.9'
+release = 'v0.9.9.post1'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/installation.rst

@@ -2,17 +2,17 @@
 Installation
 ============
 
-Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.9/>`_, and can be installed using
+Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.9.post1/>`_, and can be installed using
 
 .. code-block:: bash
 
     $ pip install path4gmns
 
-If you need a specific version of Path4GMNS, say, 0.9.9,
+If you need a specific version of Path4GMNS, say, 0.9.9.post1,
 
 .. code-block:: bash
 
-    $ pip install path4gmns==0.9.9
+    $ pip install path4gmns==0.9.9.post1
 
 
 Dependency

docs/source/updates.md

@@ -59,5 +59,7 @@
 57. Introduce a new public API read_demand() to unify demand and zone synthesis, and demand (and synthetic zone) loading (v0.9.9)
 58. Deprecate confusing perform_column_generation() and replace it with find_ue() (v0.9.9)
 59. Add CMakeFiles.txt to better manage local builds and installs (v0.9.9)
+60. Reestablish cross-validation of zone id in node.csv and demand.csv (which was dropped in v0.9.9) (v0.9.9.post1)
+61. Fix potential inconsistency in essential arrays (between the underlying physical network and the shortest path network (i.e., SPNetwork)) for shortest path calculation, which would lead to [OSError](https://github.com/jdlph/Path4GMNS/issues/51) (v0.9.9.post1)
 
 Detailed update information can be found in [Releases](https://github.com/jdlph/Path4GMNS/releases).