add methods writeup

reports/DOCS/DOCS.qmd

@@ -0,0 +1,101 @@
+---
+title: 'Summarisation of Planning Responses with LLMs'
+format:
+  PrettyPDF-pdf:
+    papersize: A4
+  lumo-html:
+    logo: logo.png
+    github-repo: https://github.com/cjber/planning-ai
+    self-contained: true
+    is-particlejs-enabled: true
+execute:
+  freeze: auto
+  echo: false
+monofont: 'JetBrains Mono'
+monofontoptions:
+  - Scale=0.55
+---
+
+## Introduction
+
+* Saves time; takes minutes rather than hours (or days)
+* Reduces bias?
+* All information can be considered equally.
+* diverse forms of input; letters to brief comments, even handwritten text (gpt-4o).
+* generate easy to understand summaries, removing any domain specific terminology. increased transparency etc.
+
+* ensure the summaries are accurate, may require human oversight? For this we are using hallucination detection which works well.
+
+## Methodology
+
+This project primarily considers the use of generative pre-trained transformer (GPT) large-language models (LLMs) for summarising planning responses. While _extractive_ summarisation using encoder-transformer LLMs has been an established task for a number of years (e.g. with Google's BERT), only recently has this task been advanced through the use of larger scale GPT models (e.g. OpenAIs gpt-3/gpt-4 series). One benefit of these new models are their size; they are both _trained_ on more human data, and have a larger number of _model parameters_. Both of these factors mean that such models are able to understand human text and semantic nuances to a greater degree. Additionally, their architectural differences mean that, while BERT-like models excel at extractive summarisation, GPT models are able to generate large amounts of human-like text. 
+
+Given these advances, a number of methods relating to document summarisation have been established in recent years (or months). In this project, we focus on the task of _map-reduce_ summarisation; given a large set of documents, summarise each, then summarise those summaries to produce a final report.
+
+For our use-case we established the following data-flow;
+
+```{mermaid}
+%%{init: {'flowchart': {'curve': 'linear'}}}%%
+graph TD;
+        __start__([__start__]):::first
+        generate_summary(generate_summary)
+        check_hallucination(check_hallucination)
+        fix_hallucination(fix_hallucination)
+        generate_final_summary(generate_final_summary)
+        __end__([__end__]):::last
+        check_hallucination --> generate_final_summary;
+        generate_final_summary --> __end__;
+        __start__ -.-> generate_summary;
+        generate_summary -.-> check_hallucination;
+        check_hallucination -.-> fix_hallucination;
+        fix_hallucination -.-> check_hallucination;
+        classDef default fill:#f2f0ff,line-height:1.2
+        classDef first fill-opacity:0
+        classDef last fill:#bfb6fc
+```
+
+1. Summaries for each response are generated in parallel
+2. Each summary is check to ensure there are no _hallucinations_ (cyclically)  
+3. Summaries are used to form a final report
+
+### Hallucination removal
+
+Hallucination detection and removal is a key part of this process. While summarisation typically accurately reflect the information contained within the documents they are summarising, the model may sometimes inject information that isn't explicitly stated. To avoid these cases we use another LLM _agent_ to read through both the original document and the summarisation, to produce a report highlighting any issues, and give a score that informs a downstream stage whether the summary is accurate.
+
+In the following example we highlight a case where the original summarisation LLM makes a clear mistake, which is then rectified by a further iteration, information by the hallucination agent. For brevity, the questions have been removed from the response.
+
+**Document**:
+
+_None. The wastewater treatment plant has recently been upgraded and deemed fit for purpose for a significant
+ number of years going forward. The carbon and financial cost of relocating this site is huge - if housing is needed then the housing should be situated in the proposed site for the relocated treatment plant, the new
+ homeowners would certainly enjoy their life in the greenbelt, those living nearby would be grateful and £227 million pounds and many tonnes of carbon saved._
+
+_Vast open spaces should be employed. Community centers are important, including support for children and mental health. National chains should be banned from owning shops or property in the area._
+
+_Cambourne should remain isolated and become self sufficient. If anything, more cycle only routes should be set up._
+
+_None. These villages should remain as they are._
+
+_Grantchester._
+
+_Road bypasses._
+
+_Barton and Newnham_
+
+_Underdeveloped and preserved_
+
+**Summarisation Attempt**: 
+
+The response indicates that the area east of Milton Road can be developed into a lively city district after the wastewater treatment plant relocates, emphasizing the high costs of relocation. It advocates for vast open spaces and community centers around the Cambridge Biomedical Campus, while suggesting that Cambourne should remain isolated and self-sufficient. The response opposes development in the southern rural cluster of villages, supports limited development in Grantchester, and proposes road bypasses. Additionally, it identifies Barton and Newnham as potential sites for development. The overall vision for Greater Cambridge in 2041 includes a focus on preservation and limited development.
+
+**Hallucination agent response**
+
+The Assistant's Summary contains several inaccuracies and misinterpretations of the source document. Firstly, it states that the response opposes development east of Milton Road due to the recent upgrade of the wastewater treatment plant, which is misleading. The source document suggests that the area can be developed after the plant relocates, indicating a potential for development rather than outright opposition. Secondly, the summary claims that the vision for Greater Cambridge in 2041 is to remain underdeveloped and preserved, which is a misrepresentation of the nuanced views expressed in the source document. The source document does advocate for some development in specific areas, such as Grantchester and the Cambridge Biomedical Campus, while also emphasizing the importance of open spaces and community centers. Therefore, the summary does not fully align with the source document and contains hallucinations.
+
+**Score**: FAIL
+
+**Final**:
+
+The response opposes the development of the area east of Milton Road, arguing that the wastewater treatment plant is fit for purpose and should not be relocated due to high costs. It supports the development of the Cambridge Biomedical Campus with a focus on vast open spaces and community centers. Cambourne should remain isolated and self-sufficient, with an emphasis on cycle routes. The response opposes development in the southern rural cluster of villages, supports limited development in Grantchester, and suggests that road bypasses are needed. It identifies Barton and Newnham as potential sites for development. The overall vision for Greater Cambridge in 2041 emphasizes preservation and limited development.
+
+

reports/DOCS/_extensions/holtzy/lumo/_extension.yml

@@ -0,0 +1,20 @@
+title: Lumo
+author: Holtz Yan
+version: 1.0.0
+quarto-required: ">=1.4.0"
+contributes:
+  formats:
+    html:
+      toc: true
+      code-fold: true
+      code-summary: "Code"
+      toc-location: left
+      toc-title: " "
+      theme: [custom.scss]
+      include-after-body: "footer.html"
+      template-partials:
+        - title-block.html
+      css: style.css
+      smooth-scroll: true
+      code-annotations: hover
+      title-block-banner: true

reports/DOCS/_extensions/holtzy/lumo/footer.html

@@ -0,0 +1,9 @@
+<div class="footer-container">
+  <hr />
+  <p
+    style="text-align: center; opacity: 0.5; font-size: 15px; max-width: 300px"
+  >
+    This document was made using <code>lumo</code>, a quarto template by
+    <a href="https://www.yan-holtz.com">Yan Holtz</a>.
+  </p>
+</div>

reports/DOCS/_extensions/holtzy/lumo/particles.json

@@ -0,0 +1,116 @@
+{
+  "particles": {
+    "number": {
+      "value": 80,
+      "density": {
+        "enable": true,
+        "value_area": 800
+      }
+    },
+    "color": {
+      "value": "#888888"
+    },
+    "shape": {
+      "type": "circle",
+      "stroke": {
+        "width": 0,
+        "color": "#000000"
+      },
+      "polygon": {
+        "nb_sides": 5
+      },
+      "image": {
+        "src": "img/github.svg",
+        "width": 100,
+        "height": 100
+      }
+    },
+    "opacity": {
+      "value": 0.5,
+      "random": false,
+      "anim": {
+        "enable": false,
+        "speed": 1,
+        "opacity_min": 0.1,
+        "sync": false
+      }
+    },
+    "size": {
+      "value": 5,
+      "random": true,
+      "anim": {
+        "enable": false,
+        "speed": 40,
+        "size_min": 0.1,
+        "sync": false
+      }
+    },
+    "line_linked": {
+      "enable": true,
+      "distance": 150,
+      "color": "#888888",
+      "opacity": 0.4,
+      "width": 1
+    },
+    "move": {
+      "enable": true,
+      "speed": 3,
+      "direction": "none",
+      "random": false,
+      "straight": false,
+      "out_mode": "out",
+      "attract": {
+        "enable": false,
+        "rotateX": 600,
+        "rotateY": 1200
+      }
+    }
+  },
+  "interactivity": {
+    "detect_on": "canvas",
+    "events": {
+      "onhover": {
+        "enable": true,
+        "mode": "repulse"
+      },
+      "onclick": {
+        "enable": true,
+        "mode": "push"
+      },
+      "resize": true
+    },
+    "modes": {
+      "grab": {
+        "distance": 400,
+        "line_linked": {
+          "opacity": 1
+        }
+      },
+      "bubble": {
+        "distance": 400,
+        "size": 40,
+        "duration": 2,
+        "opacity": 8,
+        "speed": 3
+      },
+      "repulse": {
+        "distance": 200
+      },
+      "push": {
+        "particles_nb": 4
+      },
+      "remove": {
+        "particles_nb": 2
+      }
+    }
+  },
+  "retina_detect": true,
+  "config_demo": {
+    "hide_card": false,
+    "background_color": "#b61924",
+    "background_image": "",
+    "background_position": "50% 50%",
+    "background_repeat": "no-repeat",
+    "background_size": "cover"
+  }
+}

reports/DOCS/_extensions/holtzy/lumo/style.css

@@ -0,0 +1,158 @@
+body {
+  font-family: "Inter", sans-serif;
+  font-style: normal;
+  font-size: 16px;
+}
+
+/* ------------------------------------------- Titles ----------------- */
+h1 {
+  margin-block-start: 20px;
+  font-size: 2.25rem;
+  font-weight: 800;
+  letter-spacing: -0.02em;
+}
+@media (min-width: 1024px) {
+  h1 {
+    font-size: 3rem;
+  }
+}
+h2 {
+  margin-top: 190px !important;
+  margin-block-start: 20px;
+  border-bottom: 0.1px solid rgb(232, 232, 232);
+  padding-bottom: 0.5rem;
+  font-size: 1.875rem;
+  font-weight: 600;
+  letter-spacing: -0.02em;
+  transition: color 0.2s ease;
+}
+h2:first-of-type {
+  margin-top: 0;
+}
+h3 {
+  margin-top: 2rem;
+  margin-block-start: 20px;
+  font-size: 1.5rem;
+  font-weight: 600;
+  letter-spacing: -0.02em;
+}
+
+/* ------------------------------------------- Text ----------------- */
+p {
+  line-height: 28px;
+}
+p:not(:first-child) {
+  margin-top: 12px;
+}
+a {
+  font-weight: 500;
+  color: var(--primary-color);
+  text-decoration: underline;
+  text-underline-offset: 0.25rem;
+}
+
+/* ------------------------------------------- Lists ----------------- */
+ul {
+  margin: 1.5rem 0;
+  margin-left: 1.5rem;
+  list-style-type: disc;
+}
+ul > li {
+  margin-top: 0.5rem;
+}
+
+/* ------------------------------------------- Buttons used for tabs ----------------- */
+.nav-pills .nav-link {
+  color: var(--primary-color);
+  background-color: white;
+  border-color: var(--primary-color);
+  border-radius: 4px;
+}
+.nav-pills .nav-link.active {
+  color: white;
+  background-color: var(--primary-color);
+}
+.nav-pills .nav-link {
+  padding: 5px;
+  margin-right: 4px;
+}
+ul.nav.nav-tabs {
+  margin: 0px;
+  border: none;
+}
+.tab-content {
+  border: none;
+  margin-top: 10px;
+  padding: 0px;
+}
+
+/* ------------------------------------------- Table of content ----------------- */
+.sidebar nav[role="doc-toc"] ul > li > a.active,
+.sidebar nav[role="doc-toc"] ul > li > ul > li > a.active {
+  border-left: 1px solid var(--primary-color);
+  color: var(--primary-color) !important;
+}
+#TOC {
+  top: 50%;
+  position: relative;
+  transform: translate(0, -50%);
+}
+
+/* ------------------------------------------- Horizontal separator ----------------- */
+hr {
+  margin-top: 23px;
+  margin-bottom: 23px;
+  border: 0;
+  border-top: 1px solid black;
+  width: 0;
+  animation: separator-width 2s ease-in-out forwards;
+}
+@keyframes separator-width {
+  0% {
+    width: 0;
+  }
+  100% {
+    width: 200px;
+  }
+}
+
+/* ------------------------------------------- Footer ----------------- */
+.footer-container {
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+  padding-top: 40px;
+  padding-bottom: 40px;
+}
+
+/* ------------------------------------------- DT table: smaller font ----------------- */
+table.dataTable tbody th,
+table.dataTable tbody td {
+  padding: 6px 10px;
+  font-size: 12px;
+}
+
+/* ------------------------------------------- Callout ----------------- */
+div.callout.callout {
+  border: none;
+  padding: 0.4em 0.7em;
+  border-left: var(--primary-color) 4px solid;
+  background-color: color-mix(in srgb, var(--primary-color), transparent 95%);
+  border-radius: 0px;
+}
+
+button {
+  color: var(--primary-color);
+  background-color: white;
+  border: var(--primary-color) 1px solid;
+  border-radius: 1px;
+}
+
+.grey-section {
+  background-color: #f8f9fa;
+  padding-top: 40px;
+  padding-bottom: 40px;
+  margin-top: 20px;
+  margin-bottom: 20px;
+}

