Fix docs, add performance report (#885)

* ignore image map if file missing

* performance report

Author: jpn--

docs/add_image_map.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 # rst doesn't support image maps, so we'll add one after the html has been built
+import os.path
 
 fileName = "_build/html/examples.html"
 line = 'src="_images/abmexample.jpg" />'
@@ -37,14 +40,15 @@
 
 print("add image map to " + fileName)
 
-with open(fileName, encoding="utf-8") as file:
-    lines = file.readlines()
+if os.path.exists(fileName):
+    with open(fileName, encoding="utf-8") as file:
+        lines = file.readlines()
 
-with open(fileName, "w") as file:
-    for aLine in lines:
-        if line in aLine:
-            print("updated " + fileName)
-            file.writelines("%s" % aLine.replace(line, lineWithMap))
-            file.writelines("%s" % imageMap)
-        else:
-            file.writelines("%s" % aLine)
+    with open(fileName, "w") as file:
+        for aLine in lines:
+            if line in aLine:
+                print("updated " + fileName)
+                file.writelines("%s" % aLine.replace(line, lineWithMap))
+                file.writelines("%s" % imageMap)
+            else:
+                file.writelines("%s" % aLine)

docs/users-guide/example_models.rst

@@ -32,6 +32,8 @@ ActivitySim.
     capabilities of ActivitySim and to provide a starting point for users to build their own
     models. However, they are not intended to be used as-is for policy analysis or forecasting.
 
+A discussion of the runtime performance of the example models is available in the
+:ref:`example performance benchmarking <example-performance>` section.
 
 This page describes the structure of the MTC example model in more detail.