From 6ee0184f6625b02c3a9fbcb47590382cab0aa775 Mon Sep 17 00:00:00 2001
From: sergiogimenez <hi@sergiogimenez.com>
Date: Tue, 25 Feb 2025 09:51:04 +0100
Subject: [PATCH] Add algorithm docs

---
 .../templates/tabs/environmental_impact.html  | 19 ++++++++++++++++++-
 .../algorithms/algorithm_interface.py         |  2 +-
 .../algorithms/docs_renderer.py               |  8 ++++++++
 .../algorithms/dummy_algo/dummy_calculator.py | 10 ++++++++--
 environmental_impact/models.py                |  1 +
 5 files changed, 36 insertions(+), 4 deletions(-)
 create mode 100644 environmental_impact/algorithms/docs_renderer.py

diff --git a/device/templates/tabs/environmental_impact.html b/device/templates/tabs/environmental_impact.html
index 251f8f4..f7f7b8f 100644
--- a/device/templates/tabs/environmental_impact.html
+++ b/device/templates/tabs/environmental_impact.html
@@ -1,6 +1,6 @@
 {% load i18n %}
 
-<div class="tab-pane fade show active" id="environmental_impact">
+<div class="tab-pane fade" id="environmental_impact">
   <h5 class="card-title">{% trans 'Environmental Impact Details' %}</h5>
   <hr />
 
@@ -17,4 +17,21 @@
     </div>
     <div class="col-sm-8">{{ impact.co2_emissions|default:'0.0' }} kg</div>
   </div>
+
+  <div class="mt-4">
+    <button class="btn btn-outline-primary" type="button" data-bs-toggle="collapse" data-bs-target="#docsCollapse" aria-expanded="false" aria-controls="docsCollapse">
+      {% trans 'Read about the algorithm insights' %}
+    </button>
+
+    <div class="collapse mt-3" id="docsCollapse">
+      <div class="card card-body">
+        <div class="markdown-content">
+          {{ impact.docs|safe }}
+        </div>
+      </div>
+    </div>
+  </div>
 </div>
+
+<!-- MathJax for LaTeX rendering -->
+<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" 
diff --git a/environmental_impact/algorithms/algorithm_interface.py b/environmental_impact/algorithms/algorithm_interface.py
index dcca8a5..cdc8384 100644
--- a/environmental_impact/algorithms/algorithm_interface.py
+++ b/environmental_impact/algorithms/algorithm_interface.py
@@ -8,4 +8,4 @@ class EnvironmentImpactAlgorithm(ABC):
 
     @abstractmethod
     def get_device_environmental_impact(self, device: Device) -> EnvironmentalImpact:
-        pass
+        pass
\ No newline at end of file
diff --git a/environmental_impact/algorithms/docs_renderer.py b/environmental_impact/algorithms/docs_renderer.py
new file mode 100644
index 0000000..5978d46
--- /dev/null
+++ b/environmental_impact/algorithms/docs_renderer.py
@@ -0,0 +1,8 @@
+import markdown
+
+
+def render_docs(file_path):
+    with open(file_path, 'r') as file:
+        markdown_content = file.read()
+    html_content = markdown.markdown(markdown_content)
+    return html_content
diff --git a/environmental_impact/algorithms/dummy_algo/dummy_calculator.py b/environmental_impact/algorithms/dummy_algo/dummy_calculator.py
index c1d6bde..6b4466c 100644
--- a/environmental_impact/algorithms/dummy_algo/dummy_calculator.py
+++ b/environmental_impact/algorithms/dummy_algo/dummy_calculator.py
@@ -1,6 +1,8 @@
+import os
 from device.models import Device
 from ..algorithm_interface import EnvironmentImpactAlgorithm
 from environmental_impact.models import EnvironmentalImpact
+from ..docs_renderer import render_docs
 
 
 class DummyEnvironmentalImpactAlgorithm(EnvironmentImpactAlgorithm):
@@ -12,7 +14,10 @@ class DummyEnvironmentalImpactAlgorithm(EnvironmentImpactAlgorithm):
         power_on_hours = self.get_power_on_hours_from(device)
         energy_kwh = (power_on_hours * avg_watts) / 1000
         co2_emissions = energy_kwh * co2_per_kwh
-        return EnvironmentalImpact(co2_emissions=co2_emissions)
+        current_dir = os.path.dirname(__file__)
+        docs_path = os.path.join(current_dir, 'docs.md')
+        docs = render_docs(docs_path)
+        return EnvironmentalImpact(co2_emissions=co2_emissions, docs=docs)
 
     def get_power_on_hours_from(self, device: Device) -> int:
         # TODO how do I check if the device is a legacy workbench? Is there a better way?
@@ -22,7 +27,8 @@ class DummyEnvironmentalImpactAlgorithm(EnvironmentImpactAlgorithm):
             str_time = storage_components.get('time of used', -1)
         else:
             str_time = ""
-        uptime_in_hours = self.convert_str_time_to_hours(str_time, is_legacy_workbench)
+        uptime_in_hours = self.convert_str_time_to_hours(
+            str_time, is_legacy_workbench)
         return uptime_in_hours
 
     def convert_str_time_to_hours(self, time_str: str, is_legacy_workbench: bool) -> int:
diff --git a/environmental_impact/models.py b/environmental_impact/models.py
index 871c8b6..011fd66 100644
--- a/environmental_impact/models.py
+++ b/environmental_impact/models.py
@@ -6,3 +6,4 @@ from django.db import models
 class EnvironmentalImpact:
     carbon_saved: float = 0.0
     co2_emissions: float = 0.0
+    docs: str = ""