reports/DOCS/_extensions/holtzy/lumo/title-block.html

@@ -0,0 +1,160 @@
+<style>
+  :root {
+    --primary-color: $primary-color$;
+  }
+  .title-block-content {
+    position: relative;
+    padding-top: 130px;
+    padding-bottom: 130px;
+    max-width: 752px;
+    margin: auto;
+  }
+  .header-keyword {
+    color: rgb(59, 59, 59);
+    opacity: 0.5;
+    font-size: 14;
+  }
+  .octocat-container {
+    fill: var(--primary-color);
+    color: #fff;
+    position: absolute;
+    top: 0;
+    border: 0;
+    right: 0;
+  }
+  #particles-js {
+    position: absolute;
+    top: 0px;
+    left: 0px;
+    width: 100%;
+    height: 100%;
+  }
+</style>
+
+<header id="title-block-header" style="position: relative">
+  <link
+    href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
+    rel="stylesheet"
+  />
+
+  <!-- This is the div in which the particles will be included -->
+  $if(is-particlejs-enabled)$
+  <div id="particles-js"></div>
+  $endif$
+
+  <!-- Actual content on top of the particles-->
+  <div class="title-block-content">
+    <!-- Logo -->
+    $if(logo)$
+    <img
+      src="$logo$"
+      alt="logo of company"
+      height="80px"
+      style="margin-bottom: 20px"
+    />
+    $endif$
+
+    <!-- Title -->
+    $if(title)$
+    <h1 class="title">$title$</h1>
+    $endif$
+
+    <hr />
+
+    <!-- Subtitle -->
+    $if(subtitle)$
+    <p class="subtitle">$subtitle$</p>
+    $endif$
+
+    <!-- Author -->
+    $for(author)$
+    <p class="author"><span class="header-keyword">Author: </span>$author$</p>
+    $endfor$
+
+    <!-- Date -->
+    $if(date)$
+    <p style="margin-top: 0px">
+      <span class="header-keyword">Date: </span>$date$
+    </p>
+    $endif$
+
+    <!-- Particle.js script loaded from a CDN -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/particles.js/2.0.0/particles.min.js"></script>
+
+    <!-- use the particle js library with our own config (json file). -->
+    <script>
+      particlesJS.load(
+        "particles-js",
+        "https://raw.githubusercontent.com/holtzy/lumo/main/_extensions/lumo/particles.json"
+      );
+    </script>
+  </div>
+</header>
+
+<!------------------------- Code for the octocat (github Mascot) that will be included if a link to the github repo is provided. ------------------->
+$if(github-repo)$
+<a
+  href="$github-repo$"
+  class="github-corner"
+  aria-label="View source on GitHub"
+>
+  <svg
+    width="80"
+    height="80"
+    viewBox="0 0 250 250"
+    class="octocat-container"
+    aria-hidden="true"
+  >
+    <path
+      d="M0,0 L115,115 L130,115
+    L142,142 L250,250 L250,0 Z"
+    ></path>
+    <path
+      d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6
+    C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3
+    125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
+      fill="currentColor"
+      style="transform-origin: 130px 106px"
+      class="octo-arm"
+    ></path>
+    <path
+      d="M115.0,115.0 C114.9,115.1 118.7,116.5
+    119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0
+    C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5
+    178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2
+    216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5
+    C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5
+    C139.8,137.7 141.6,141.9 141.8,141.8 Z"
+      fill="currentColor"
+      class="octo-body"
+    ></path>
+  </svg>
+</a>
+<style>
+  .github-corner:hover .octo-arm {
+    animation: octocat-wave 560ms ease-in-out;
+  }
+  @keyframes octocat-wave {
+    0%,
+    100% {
+      transform: rotate(0);
+    }
+    20%,
+    60% {
+      transform: rotate(-25deg);
+    }
+    40%,
+    80% {
+      transform: rotate(10deg);
+    }
+  }
+  @media (max-width: 500px) {
+    .github-corner:hover .octo-arm {
+      animation: none;
+    }
+    .github-corner .octo-arm {
+      animation: octocat-wave 560ms ease-in-out;
+    }
+  }
+</style>
+$endif$

