More experiments with generating diagrams

KarlLundengaard · KarlLundengaard · commit f2a6a363ec66 · 2025-07-31T14:37:51.000+01:00
diff --git a/app/evaluation_tests.py b/app/evaluation_tests.py
@@ -23,10 +23,10 @@ class TestEvaluationFunction():
     """
 
     # Import tests that makes sure that mathematical expression comparison works as expected
-    from .tests.symbolic_evaluation_tests import TestEvaluationFunction as TestSymbolicComparison
+    #from .tests.symbolic_evaluation_tests import TestEvaluationFunction as TestSymbolicComparison
 
     # Import tests that makes sure that physical quantities are handled as expected
-    from .tests.physical_quantity_evaluation_tests import TestEvaluationFunction as TestQuantities
+    #from .tests.physical_quantity_evaluation_tests import TestEvaluationFunction as TestQuantities
 
     # Import tests that corresponds to examples in documentation and examples module
     from .tests.example_tests import TestEvaluationFunction as TestExamples
diff --git a/app/tests/example_tests.py b/app/tests/example_tests.py
@@ -4,6 +4,14 @@
 from ..evaluation import evaluation_function
 from ..preview import preview_function
 
+def create_diagram_for_documentation(filename, result):
+    for (index, graph) in result["criteria_graphs_vis"].values():
+        with open(filename+"_"+str(index)+"_"+".mmd", "w") as f:
+            #f.write(r'<!DOCTYPE html><html lang="en"><body><style>.mermaid {display: inline-flex;}</style>'+'\n')
+            for g in result["criteria_graphs_vis"].values():
+                print(g)
+                f.write('<pre class="mermaid">\n'+g+'\n</pre>\n')
+            #f.write('<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";</script></body></html>')
 
 class TestEvaluationFunction():
     """
