remove find_path_for_agents from tutorial and doc

- add exception handling to set_capacity_ratio of Assignment;
- update use case on loading columns to reflect the latest change on
  removing the dependency of load_demand().

Author: jdlph

docs/source/index.rst

@@ -15,11 +15,10 @@ applications in transportation (e.g., activity-based demand modeling).
 Path4GMNS supports, in short,
 
 1. finding (static) shortest path between two nodes,
-2. constructing shortest paths for all individual agents,
-3. performing path-based User-Equilibrium (UE) traffic assignment,
-4. conducting dynamic traffic assignment (DTA) after UE.
-5. evaluating multimodal accessibility and equity,
-6. synthesizing zones and Origin-Destination (OD) demand for a given network.
+2. performing path-based User-Equilibrium (UE) traffic assignment,
+3. conducting dynamic traffic assignment (DTA) after UE.
+4. evaluating multimodal accessibility and equity,
+5. synthesizing zones and Origin-Destination (OD) demand for a given network.
 
 Path4GMNS also serves as an API to the C++-based
 `DTALite <https://github.com/jdlph/DTALite>`_ to conduct various multimodal

docs/source/installation.rst

@@ -2,17 +2,17 @@
 Installation
 ============
 
-Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.2/>`_, and can be installed using
+Path4GMNS has been published on `PyPI <https://pypi.org/project/path4gmns/0.9.3/>`_, and can be installed using
 
 .. code-block:: bash
 
     $ pip install path4gmns
 
-If you need a specific version of Path4GMNS, say, 0.9.2,
+If you need a specific version of Path4GMNS, say, 0.9.3,
 
 .. code-block:: bash
 
-    $ pip install path4gmns==0.9.2
+    $ pip install path4gmns==0.9.3
 
 
 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.2.tar.gz
-    $ python -m pip instal pypath4gmns-0.9.2-py3-none-any.whl
+    # or python -m pip install path4gmns-0.9.3.tar.gz
+    $ python -m pip instal pypath4gmns-0.9.3-py3-none-any.whl
 
-Here, 0.9.2 is the version number. Replace it with the one specified in setup.py.
+Here, 0.9.3 is the version number. Replace it with the one specified in setup.py.

docs/source/usecases.md

@@ -114,63 +114,6 @@ pg.output_columns(network)
 pg.output_link_performance(network)
 ```
 
-## Find Shortest Paths for All Individual Agents
-Path4GMNS is capable of calculating and constructing the (static) shortest paths for all agents. Individual agents will be automatically set up using the aggregated travel demand between each OD pair (i.e., demand.csv) within find_path_for_agents() on its first call. If you have zone information specified in node.csv, you can also follow the legacy way to load demand and zone info (see [Tutorial](https://github.com/jdlph/Path4GMNS/blob/dev/tests/tutorial.ipynb) for details).
-
-The unique agent paths can be output to a csv file as shown in the example below.
-```python
-import path4gmns as pg
-
-network = pg.read_network()
-# it reads zone.csv by default
-pg.read_zones(network)
-# it reads demand.csv by default
-pg.load_demand(network)
-network.find_path_for_agents()
-
-agent_id = 300
-print('\norigin node id of agent is '
-      f'{network.get_agent_orig_node_id(agent_id)}')
-print('destination node id of agent is '
-      f'{network.get_agent_dest_node_id(agent_id)}')
-print('shortest path (node id) of agent, '
-      f'{network.get_agent_node_path(agent_id)}')
-print('shortest path (link id) of agent, '
-      f'{network.get_agent_link_path(agent_id)}')
-
-agent_id = 1000
-print('\norigin node id of agent is '
-      f'{network.get_agent_orig_node_id(agent_id)}')
-print('destination node id of agent is '
-      f'{network.get_agent_dest_node_id(agent_id)}')
-print('shortest path (node id) of agent, '
-      f'{network.get_agent_node_path(agent_id)}')
-print('shortest path (link id) of agent, '
-      f'{network.get_agent_link_path(agent_id)}')
-
-# output unique agent paths to a csv file
-# if you do not want to include geometry info in the output file,
-# use pg.output_agent_paths(network, False)
-pg.output_agent_paths(network)
-```
-
-v0.7.2 or higher features finding agent paths under a specific mode defined in settings.yml. The following example demonstrates this new functionality under mode walk (i.e., w).
-```python
-import path4gmns as pg
-
-network = pg.read_network()
-pg.read_zones(network)
-pg.load_demand(network)
-
-network.find_path_for_agents()
-
-# or equivalently network.find_path_for_agents('walk')
-network.find_path_for_agents('w')
-
-# retrieving the origin, the destination, and the shortest path of a given agent
-# is exactly the same as before as well as outputting all unique agent paths
-```
-
 ## Perform Path-Based UE Traffic Assignment using the Python Column-Generation Module
 The Python column-generation module only implements path-based UE. If you need other assignment modes, e.g., link-based UE or DTA, please use perform_network_assignment_DTALite().
 
@@ -532,8 +475,6 @@ If you have agent.csv (i.e.columns) from a previous run or DTALite, you can bypa
 import path4gmns as pg
 
 network = pg.read_network()
-pg.read_zones(network)
-pg.load_demand(network)
 
 # load existing UE result
 pg.load_columns(network)

path4gmns/classes.py

@@ -1718,7 +1718,11 @@ def set_simu_start_time(self, st):
         self.simu_st = st
 
     def set_capacity_ratio(self, tau, link_id, r):
-        link_no = self.get_link_seq_no(link_id)
+        try:
+            link_no = self.get_link_seq_no(link_id)
+        except KeyError:
+            return
+
         link = self.get_link(link_no)
         link.set_capacity_ratio(tau, r)
 
@@ -1759,7 +1763,10 @@ def get_ODMatrix(self):
         return self._base_assignment.network.ODMatrix
 
     def find_path_for_agents(self, mode='all'):
-        """ find and set up shortest path for each agent """
+        """ DEPRECATED
+
+        find and set up shortest path for each agent
+        """
         return self._base_assignment.find_path_for_agents(mode)
 
     def find_shortest_path(self, from_node_id, to_node_id,