reports/DOCS/_extensions/nrennie/PrettyPDF/PrettyPDF.lua

@@ -0,0 +1,10 @@
+function Div(el)
+  if el.classes:includes('article') then
+    local blocks = pandoc.List({
+      pandoc.RawBlock('typst', '#article[')
+    })
+    blocks:extend(el.content)
+    blocks:insert(pandoc.RawBlock('typst', ']\n'))
+    return blocks
+  end
+end

reports/DOCS/_extensions/nrennie/PrettyPDF/PrettyPDF.tex

@@ -0,0 +1,77 @@
+% load packages
+\usepackage{geometry}
+\usepackage{xcolor}
+\usepackage{eso-pic}
+\usepackage{fancyhdr}
+\usepackage{sectsty}
+\usepackage{fontspec}
+\usepackage{titlesec}
+
+%% Set page size with a wider right margin
+\geometry{a4paper, total={170mm,257mm}, left=20mm, top=20mm, bottom=20mm, right=50mm}
+
+%% Let's define some colours
+\definecolor{light}{HTML}{E6E6FA}
+\definecolor{highlight}{HTML}{800080}
+\definecolor{dark}{HTML}{330033}
+
+%% Let's add the border on the right hand side 
+\AddToShipoutPicture{% 
+    \AtPageLowerLeft{% 
+        \put(\LenToUnit{\dimexpr\paperwidth-3cm},0){% 
+            \color{light}\rule{3cm}{\LenToUnit\paperheight}%
+          }%
+     }%
+     % logo
+    \AtPageLowerLeft{% start the bar at the bottom right of the page
+        \put(\LenToUnit{\dimexpr\paperwidth-2.75cm},27.2cm){% move it to the top right
+            \color{light}\includegraphics[width=2.5cm]{_extensions/nrennie/PrettyPDF/logo.png}
+          }%
+     }%
+}
+
+%% Style the page number
+\fancypagestyle{mystyle}{
+  \fancyhf{}
+  \renewcommand\headrulewidth{0pt}
+  \fancyfoot[R]{\thepage}
+  \fancyfootoffset{3.5cm}
+}
+\setlength{\footskip}{20pt}
+
+%% style the chapter/section fonts
+\chapterfont{\color{dark}\fontsize{20}{16.8}\selectfont}
+\sectionfont{\color{dark}\fontsize{20}{16.8}\selectfont}
+\subsectionfont{\color{dark}\fontsize{14}{16.8}\selectfont}
+\titleformat{\subsection}
+  {\sffamily\Large\bfseries}{\thesection}{1em}{}[{\titlerule[0.8pt]}]
+  
+% left align title
+\makeatletter
+\renewcommand{\maketitle}{\bgroup\setlength{\parindent}{0pt}
+\begin{flushleft}
+  {\sffamily\huge\textbf{\MakeUppercase{\@title}}} \vspace{0.3cm} \newline
+  {\Large {\@subtitle}} \newline
+  \@author
+\end{flushleft}\egroup
+}
+\makeatother
+
+%% Use some custom fonts
+\setsansfont{Ubuntu}[
+    Path=_extensions/nrennie/PrettyPDF/Ubuntu/,
+    Scale=0.9,
+    Extension = .ttf,
+    UprightFont=*-Regular,
+    BoldFont=*-Bold,
+    ItalicFont=*-Italic,
+    ]
+
+\setmainfont{Ubuntu}[
+    Path=_extensions/nrennie/PrettyPDF/Ubuntu/,
+    Scale=0.9,
+    Extension = .ttf,
+    UprightFont=*-Regular,
+    BoldFont=*-Bold,
+    ItalicFont=*-Italic,
+    ]

