Merge pull request #181 from CooperUnion/user/jacobkoziej/igvc-report…

…-setup IGVC Report Setup
CooperUnion · Apr 12, 2024 · dbf3f70 · dbf3f70
2 parents 6ae379c + d120d27
commit dbf3f70
Show file tree

Hide file tree

Showing 23 changed files with 458 additions and 267 deletions.
diff --git a/.latexindent.yaml b/.latexindent.yaml
@@ -0,0 +1,10 @@
+---
+
+defaultIndent: '  '
+removeTrailingWhitespace: 1
+
+modifyLineBreaks:
+  preserveBlankLines: 1
+  condenseMultipleBlankLinesInto: 1
+  textWrapOptions:
+    columns: 72
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,10 +17,20 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.2.0
+    rev: 24.3.0
     hooks:
       - id: black
 
+  - repo: https://github.com/cmhughes/latexindent.pl.git
+    rev: V3.23.6
+    hooks:
+      - id: latexindent
+        args:
+          - --local
+          - --modifylinebreaks
+          - --overwrite
+          - --silent
+
   - repo: https://github.com/pre-commit/mirrors-clang-format
     rev: v18.1.1
     hooks:
@@ -42,7 +52,7 @@ repos:
       - id: nixpkgs-fmt
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.2
+    rev: v0.3.5
     hooks:
       - id: ruff
 

diff --git a/SConstruct.py b/SConstruct.py
@@ -4,7 +4,7 @@
 
 import env as uenv
 
-EnsureSConsVersion(4, 6, 0)
+EnsureSConsVersion(4, 7, 0)
 EnsurePythonVersion(3, 12)
 
 
@@ -48,6 +48,7 @@
         'EspIdf',
         'OpenCan',
         'Phony',
+        'Project',
     ],
 )
 env.AppendUnique(
@@ -59,6 +60,13 @@
         '-std=gnu17',
     ]
 )
+env.AppendUnique(
+    PDFLATEXFLAGS=[
+        '--halt-on-error',
+        '--shell-escape',
+    ]
+)
+env.Replace(PDFLATEX='lualatex')
 
 if not env['VERBOSE']:
     commands = [
@@ -97,3 +105,7 @@
     variant_dir=f'{build}/dbw/ember_bl',
     duplicate=False,
 )
+projects = env.SConscript(
+    'projects/SConscript.py',
+    variant_dir=f'{build}/projects',
+)
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -39,6 +39,7 @@
             pkgs.mdbook
             pkgs.ninja
             pkgs.nixpkgs-fmt
+            pkgs.texliveFull
             pkgs.zlib
             python
             pythonPackages.invoke

