Start technical solution

Author: mcttn22

project-report/project-report.pdf

@@ -14,7 +14,7 @@ \subsection{Introduction}
     \item The program will support multiple platforms to run on, including Windows and Linux.
     \item The program will use python3 as its main programming language.
     \item I will take an object-orientated approach to the project.
-    \item I will give an option to use either a Graphics Card or a CPU to train the Artificial Neural Networks.
+    \item I will give an option to use either a Graphics Card or a CPU to train and test the Artificial Neural Networks.
 \end{itemize}
 
 I will also be using SysML for designing the following diagrams.
@@ -130,4 +130,16 @@ \subsection{Hardware Design}
 To allow for faster training of an Artificial Neural Network, I will give the option to use a Graphics Card to train the Artificial Neural Network if available. 
 I will also give the option to load pretrained weights to run on less computationaly powerfull hardware using just the CPU as standard.
 
+\subsection{Workflow and source control}
+
+I will use Git along with GitHub to manage my workflow and source control as I develop the project, by utilising the following features:
+
+\begin{itemize}
+    \item Commits and branches for adding features and fixing bugs seperately.
+    \item Using GitHub to back up the project as a repository.
+    \item I will setup automated testing on GitHub after each pushed commit.
+    \item I will also provide the necessary instructions and information for the installation and usage of this project, aswell as creating releases of the project 
+          with new patches.
+\end{itemize}
+
 \end{document}

project-report/src/images/readme-bottom.png

@@ -3,13 +3,20 @@
 \usepackage{hyperref}
 \usepackage[cache=false]{minted}
 \usepackage{subfiles}
+\usepackage{verbatim}
 \hypersetup{
   colorlinks,
   citecolor=black,
   filecolor=black,
   linkcolor=black,
   urlcolor=black
 }
+\setminted[markdown]{
+  frame=lines,
+  fontsize=\footnotesize,
+  linenos,
+  breaklines
+}
 \setminted[python]{
   frame=lines,
   fontsize=\footnotesize,
@@ -18,6 +25,11 @@
 \setminted[sql]{
   fontsize=\footnotesize
 }
+\setminted[text]{
+  frame=lines,
+  fontsize=\footnotesize,
+  linenos
+}
 
 \title{Computer Science NEA Report
        \bigbreak

project-report/src/images/readme-middle.png

@@ -6,8 +6,69 @@
 
 \section{Technical Solution TODO}
 
-\subsection{Test}
+\subsection{Setup}
 
-\inputminted[firstline=0,lastline=5]{python}{./school_project/__main__.py}
+\subsubsection{File Structure}
+
+I used the following file structure to organise the code for the project, where school\_project is the package and is constructed of two main modules:
+
+\begin{itemize}
+    \item The models module, which is a self-contained module for creating trained Artificial Neural Network models.
+    \item The frames module, which consists of tkinter frames for the User Interface.
+\end{itemize}
+
+Each module within the school\_project package contains a \_\_init\_\_.py file, which allows the package to be installed to a virtual environment so that the modules of the package 
+can be imported from the installed package. I have omitted the source code for this report, which included a Makefile for its compilation.
+
+\pagebreak
+
+\begin{footnotesize}
+\verbatiminput{|"git ls-tree -r --name-only HEAD | grep -v -E 'project-report/|Makefile' | tree --fromfile --charset=ascii"}  % TODO: Could include project-report and Makefile
+\end{footnotesize}
+
+\subsubsection{Dependencies}
+
+The python dependencies for the project can be installed simply by running the following setup.py file (as described in the README.md in the next section). Instructions on 
+installing external dependencies, such as the CUDA Toolkit for using a GPU, are explained in the README.md in the next section also.
+
+\begin{itemize}
+    \item setup.py code:
+        \inputminted{python}{./setup.py}
+\end{itemize}
+
+\subsubsection{Git and Github files}
+
+To optimise the use of Git and GitHub, I have used the following files:
+
+\begin{itemize}
+    \item A .gitignore file for specifying which files and directories should be ignored by Git:
+        \inputminted{text}{./.gitignore}
+    \item A README.md markdown file to give installation and usage instructions for the repository on GitHub:
+        \begin{itemize}
+            \item Markdown code:
+                \inputminted{markdown}{./README.md}
+            \item Which will generate the following:
+                \pagebreak
+                \begin{figure}[h!]
+                \centering
+                \includegraphics[width=1\textwidth]{./project-report/src/images/readme-top.png}
+                \end{figure}
+                \pagebreak
+                \begin{figure}[h!]
+                \centering
+                \includegraphics[width=1\textwidth]{./project-report/src/images/readme-middle.png}
+                \end{figure}
+                \pagebreak
+                \begin{figure}[h!]
+                \centering
+                \includegraphics[width=1\textwidth]{./project-report/src/images/readme-bottom.png}
+                \end{figure}
+        \end{itemize}
+    \item A LICENSE file that describes how others can use my code.
+\end{itemize}
+
+\subsubsection{Organisation}
+
+I also utilise a TODO.md file for keeping track of what features and/or bugs need to be worked on.
 
 \end{document}