reports/DOCS/_extensions/nrennie/PrettyPDF/Ubuntu/UFL.txt

@@ -0,0 +1,96 @@
+-------------------------------
+UBUNTU FONT LICENCE Version 1.0
+-------------------------------
+
+PREAMBLE
+This licence allows the licensed fonts to be used, studied, modified and
+redistributed freely. The fonts, including any derivative works, can be
+bundled, embedded, and redistributed provided the terms of this licence
+are met. The fonts and derivatives, however, cannot be released under
+any other licence. The requirement for fonts to remain under this
+licence does not require any document created using the fonts or their
+derivatives to be published under this licence, as long as the primary
+purpose of the document is not to be a vehicle for the distribution of
+the fonts.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this licence and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Original Version" refers to the collection of Font Software components
+as received under this licence.
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to
+a new environment.
+
+"Copyright Holder(s)" refers to all individuals and companies who have a
+copyright ownership of the Font Software.
+
+"Substantially Changed" refers to Modified Versions which can be easily
+identified as dissimilar to the Font Software by users of the Font
+Software comparing the Original Version with the Modified Version.
+
+To "Propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification and with or without charging
+a redistribution fee), making available to the public, and in some
+countries other activities as well.
+
+PERMISSION & CONDITIONS
+This licence does not grant any rights under trademark law and all such
+rights are reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of the Font Software, to propagate the Font Software, subject to
+the below conditions:
+
+1) Each copy of the Font Software must contain the above copyright
+notice and this licence. These can be included either as stand-alone
+text files, human-readable headers or in the appropriate machine-
+readable metadata fields within text or binary files as long as those
+fields can be easily viewed by the user.
+
+2) The font name complies with the following:
+(a) The Original Version must retain its name, unmodified.
+(b) Modified Versions which are Substantially Changed must be renamed to
+avoid use of the name of the Original Version or similar names entirely.
+(c) Modified Versions which are not Substantially Changed must be
+renamed to both (i) retain the name of the Original Version and (ii) add
+additional naming elements to distinguish the Modified Version from the
+Original Version. The name of such Modified Versions must be the name of
+the Original Version, with "derivative X" where X represents the name of
+the new work, appended to that name.
+
+3) The name(s) of the Copyright Holder(s) and any contributor to the
+Font Software shall not be used to promote, endorse or advertise any
+Modified Version, except (i) as required by this licence, (ii) to
+acknowledge the contribution(s) of the Copyright Holder(s) or (iii) with
+their explicit written permission.
+
+4) The Font Software, modified or unmodified, in part or in whole, must
+be distributed entirely under this licence, and must not be distributed
+under any other licence. The requirement for fonts to remain under this
+licence does not affect any document created using the Font Software,
+except any version of the Font Software extracted from a document
+created using the Font Software may only be distributed under this
+licence.
+
+TERMINATION
+This licence becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
+COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER
+DEALINGS IN THE FONT SOFTWARE.

