research_project_integration_documentation/template/report.tex

\documentclass[12pt]{article}
%\documentclass[12pt,a4paper]{book} 
\usepackage{setspace}
\usepackage{mathptmx}
\usepackage{graphicx}
\usepackage[a4paper, total={6in, 8in}]{geometry}
\renewcommand{\baselinestretch}{1.5} 
\usepackage{booktabs}
\usepackage{xcolor}
\usepackage{hyperref}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Below codes prepare the coding parts of the document. 
\usepackage{listings}

% Python has been chosen as the coding language
\lstnewenvironment{code}{%
  \lstset{%
    language=Python, % Set the programming language
    basicstyle=\ttfamily\small, % Set the font style and size
    showstringspaces=false, % Don't show spaces in strings
    numbers=left, % Show line numbers on the left
    numberstyle=\tiny\color{gray}, % Set the style for line numbers
    commentstyle=\color{gray}, % Set the style for comments
    keywordstyle=\color{blue}, % Set the style for keywords
    stringstyle=\color{purple}, % Set the style for strings
    breaklines=true, % Allow lines to break if they are too long
    frame=tb % Add a frame around the code
  }%
}{}

% Define a style for displaying file names
%% I haven't used the \lstinline[style=filename]|filename.txt| for showing file names but I put it here as an example.
\lstdefinestyle{filename}{
    basicstyle=\ttfamily\small,
    frame=none,
    backgroundcolor=\color{gray!10},
    rulecolor=\color{black},
    aboveskip=1ex,
    belowskip=1ex,
    showstringspaces=false,
    keywordstyle=\color{black},
    commentstyle=\color{black},
    stringstyle=\color{black},
    breaklines=true,
    breakatwhitespace=true,
    captionpos=b,
    keepspaces=true,
    numbers=none
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage{caption}
\usepackage{longtable}
\usepackage{siunitx}
\usepackage{float}
\author{Alireza Adli}
\usepackage{hyperref}
\newenvironment{riz}{\fontfamily{riz}\fontsize{0.3cm}{0.3cm}\selectfont}{\par}
\hypersetup{
    colorlinks,
    citecolor=black,
    filecolor=black,
    linkcolor=black,
    urlcolor=black
}



\begin{document}
\begin{titlepage} 

% Insert university logo in top-left corner
\begin{picture}(0,0)
\put(-70, 35){\includegraphics[width=8cm]{images/concordia.png}}
\end{picture}

\vspace{2cm}

\begin{picture}(0,0)
\put(30, -1){\fontsize{12}{18}\selectfont Urban Simulation Platform Projects}
\end{picture}

%
% Title
\begin{center}
    \textbf{\fontsize{22}{18}\selectfont [Title of the Research Project]} \\
    \vspace{0.5cm}
\end{center}

\vspace{2cm}

%\begin{picture}(0,0)
%\put(30, -2){\fontsize{12}{18}\selectfont Written by:\hspace{0.6cm} Alireza Adli}
%\end{picture}

% You can change the \hspace value to align the names vertically
\vspace{4cm}
\fontsize{12}{18}\selectfont Student/Researcher: \hspace{0.01cm} [name]

\begin{picture}(0,0)
\put(-1, -2){\fontsize{12}{18}\selectfont  Supervisor: \hspace{1.25cm} [name]}
\end{picture}

\begin{picture}(0,0)
\put(-1, -2){\fontsize{12}{18}\selectfont Project Integrator: \hspace{0.04cm} [name]}
\end{picture}


%\begin{picture}(0,0)
%\put(-1, -2){\fontsize{12}{18}\selectfont Supervisors: Professor Ursula Eicker}
%\end{picture}


\vfill

\begin{picture}(0,0)
\put(-20,-2){\fontsize{12}{18}\selectfont  Next-Generation Cities Institute (NGCI)}
\put(330,-2){\fontsize{12}{18}\selectfont [date]}
\end{picture}



\end{titlepage}
\newpage

\newpage
This project is a part of The NGCI's Urban Simulation Platform project. The platform has integrated the application of NGCI's research projects in Python programming language. These projects are developed by graduate students and researchers of the institute towards urban sustainable development in six main areas: energy systems, building, transportation, vegetation, waste and recycling, liveability. \\
The integration of a project refers to further development of a research project in Object Oriented Programming (OOP) paradigm following the coding style of the platform. This is done in order to employ multiple projects in a single workflow. 
\vspace{15\baselineskip} 

\begin{riz}\noindent
For more information about this piece of software and documentation, contact [Name of the integrator] (\href{mailto:[actual email address}{\textcolor{blue}{what you want to show as the email address}}) 
For detailed technical information of the project read [Researcher's name] [degree]'s thesis report on the same subject [code for the link to the research paper/report: (\href{[the link]}{\textcolor{blue}{what you want to show as the link's title}})].
\end{riz}

\newpage
\tableofcontents
\newpage
\section{Model Description}
\hspace{0.9cm} Here is what can be covered in the section:
%(I recommend starting each section with a horizontal space of 0.9 cm, as demonstrated in the code.)

\begin{itemize}
  \item A brief overview of what problem(s) the model is trying to solve.
  \item The methodologies or algorithms used.
\end{itemize}


\section{The Project Structure}
\hspace{0.9cm} Provide a general description of the software integration project.  

\subsection{ClassName1}
Subsection titling the names of classes/coding files if you would like to provide more details.

In the \LaTeX file of this document, please locate the code for inserting programming snippets, as demonstrated below:

\begin{code}
import math
def circle_square(radius):
  return math.pi * radius ** 2
print(circle_square(3))
\end{code}

(Select the programming language and configure color settings from lines 17-30 of the \LaTeX file for this document).


\subsection{ClassName2}
Include an example of instantiating the class for clarity.

\subsection{ClassWorkflow}
You can also include links to the GitTea or other repositories of the research project.


\section{3rd Party Software}
%\hspace{0.9cm} 
\begin{itemize}
  \item A list and brief description of any 3rd party software your model uses (EG SUMO or Energy Plus)
  \item Any licence requirements
  \item Link to where to find the software
\end{itemize}

\section{Input Data}
\hspace{0.9cm} Table samples can be found in the \href{https://nextgenerations-cities.encs.concordia.ca/gitea/a_adli/research_project_integration_documentation/src/branch/main/example}{\textcolor{blue}{example}} project (Microbial Systems). The code includes units for easier copy/pasting ;-)
 
\begin{itemize}
\item A list and description of all the types of data needed as inputs to the model.
\item Information on what format each type of data needs to be in.
\item Description of any pre-processing that needs to be applied to the data
\item Any other information that someone would need if they were trying to source their own dataset for your model.
\item Links to any use-case or test data that you have.
\item Information on where to source any of the data.
\end{itemize}


\section{Constants}
%\hspace{0.9cm}
\begin{itemize}
\item Any fixed values built into your model plus rationale for why you have chosen them.
\item Any other assumptions made by your model that are not apparent from the input data or constants in the code.
\end{itemize}



\section{Output Data}
%\hspace{0.9cm}
\begin{itemize}
\item A list and description of all the types of data that are output by the model.
\item Information on the format of each type of output data.
\item Links to any use-case or test output data that you have.
\end{itemize}


\section{Limitations}
%\hspace{0.9cm}
\begin{itemize}
\item Brief description of any constraints on how the model may be used.
\begin{itemize}
\item For example, it may only be valid in certain climatic conditions.
\item For example, it might require a minimum sized input data set to be statistically meaningful
\end{itemize}
\end{itemize}


\section{Technical Performance}
%\hspace{0.9cm}
\begin{itemize}
\item Any notes relating to things like:
\begin{itemize}
\item The time taken for the model to run on large data sets (eg takes over 100 hours to process 10 small family dwellings)
\item Any very large runtime memory requirements
\item Any very large output data files.
\end{itemize}
\end{itemize}

\section{More sections...}
\hspace{0.9cm} Feel free to add new sections that you feel are missing or specific to your project.


\end{document}