Fix diagnostics (#1983)

huawei-noah · Apr 26, 2023 · 9e35300 · 9e35300
1 parent 4f4c965
commit 9e35300
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/resources/diagnostic.rst b/docs/resources/diagnostic.rst
@@ -23,9 +23,14 @@ Run
 ---
 
 Run the diagnostic :func:`~smarts.diagnostic.run.main` with one or multiple scenarios, from the ``SMARTS/smarts/diagnostic`` folder.
+Reports will be generated in the ``SMARTS/smarts/diagnostic/reports`` folder.
 
 .. code-block:: bash
 
     $ cd <path/to>/SMARTS
+    $ python3.8 -m venv ./.venv
+    $ source ./.venv/bin/activate
+    $ pip install --upgrade pip
+    $ pip install -e .[diagnostic]
     $ scl diagnostic run <scenarios/path> [scenarios/path]
-    # e.g., scl diagnostic run n_sumo_actors/1_actors
+    # e.g., scl diagnostic run n_sumo_actors/1_actors n_agents/1_agents
diff --git a/smarts/diagnostic/run.py b/smarts/diagnostic/run.py
@@ -194,7 +194,7 @@ def _write_report(results: Dict[str, Any]):
     plt.savefig(dir / "Fig1.png")
     mdFile.new_paragraph(
         "<figure>"
-        f"\n<img src={dir/'Fig1.png'} alt='line chart' style='width:500px;'/>"
+        f"\n<img src='{dir/'Fig1.png'}' alt='line chart' style='width:500px;'/>"
         "\n</figure>"
     )