reports/DOCS/_extensions/nrennie/PrettyPDF/_extension.yml

@@ -0,0 +1,30 @@
+title: PrettyPDF
+author: Nicola Rennie
+version: 0.0.3
+contributes:
+  project:
+    project:
+      type: book
+  formats: 
+    pdf:
+      include-in-header: 
+       - "PrettyPDF.tex"
+      include-before-body:
+       - "pagestyle.tex"
+      toc: false
+      code-block-bg: light
+      linkcolor: highlight
+      urlcolor: highlight
+    typst:
+      papersize: a4
+      margin:
+        x: 2cm
+        y: 2cm
+      font-paths: Ubuntu
+      typst-logo: 
+        path: "logo.png"
+      template-partials:
+        - typst-template.typ
+        - typst-show.typ
+      filters:
+        - PrettyPDF.lua

reports/DOCS/_extensions/nrennie/PrettyPDF/pagestyle.tex

@@ -0,0 +1 @@
+\pagestyle{mystyle}

reports/DOCS/_extensions/nrennie/PrettyPDF/typst-show.typ

@@ -0,0 +1,15 @@
+#show: PrettyPDF.with(
+$if(title)$
+  title: "$title$",
+$endif$
+$if(subtitle)$
+  title: "$subtitle$",
+$endif$
+$if(typst-logo)$
+  typst-logo: (
+    path: "$typst-logo.path$",
+    caption: [$typst-logo.caption$]
+  ), 
+$endif$
+)
+