@@ -143,6 +151,18 @@ def test_checking_the_value_of_a_physical_quantity(self, response, answer, respo
         assert tags == set(result["tags"])
         assert result["is_correct"] == value
 
+    def test_checking_the_value_of_a_physical_quantity_and_create_diagram_for_docs(self):
+        params = {
+            "strict_syntax": False,
+            "elementary_functions": True,
+            "physical_quantity": True,
+        }
+        response = "2.00 kilometre/hour"
+        answer = "2.00 km/h"
+        result = evaluation_function(response, answer, params, include_test_data=True)
+        create_diagram_for_documentation("physical_quantity.html", result)
+        assert result["is_correct"] == True
+
     @pytest.mark.parametrize(
         "res,ans,convention,value",
         [
@@ -573,12 +593,13 @@ def test_custom_comparison_with_criteria_order(self, response, value, tags):
         }
         answer = "2*x^2"
         result = evaluation_function(response, answer, params, include_test_data=True)
-        with open("diagrams.html", "a") as f:
-            f.write(r'<!DOCTYPE html><html lang="en"><body><style>.mermaid {display: inline-flex;}</style>\n')
-            for g in result["criteria_graphs_vis"].values():
-                print(g)
-                f.write('<pre class="mermaid">\n'+g+'\n</pre>\n')
-            f.write('<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";</script></body></html>')
+        create_diagram_for_documentation("custom_comparison_with_criteria_order.html", result)
+#        with open("diagrams.html", "w") as f:
+#            f.write(r'<!DOCTYPE html><html lang="en"><body><style>.mermaid {display: inline-flex;}</style>'+'\n')
+#            for g in result["criteria_graphs_vis"].values():
+#                print(g)
+#                f.write('<pre class="mermaid">\n'+g+'\n</pre>\n')
+#            f.write('<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";</script></body></html>')
         assert result["is_correct"] is value
         assert set(tags) == set(result["tags"])
 
diff --git a/app/utility/criteria_graph_utilities.py b/app/utility/criteria_graph_utilities.py
@@ -191,10 +191,11 @@ def mermaid(self):
             index = 0
             for (label, node) in nodes.items():
                 node_keys.update({label: "N_"+str(set_index)+"_"+str(index)})
+                index += 1
         for set_index, nodes in enumerate(node_sets):
             style = node_styles[set_index]
             for (label, node) in nodes.items():
-                output.append(node_keys[label]+style[0]+'"'+label+linebreak+node.summary+'"'+style[1])
+                output.append(node_keys[label]+style[0]+'"'+label+linebreak+node.details+'"'+style[1])
                 edges.update([(node_keys[edge.source.label], node_keys[edge.target.label]) for edge in node.outgoing+node.incoming])
                 if self.sufficiencies.get(label, None) is not None:
                     sufficiencies.update([(label, sufficiency) for sufficiency in self.sufficiencies.get(label, None)])
diff --git a/custom_comparison_with_criteria_order.html b/custom_comparison_with_criteria_order.html
@@ -0,0 +1,30 @@
+<!DOCTYPE html><html lang="en"><body><style>.mermaid {display: inline-flex;}</style>
+<pre class="mermaid">
+flowchart TD
+	N_0_0(["2+answer > response<br/>---<br/>Checks if 2+answer > response is true."])
+	N_1_0["2+answer > response_TRUE<br/>---<br/>2+answer > response is true."]
+	N_1_1["2+answer > response_FALSE<br/>---<br/>2+answer > response is false."]
+	N_1_2["2+answer > response_UNKNOWN<br/>---<br/>2+answer > response is false."]
+	N_2_0{{"END<br/>---<br/>Evaluation completed."}}
+	N_0_0 --> N_1_1
+	N_1_0 --> N_2_0
+	N_0_0 --> N_1_2
+	N_1_1 --> N_2_0
+	N_1_2 --> N_2_0
+	N_0_0 --> N_1_0
+</pre>
+<pre class="mermaid">
+flowchart TD
+	N_0_0(["answer <= response<br/>---<br/>Checks if answer <= response is true."])
+	N_1_0["answer <= response_TRUE<br/>---<br/>answer <= response is true."]
+	N_1_1["answer <= response_FALSE<br/>---<br/>answer <= response is false."]
+	N_1_2["answer <= response_UNKNOWN<br/>---<br/>answer <= response is false."]
+	N_2_0{{"END<br/>---<br/>Evaluation completed."}}
+	N_0_0 --> N_1_1
+	N_1_0 --> N_2_0
+	N_0_0 --> N_1_2
+	N_1_1 --> N_2_0
+	N_1_2 --> N_2_0
+	N_0_0 --> N_1_0
+</pre>
+<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";</script></body></html>
diff --git a/diagrams.html b/diagrams.html
diff --git a/physical_quantity.html b/physical_quantity.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html><html lang="en"><body><style>.mermaid {display: inline-flex;}</style>
+<pre class="mermaid">
+flowchart TD
+	N_0_0(["response matches answer<br/>---<br/>Converts QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} match to a common set of base units and compares their values."])
+	N_0_1(["response matches answer_DIMENSION_MATCH<br/>---<br/>Do the dimensions of QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} match?"])
+	N_0_2(["response matches answer_UNIT_COMPARISON<br/>---<br/>Compares how similar the units of QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} are."])
+	N_1_0["response matches answer_TRUE<br/>---<br/>The quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} match."]
+	N_1_1["response matches answer_FALSE<br/>---<br/>The quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} does not match."]
+	N_1_2["response matches answer_MISSING_VALUE<br/>---<br/>The response is missing a value."]
+	N_1_3["response matches answer_UNEXPECTED_VALUE<br/>---<br/>The response is expected only have unit(s), no value."]
+	N_1_4["response matches answer_MISSING_UNIT<br/>---<br/>The response is missing unit(s)."]
+	N_1_5["response matches answer_UNEXPECTED_UNIT<br/>---<br/>The response is expected to be a value without unit(s)."]
+	N_1_6["response matches answer_DIMENSION_MATCH_TRUE<br/>---<br/>The quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} have the same dimensions."]
+	N_1_7["response matches answer_DIMENSION_MATCH_FALSE<br/>---<br/>The quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} have different dimensions."]
+	N_1_8["response matches answer_UNIT_COMPARISON_IDENTICAL<br/>---<br/>The units of quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} are identical."]
+	N_1_9["response matches answer_UNIT_COMPARISON_SIMILAR<br/>---<br/>The units of quantities QUANTITY: response tags:  {} and QUANTITY: answer tags:  {} are similar."]
+	N_1_10["response matches answer_UNIT_COMPARISON_PREFIX_IS_LARGE<br/>---<br/>The units of QUANTITY: response tags:  {} are at least 1000 times greater than the units of QUANTITY: answer tags:  {}."]
+	N_1_11["response matches answer_UNIT_COMPARISON_PREFIX_IS_SMALL<br/>---<br/>The units of QUANTITY: response tags:  {} are at least 1000 times smaller than the units of QUANTITY: answer tags:  {}."]
+	N_2_0{{"END<br/>---<br/>Evaluation completed."}}
+	N_0_0 --> N_1_1
+	N_1_2 --> N_2_0
+	N_0_0 --> N_1_3
+	N_0_0 --> N_1_4
+	N_0_0 --> N_1_5
+	N_1_7 --> N_2_0
+	N_1_0 --> N_0_2
+	N_1_1 --> N_0_1
+	N_1_10 --> N_2_0
+	N_0_2 --> N_1_11
+	N_0_1 --> N_1_6
+	N_1_5 --> N_2_0
+	N_1_3 --> N_2_0
+	N_0_2 --> N_1_8
+	N_0_0 --> N_1_2
+	N_0_1 --> N_1_7
+	N_1_4 --> N_2_0
+	N_1_6 --> N_2_0
+	N_0_0 --> N_1_0
+	N_0_2 --> N_1_9
+	N_1_11 --> N_2_0
+	N_0_2 --> N_1_10
+</pre>
+<script type="module"> import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";</script></body></html>
