consistent recommendation about setting python's sys.path #2

eclipse-sumo · Apr 19, 2024 · ff0a605 · ff0a605
1 parent 84880fe
commit ff0a605
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 27 deletions.
diff --git a/docs/web/docs/Developer/PythonFileTemplate.md b/docs/web/docs/Developer/PythonFileTemplate.md
@@ -36,7 +36,8 @@ import sys
 import ...
 
 # use the following when you depend on sumolib or traci
-sys.path.append(os.path.join(os.environ["SUMO_HOME"], 'tools'))
+if "SUMO_HOME" in os.environ:
+    sys.path.append(os.path.join(os.environ["SUMO_HOME"], 'tools'))
 import sumolib  # noqa
 # the noqa is needed to tell the style checker that it is OK to have an import which is not at the top of the file
 ```
diff --git a/docs/web/docs/Tools/Sumolib.md b/docs/web/docs/Tools/Sumolib.md
@@ -14,12 +14,10 @@ To use the library, the {{SUMO}}/tools directory must be on the python load
 path. This is typically done with a stanza like this:
 
 ```python
-import os, sys
+import os
+import sys
 if 'SUMO_HOME' in os.environ:
-    tools = os.path.join(os.environ['SUMO_HOME'], 'tools')
-    sys.path.append(tools)
-else:   
-    sys.exit("please declare environment variable 'SUMO_HOME'")
+    sys.path.append(os.path.join(os.environ['SUMO_HOME'], 'tools'))
 ```
 
 # loading a network file

diff --git a/docs/web/docs/Tutorials/CityMobil.md b/docs/web/docs/Tutorials/CityMobil.md
@@ -26,7 +26,8 @@ import os
 import sys
 from constants import PREFIX, DOUBLE_ROWS, ROW_DIST, SLOTS_PER_ROW, SLOT_WIDTH
 ... # more constants
-sys.path.append(os.path.join(os.environ['SUMO_HOME'], 'tools'))
+if 'SUMO_HOME' in os.environ:
+    sys.path.append(os.path.join(os.environ['SUMO_HOME'], 'tools'))
 import sumolib
 ```
 

diff --git a/docs/web/docs/Tutorials/HighwayDetector.md b/docs/web/docs/Tutorials/HighwayDetector.md
@@ -42,27 +42,28 @@ network. A starting point can be to use the python sumolib to match the
 positions to the network:
 
 ```python
+if 'SUMO_HOME' in os.environ:
     sys.path.append(os.path.join(os.environ["SUMO_HOME"], 'tools'))
-    import sumolib
-
-    net = sumolib.net.readNet(<NETFILE>)
-    detectors = []
-    for id, lon, lat in <DETECTOR_INPUTFILE>:
-        xy_pos = net.convertLonLat2XY(lon, lat)
-        # look 10m around the position
-        lanes = net.getNeighboringLanes(xy_pos[0], xy_pos[1], 10)
-        # attention, result is unsorted
-            bestLane = None
-            ref_d = 9999.
-        for lane, dist in lanes:
-            # now process them and determine a "bestLane"
-            # ...
-                    if dist < ref_d:
-                        ref_d = dist
-                        bestLane = lane
-                pos, d = bestLane.getClosestLanePosAndDist(xy_pos)
-        detectors.append(sumolib.sensors.inductive_loop.InductiveLoop(id, bestLane.getID(), pos))
-    sumolib.files.additional.write(<DETECTORFILE>, detectors)
+import sumolib
+
+net = sumolib.net.readNet(<NETFILE>)
+detectors = []
+for id, lon, lat in <DETECTOR_INPUTFILE>:
+    xy_pos = net.convertLonLat2XY(lon, lat)
+    # look 10m around the position
+    lanes = net.getNeighboringLanes(xy_pos[0], xy_pos[1], 10)
+    # attention, result is unsorted
+        bestLane = None
+        ref_d = 9999.
+    for lane, dist in lanes:
+        # now process them and determine a "bestLane"
+        # ...
+                if dist < ref_d:
+                    ref_d = dist
+                    bestLane = lane
+            pos, d = bestLane.getClosestLanePosAndDist(xy_pos)
+    detectors.append(sumolib.sensors.inductive_loop.InductiveLoop(id, bestLane.getID(), pos))
+sumolib.files.additional.write(<DETECTORFILE>, detectors)
 ```
 
 The period of data aggregation for data collection is 60 seconds by