reports/DOCS/_extensions/nrennie/PrettyPDF/typst-template.typ

@@ -0,0 +1,90 @@
+
+#let PrettyPDF(
+  // The document title.
+  title: "PrettyPDF",
+
+  // Logo in top right corner.
+  typst-logo: none,
+
+  // The document content.
+  body
+) = {
+
+  // Set document metadata.
+  set document(title: title)
+  
+  // Configure pages.
+  set page(
+    margin: (left: 2cm, right: 1.5cm, top: 2cm, bottom: 2cm),
+    numbering: "1",
+    number-align: right,
+    background: place(right + top, rect(
+      fill: rgb("#E6E6FA"),
+      height: 100%,
+      width: 3cm,
+    ))
+  )
+  
+  // Set the body font.
+  set text(10pt, font: "Ubuntu")
+
+  // Configure headings.
+  show heading.where(level: 1): set block(below: 0.8em)
+  show heading.where(level: 1): underline
+  show heading.where(level: 2): set block(above: 0.5cm, below: 0.5cm)
+
+  // Links should be purple.
+  show link: set text(rgb("#800080"))
+
+  // Configure light purple border.
+  show figure: it => block({
+    move(dx: -3%, dy: 1.5%, rect(
+      fill: rgb("FF7D79"),
+      inset: 0pt,
+      move(dx: 3%, dy: -1.5%, it.body)
+    ))
+  })
+
+  // Purple border column
+  grid(
+    columns: (1fr, 0.75cm),
+    column-gutter: 2.5cm,
+
+    // Title.
+    text(font: "Ubuntu", 20pt, weight: 800, upper(title)),
+
+    // The logo in the sidebar.
+    locate(loc => {
+      set align(right)
+
+      // Logo.
+      style(styles => {
+        if typst-logo == none {
+          return
+        }
+  
+        let img = image(typst-logo.path, width: 1.5cm)
+        let img-size = measure(img, styles)
+        
+        grid(
+          columns: (img-size.width, 1cm),
+          column-gutter: 16pt,
+          rows: img-size.height,
+          img,
+        )
+      })
+      
+    }),
+    
+    // The main body text.
+    {
+      set par(justify: true)
+      body
+      v(1fr)
+    },
+  
+
+  )
+}
+
+

reports/_extensions/holtzy/lumo/_extension.yml

@@ -0,0 +1,20 @@
+title: Lumo
+author: Holtz Yan
+version: 1.0.0
+quarto-required: ">=1.4.0"
+contributes:
+  formats:
+    html:
+      toc: true
+      code-fold: true
+      code-summary: "Code"
+      toc-location: left
+      toc-title: " "
+      theme: [custom.scss]
+      include-after-body: "footer.html"
+      template-partials:
+        - title-block.html
+      css: style.css
+      smooth-scroll: true
+      code-annotations: hover
+      title-block-banner: true

reports/_extensions/holtzy/lumo/footer.html

@@ -0,0 +1,9 @@
+<div class="footer-container">
+  <hr />
+  <p
+    style="text-align: center; opacity: 0.5; font-size: 15px; max-width: 300px"
+  >
+    This document was made using <code>lumo</code>, a quarto template by
+    <a href="https://www.yan-holtz.com">Yan Holtz</a>.
+  </p>
+</div>

reports/_extensions/holtzy/lumo/particles.json