diff --git a/projects/SConscript.py b/projects/SConscript.py
@@ -0,0 +1,16 @@
+# ruff: noqa: F821
+
+Import('env')
+
+
+projects = env.SConscript(
+    [
+        f'{project}/SConscript.py'
+        for project in [
+            'g-wagon',
+        ]
+    ]
+)
+
+
+Return('projects')
diff --git a/projects/g-wagon/SConscript.py b/projects/g-wagon/SConscript.py
@@ -0,0 +1,12 @@
+# ruff: noqa: F821
+
+Import('env')
+
+
+igvc_report = env.SConscript('igvc-report/SConscript.py')
+
+project, name = env.Project(env.Dir('.'), env.File('project.toml'))
+env.ProjectSubtarget(name, 'igvc-report', igvc_report)
+
+
+Return('project')
diff --git a/projects/g-wagon/igvc-report/SConscript.py b/projects/g-wagon/igvc-report/SConscript.py
@@ -0,0 +1,9 @@
+# ruff: noqa: F821
+
+Import('env')
+
+
+igvc_report = env.PDF('igvc-report.tex')
+
+
+Return('igvc_report')
diff --git a/projects/g-wagon/igvc-report/abstract.tex b/projects/g-wagon/igvc-report/abstract.tex
@@ -0,0 +1,2 @@
+\begin{abstract}
+\end{abstract}
diff --git a/projects/g-wagon/igvc-report/background.tex b/projects/g-wagon/igvc-report/background.tex
@@ -0,0 +1 @@
+\section{Background}
diff --git a/projects/g-wagon/igvc-report/cyber-security.tex b/projects/g-wagon/igvc-report/cyber-security.tex
@@ -0,0 +1 @@
+\section{Cyber Security}
diff --git a/projects/g-wagon/igvc-report/design.tex b/projects/g-wagon/igvc-report/design.tex
@@ -0,0 +1,7 @@
+\section{Design}
+
+\subsection{Mechanical}
+
+\subsection{Electrical}
+
+\subsection{Software}
diff --git a/projects/g-wagon/igvc-report/igvc-report.tex b/projects/g-wagon/igvc-report/igvc-report.tex
@@ -0,0 +1,16 @@
+% <https://journals.aas.org/aastexguide/>
+\documentclass[linenumbers]{aastex631}
+
+\input{preamble}
+
+\begin{document}
+\include{title}
+\include{abstract}
+\include{background}
+\include{system-architecture}
+\include{innovations}
+\include{design}
+\include{cyber-security}
+\include{system-analysis}
+\include{unit-tests}
+\end{document}
diff --git a/projects/g-wagon/igvc-report/innovations.tex b/projects/g-wagon/igvc-report/innovations.tex
@@ -0,0 +1 @@
+\section{Innovations}
diff --git a/projects/g-wagon/igvc-report/preamble.tex b/projects/g-wagon/igvc-report/preamble.tex
@@ -0,0 +1,26 @@
+\usepackage{graphicx}
+
+\usepackage{hyperref}
+\hypersetup{
+  hidelinks,
+  pdfinfo = {
+      Title    = IGVC Design Report,
+      Author   = The Cooper Union for the Advancement of Science and Art,
+      Subject  = Autonomous Vehicles,
+      Keywords = {IGVC},
+    },
+}
+\usepackage{csquotes}
+\usepackage{bookmark}
+
+\journalinfo{\emph{\enquote{It had to be done}}}
+
+\NewDocumentCommand{\member}{mm}{
+  \author{#1 \href{mailto:#[email protected]}{\texttt{<#[email protected]>}}}
+  \affiliation{The Cooper Union for the Advancement of Science and Art}
+}
+\NewDocumentCommand{\memberSpecial}{mmm}{
+  \author{#1 \href{mailto:#[email protected]}{\texttt{<#[email protected]>}}}
+  \altaffiliation{#3}
+  \affiliation{The Cooper Union for the Advancement of Science and Art}
+}
diff --git a/projects/g-wagon/igvc-report/system-analysis.tex b/projects/g-wagon/igvc-report/system-analysis.tex
@@ -0,0 +1 @@
+\section{System Analysis}
diff --git a/projects/g-wagon/igvc-report/system-architecture.tex b/projects/g-wagon/igvc-report/system-architecture.tex
@@ -0,0 +1 @@
+\section{System Architecture}
diff --git a/projects/g-wagon/igvc-report/title.tex b/projects/g-wagon/igvc-report/title.tex
@@ -0,0 +1,11 @@
+\belowpdfbookmark{IGVC Design Report}{title}
+\title{
+  IGVC Design Report --- The \enquote{g-wagon}
+}
+
+\memberSpecial{Jacob Koziej}{jacob.koziej}{Team Captain}
+
+\member{Jeannette Circe}{circe}
+\member{Ridwan Hussain}{ridwan.hussain}
+
+\memberSpecial{Michael Giglia}{michael.giglia}{Faculty Advisor}
diff --git a/projects/g-wagon/igvc-report/unit-tests.tex b/projects/g-wagon/igvc-report/unit-tests.tex
@@ -0,0 +1 @@
+\section{Unit Tests}
diff --git a/projects/g-wagon/project.toml b/projects/g-wagon/project.toml
@@ -0,0 +1,2 @@
+[metadata]
+name = 'g-wagon'