@@ -0,0 +1,116 @@
+{
+  "particles": {
+    "number": {
+      "value": 80,
+      "density": {
+        "enable": true,
+        "value_area": 800
+      }
+    },
+    "color": {
+      "value": "#888888"
+    },
+    "shape": {
+      "type": "circle",
+      "stroke": {
+        "width": 0,
+        "color": "#000000"
+      },
+      "polygon": {
+        "nb_sides": 5
+      },
+      "image": {
+        "src": "img/github.svg",
+        "width": 100,
+        "height": 100
+      }
+    },
+    "opacity": {
+      "value": 0.5,
+      "random": false,
+      "anim": {
+        "enable": false,
+        "speed": 1,
+        "opacity_min": 0.1,
+        "sync": false
+      }
+    },
+    "size": {
+      "value": 5,
+      "random": true,
+      "anim": {
+        "enable": false,
+        "speed": 40,
+        "size_min": 0.1,
+        "sync": false
+      }
+    },
+    "line_linked": {
+      "enable": true,
+      "distance": 150,
+      "color": "#888888",
+      "opacity": 0.4,
+      "width": 1
+    },
+    "move": {
+      "enable": true,
+      "speed": 3,
+      "direction": "none",
+      "random": false,
+      "straight": false,
+      "out_mode": "out",
+      "attract": {
+        "enable": false,
+        "rotateX": 600,
+        "rotateY": 1200
+      }
+    }
+  },
+  "interactivity": {
+    "detect_on": "canvas",
+    "events": {
+      "onhover": {
+        "enable": true,
+        "mode": "repulse"
+      },
+      "onclick": {
+        "enable": true,
+        "mode": "push"
+      },
+      "resize": true
+    },
+    "modes": {
+      "grab": {
+        "distance": 400,
+        "line_linked": {
+          "opacity": 1
+        }
+      },
+      "bubble": {
+        "distance": 400,
+        "size": 40,
+        "duration": 2,
+        "opacity": 8,
+        "speed": 3
+      },
+      "repulse": {
+        "distance": 200
+      },
+      "push": {
+        "particles_nb": 4
+      },
+      "remove": {
+        "particles_nb": 2
+      }
+    }
+  },
+  "retina_detect": true,
+  "config_demo": {
+    "hide_card": false,
+    "background_color": "#b61924",
+    "background_image": "",
+    "background_position": "50% 50%",
+    "background_repeat": "no-repeat",
+    "background_size": "cover"
+  }
+}

reports/_extensions/holtzy/lumo/style.css

@@ -0,0 +1,158 @@
+body {
+  font-family: "Inter", sans-serif;
+  font-style: normal;
+  font-size: 16px;
+}
+
+/* ------------------------------------------- Titles ----------------- */
+h1 {
+  margin-block-start: 20px;
+  font-size: 2.25rem;
+  font-weight: 800;
+  letter-spacing: -0.02em;
+}
+@media (min-width: 1024px) {
+  h1 {
+    font-size: 3rem;
+  }
+}
+h2 {
+  margin-top: 190px !important;
+  margin-block-start: 20px;
+  border-bottom: 0.1px solid rgb(232, 232, 232);
+  padding-bottom: 0.5rem;
+  font-size: 1.875rem;
+  font-weight: 600;
+  letter-spacing: -0.02em;
+  transition: color 0.2s ease;
+}
+h2:first-of-type {
+  margin-top: 0;
+}
+h3 {
+  margin-top: 2rem;
+  margin-block-start: 20px;
+  font-size: 1.5rem;
+  font-weight: 600;
+  letter-spacing: -0.02em;
+}
+
+/* ------------------------------------------- Text ----------------- */
+p {
+  line-height: 28px;
+}
+p:not(:first-child) {
+  margin-top: 12px;
+}
+a {
+  font-weight: 500;
+  color: var(--primary-color);
+  text-decoration: underline;
+  text-underline-offset: 0.25rem;
+}
+
+/* ------------------------------------------- Lists ----------------- */
+ul {
+  margin: 1.5rem 0;
+  margin-left: 1.5rem;
+  list-style-type: disc;
+}
+ul > li {
+  margin-top: 0.5rem;
+}
+
+/* ------------------------------------------- Buttons used for tabs ----------------- */
+.nav-pills .nav-link {
+  color: var(--primary-color);
+  background-color: white;
+  border-color: var(--primary-color);
+  border-radius: 4px;
+}
+.nav-pills .nav-link.active {
+  color: white;
+  background-color: var(--primary-color);
+}
+.nav-pills .nav-link {
+  padding: 5px;
+  margin-right: 4px;
+}
+ul.nav.nav-tabs {
+  margin: 0px;
+  border: none;
+}
+.tab-content {
+  border: none;
+  margin-top: 10px;
+  padding: 0px;
+}
+
+/* ------------------------------------------- Table of content ----------------- */
+.sidebar nav[role="doc-toc"] ul > li > a.active,
+.sidebar nav[role="doc-toc"] ul > li > ul > li > a.active {
+  border-left: 1px solid var(--primary-color);
+  color: var(--primary-color) !important;
+}
+#TOC {
+  top: 50%;
+  position: relative;
+  transform: translate(0, -50%);
+}
+
+/* ------------------------------------------- Horizontal separator ----------------- */
+hr {
+  margin-top: 23px;
+  margin-bottom: 23px;
+  border: 0;
+  border-top: 1px solid black;
+  width: 0;
+  animation: separator-width 2s ease-in-out forwards;
+}
+@keyframes separator-width {
+  0% {
+    width: 0;
+  }
+  100% {
+    width: 200px;
+  }
+}
+
+/* ------------------------------------------- Footer ----------------- */
+.footer-container {
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+  padding-top: 40px;
+  padding-bottom: 40px;
+}
+
+/* ------------------------------------------- DT table: smaller font ----------------- */
+table.dataTable tbody th,
+table.dataTable tbody td {
+  padding: 6px 10px;
+  font-size: 12px;
+}
+
+/* ------------------------------------------- Callout ----------------- */
+div.callout.callout {
+  border: none;
+  padding: 0.4em 0.7em;
+  border-left: var(--primary-color) 4px solid;
+  background-color: color-mix(in srgb, var(--primary-color), transparent 95%);
+  border-radius: 0px;
+}
+
+button {
+  color: var(--primary-color);
+  background-color: white;
+  border: var(--primary-color) 1px solid;
+  border-radius: 1px;
+}
+
+.grey-section {
+  background-color: #f8f9fa;
+  padding-top: 40px;
+  padding-bottom: 40px;
+  margin-top: 20px;
+  margin-bottom: 20px;
+}

reports/_extensions/holtzy/lumo/title-block.html

@@ -0,0 +1,160 @@
+<style>
+  :root {
+    --primary-color: $primary-color$;
+  }
+  .title-block-content {
+    position: relative;
+    padding-top: 130px;
+    padding-bottom: 130px;
+    max-width: 752px;
+    margin: auto;
+  }
+  .header-keyword {
+    color: rgb(59, 59, 59);
+    opacity: 0.5;
+    font-size: 14;
+  }
+  .octocat-container {
+    fill: var(--primary-color);
+    color: #fff;
+    position: absolute;
+    top: 0;
+    border: 0;
+    right: 0;
+  }
+  #particles-js {
+    position: absolute;
+    top: 0px;
+    left: 0px;
+    width: 100%;
+    height: 100%;
+  }
+</style>
+
+<header id="title-block-header" style="position: relative">
+  <link
+    href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
+    rel="stylesheet"
+  />
+
+  <!-- This is the div in which the particles will be included -->
+  $if(is-particlejs-enabled)$
+  <div id="particles-js"></div>
+  $endif$
+
+  <!-- Actual content on top of the particles-->
+  <div class="title-block-content">
+    <!-- Logo -->
+    $if(logo)$
+    <img
+      src="$logo$"
+      alt="logo of company"
+      height="80px"
+      style="margin-bottom: 20px"
+    />
+    $endif$
+
+    <!-- Title -->
+    $if(title)$
+    <h1 class="title">$title$</h1>
+    $endif$
+
+    <hr />
+
+    <!-- Subtitle -->
+    $if(subtitle)$
+    <p class="subtitle">$subtitle$</p>
+    $endif$
+
+    <!-- Author -->
+    $for(author)$
+    <p class="author"><span class="header-keyword">Author: </span>$author$</p>
+    $endfor$
+
+    <!-- Date -->
+    $if(date)$
+    <p style="margin-top: 0px">
+      <span class="header-keyword">Date: </span>$date$
+    </p>
+    $endif$
+
+    <!-- Particle.js script loaded from a CDN -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/particles.js/2.0.0/particles.min.js"></script>
+
+    <!-- use the particle js library with our own config (json file). -->
+    <script>
+      particlesJS.load(
+        "particles-js",
+        "https://raw.githubusercontent.com/holtzy/lumo/main/_extensions/lumo/particles.json"
+      );
+    </script>
+  </div>
+</header>
+
+<!------------------------- Code for the octocat (github Mascot) that will be included if a link to the github repo is provided. ------------------->
+$if(github-repo)$
+<a
+  href="$github-repo$"
+  class="github-corner"
+  aria-label="View source on GitHub"
+>
+  <svg
+    width="80"
+    height="80"
+    viewBox="0 0 250 250"
+    class="octocat-container"
+    aria-hidden="true"
+  >
+    <path
+      d="M0,0 L115,115 L130,115
+    L142,142 L250,250 L250,0 Z"
+    ></path>
+    <path
+      d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6
+    C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3
+    125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
+      fill="currentColor"
+      style="transform-origin: 130px 106px"
+      class="octo-arm"
+    ></path>
+    <path
+      d="M115.0,115.0 C114.9,115.1 118.7,116.5
+    119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0
+    C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5
+    178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2
+    216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5
+    C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5
+    C139.8,137.7 141.6,141.9 141.8,141.8 Z"
+      fill="currentColor"
+      class="octo-body"
+    ></path>
+  </svg>
+</a>
+<style>
+  .github-corner:hover .octo-arm {
+    animation: octocat-wave 560ms ease-in-out;
+  }
+  @keyframes octocat-wave {
+    0%,
+    100% {
+      transform: rotate(0);
+    }
+    20%,
+    60% {
+      transform: rotate(-25deg);
+    }
+    40%,
+    80% {
+      transform: rotate(10deg);
+    }
+  }
+  @media (max-width: 500px) {
+    .github-corner:hover .octo-arm {
+      animation: none;
+    }
+    .github-corner .octo-arm {
+      animation: octocat-wave 560ms ease-in-out;
+    }
+  }
+</style>
+$endif$