diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5359e54 --- /dev/null +++ b/.gitignore @@ -0,0 +1,226 @@ +## Core latex/pdflatex auxiliary files: +*.aux +*.lof +*.log +*.lot +*.fls +*.out +*.toc +*.fmt +*.fot +*.cb +*.cb2 +.*.lb + +## Intermediate documents: +*.dvi +*.xdv +*-converted-to.* +# these rules might exclude image files for figures etc. +# *.ps +# *.eps +# *.pdf + +## Generated if empty string is given at "Please type another file name for output:" +.pdf + +## Bibliography auxiliary files (bibtex/biblatex/biber): +*.bbl +*.bcf +*.blg +*-blx.aux +*-blx.bib +*.run.xml + +## Build tool auxiliary files: +*.fdb_latexmk +*.synctex +*.synctex(busy) +*.synctex.gz +*.synctex.gz(busy) +*.pdfsync + +## Auxiliary and intermediate files from other packages: +# algorithms +*.alg +*.loa + +# achemso +acs-*.bib + +# amsthm +*.thm + +# beamer +*.nav +*.pre +*.snm +*.vrb + +# changes +*.soc + +# cprotect +*.cpt + +# elsarticle (documentclass of Elsevier journals) +*.spl + +# endnotes +*.ent + +# fixme +*.lox + +# feynmf/feynmp +*.mf +*.mp +*.t[1-9] +*.t[1-9][0-9] +*.tfm + +#(r)(e)ledmac/(r)(e)ledpar +*.end +*.?end +*.[1-9] +*.[1-9][0-9] +*.[1-9][0-9][0-9] +*.[1-9]R +*.[1-9][0-9]R +*.[1-9][0-9][0-9]R +*.eledsec[1-9] +*.eledsec[1-9]R +*.eledsec[1-9][0-9] +*.eledsec[1-9][0-9]R +*.eledsec[1-9][0-9][0-9] +*.eledsec[1-9][0-9][0-9]R + +# glossaries +*.acn +*.acr +*.glg +*.glo +*.gls +*.glsdefs + +# gnuplottex +*-gnuplottex-* + +# gregoriotex +*.gaux +*.gtex + +# hyperref +*.brf + +# knitr +*-concordance.tex +# TODO Comment the next line if you want to keep your tikz graphics files +*.tikz +*-tikzDictionary + +# listings +*.lol + +# makeidx +*.idx +*.ilg +*.ind +*.ist + +# minitoc +*.maf +*.mlf +*.mlt +*.mtc[0-9]* +*.slf[0-9]* +*.slt[0-9]* +*.stc[0-9]* + +# minted +_minted* +*.pyg + +# morewrites +*.mw + +# nomencl +*.nlo + +# pax +*.pax + +# pdfpcnotes +*.pdfpc + +# sagetex +*.sagetex.sage +*.sagetex.py +*.sagetex.scmd + +# scrwfile +*.wrt + +# sympy +*.sout +*.sympy +sympy-plots-for-*.tex/ + +# pdfcomment +*.upa +*.upb + +# pythontex +*.pytxcode +pythontex-files-*/ + +# thmtools +*.loe + +# TikZ & PGF +*.dpth +*.md5 +*.auxlock + +# todonotes +*.tdo + +# easy-todo +*.lod + +# xindy +*.xdy + +# xypic precompiled matrices +*.xyc + +# endfloat +*.ttt +*.fff + +# Latexian +TSWLatexianTemp* + +## Editors: +# WinEdt +*.bak +*.sav + +# Texpad +.texpadtmp + +# Kile +*.backup + +# KBibTeX +*~[0-9]* + +# auto folder when using emacs and auctex +./auto/* +*.el + +# expex forward references with \gathertags +*-tags.tex + +# standalone packages +*.sta diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/bibliography.bib b/bibliography.bib new file mode 100644 index 0000000..53d74a0 --- /dev/null +++ b/bibliography.bib @@ -0,0 +1,13 @@ +@Article{art1, + author = "Author Name", + title = "Book Title", + journal = "Lecture Notes in Autonomous System", + volume = "1001", + publisher = "UFO", + pages = "900--921", + year = "2003", + coden = "LNCSD9", + ISSN = "0302-2345", + bibdate = "Sat Dec 7 10:05:42 MST 2003", +} + diff --git a/images/Logo-HBRS-cyan.png b/images/Logo-HBRS-cyan.png new file mode 100644 index 0000000..dc61573 Binary files /dev/null and b/images/Logo-HBRS-cyan.png differ diff --git a/mas_proposal.cls b/mas_proposal.cls new file mode 100644 index 0000000..db83e76 --- /dev/null +++ b/mas_proposal.cls @@ -0,0 +1,220 @@ +% +% LaTeX2e Style for MAS R&D and master thesis reports +% Author: Argentina Ortega Sainz, Hochschule Bonn-Rhein-Sieg, Germany +% Please feel free to send issues, suggestions or pull requests to: +% https://github.com/mas-group/report-template +% Based on the template created by Ronni Hartanto in 2003 +% + +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{mas_report}[2018/01/25 The MAS report class] + +% \newcommand{\test}{Project test!} +\RequirePackage{xcolor} +\RequirePackage{ifthen} +\definecolor{slcolor}{HTML}{882B21} +\newcommand*{\project}[1]{\gdef\@project{#1}% +} +\newcommand*{\@project}{\texttt{project} not set. Please select Master Thesis or R\&D Project} + + +% Options +\DeclareOption{onecolumn}{\OptionNotUsed} +\DeclareOption{thesis}{\project{Master Thesis Proposal}} +\DeclareOption{rnd}{\project{R\&D Project Proposal}} + +% Report options +% \DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}} + +% Execute the default option +\ExecuteOptions{thesis} + +% Process other options +\ProcessOptions\relax + +% Load class options +\LoadClass[10pt,a4paper, oneside]{book} + +\renewcommand{\sfdefault}{phv} +\renewcommand{\familydefault}{\sfdefault} + +%------------------------------------------------------------------------------- +% VARIOUS REQUIRED PACKAGES AND CONFIGURATIONS +%------------------------------------------------------------------------------- + +\usepackage[numbers]{natbib}\citeindextrue % Round brackets around citations, change to square for square brackets +\usepackage{graphicx} % Required to include images +\usepackage{amsmath,amssymb,theorem} % Math packages +\usepackage{listings} % Required for including snippets of code +\usepackage{booktabs} % Required for better horizontal rules in tables +% \usepackage{xspace} % Provides the ability to use an intelligent space which is used in \institution and \department +% \usepackage[printonlyused,withpage]{acronym} % Include a list of acronyms +% \usepackage[acronym, toc]{glossaries}%Better package for acronyms +% \usepackage{rotating} % Allows tables and figures to be rotated +% \usepackage[xetex]{hyperref} % Required for links and changing link options +\usepackage{microtype} % Slightly tweak font spacing for aesthetics +% \usepackage{algorithm} +% \usepackage[noend]{algpseudocode} +% \usepackage{caption} +% %\captionsetup{belowskip=6pt,aboveskip=6pt} +% \usepackage{footnote} +% % \usepackage{minipage-marginpar} +% \makesavenoteenv{tabular} +% \makesavenoteenv{table} +% \usepackage[flushleft]{threeparttable} +% % \usepackage{subcaption} +% \usepackage[section]{placeins} +% \usepackage{lastpage} +% \usepackage[small, md, sc]{titlesec} +%\usepackage{inputenc} +% \usepackage{geometry} +% %\usepackage{tocloft} +% \usepackage{adjustbox} % to limit size of tables +% \usepackage{pbox} +\usepackage[titletoc]{appendix} +% \usepackage{colortbl} % for color lines in tables +% \usepackage{rotfloat} +% \usepackage[page,toc,titletoc,title]{appendix} % Add appendices +% \usepackage{tocloft} % Add the word appendix to the TOC + +\usepackage{lipsum} % Used to test + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Fonts +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Definitions +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\renewcommand\bibname{References} %Change Bibliography to References + + +\newcommand*{\supervisors}[1]{\gdef\@supervisors{#1}% +} +\newcommand*{\@supervisors}{\texttt{\string\supervisors} currently +not set. Please fix this.} + +% Colors +\definecolor{hbrs}{RGB}{11,161,226} + +\definecolor{keywords}{RGB}{0,100,0} +\definecolor{comments}{RGB}{0,100,50} +\definecolor{stringred}{RGB}{160,0,0} +\definecolor{codeblue}{RGB}{0,0,150} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Title page +%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\renewcommand*{\maketitle}{% +\begin{titlepage} +{\raggedleft% + \centering + \includegraphics[width=8cm]{images/Logo-HBRS-cyan.png}\par +}\vspace{1cm} + \centering + +\vspace{1.5cm} +{\Large\@project\unskip\strut\par} +\vspace{1.5cm} +{\huge\bfseries\@title\unskip\strut\par} +\vspace{2cm} +{\Large\itshape\@author\unskip\strut\par} +\vfill + + +Supervised by\par +\vskip 8pt +{\large +\@supervisors\unskip\strut\par +}% \ifcsname @supervisors\endcsname +% \\ \@supervisors \fi \\ +% \vfill + +\vfill + +{\large \@date\par} +\end{titlepage} +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% PAGE LAYOUT +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% SIDE MARGINS: +\oddsidemargin 28pt % Left margin on odd-numbered pages. +\evensidemargin 0pt % Left margin on even-numbered pages. +\marginparwidth 40pt % Width of marginal notes. + +\marginparsep 12pt % Horizontal space between outer margin and + % marginal note +\textwidth 15cm % width of text + +% VERTICAL SPACING: + % Top of page: +\topmargin 10pt % distance from top of page to running head +\headheight 14pt % Height of box containing running head. +\headsep 1cm % Space between running head and text. +\textheight 8.8in % space for text +\footskip 30pt % Distance from baseline of box containing foot + % to baseline of last line of text. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Header and footer +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\RequirePackage{titlesec} +\let\footruleskip\undefined +\usepackage{fancyhdr}% http://ctan.org/pkg/fancyhdr + +%% Page style for title pages. +\fancypagestyle{plain}{% + \fancyhf{} + \renewcommand*\headrulewidth{0pt} + \renewcommand*\footrulewidth{0pt} + \fancyfoot[L]{\@author} + \fancyhead[C]{\@title} + \fancyfoot[C]{\thepage} + \fancyfoot[R]{\@project} +} + +%% Fancy style for the main matter. +% \fancypagestyle{mainmatter}{% +% \fancyhf{} +% \renewcommand*\headrulewidth{0.5pt} +% %% Page numbers on the top left and top right. +% \fancyfoot[C]{\thepage} +% %% Chapter name on the left (even) page. +% \fancyhead[RE]{\nouppercase{\rightmark}} +% %% Section name on the right (odd) page. +% \fancyhead[LO]{\nouppercase{\leftmark}} +% } + +%% The mainmatter style is default for normal pages. +%\pagestyle{mainmatter} + +%% Print the current chapter and section at the top of the page in cyan. +% \renewcommand*\chaptermark[1]{\markboth{\textcolor{hbrs} {\thechapter.\ } #1}{}} +% \renewcommand*\sectionmark[1]{\markright{\textcolor{hbrs}{\thesection.\ } #1}} + +%% Chapter titles have the same layout as parts. +\titleformat{\chapter} + [display] + {\flushleft}%format + {}%label + {0pt}%sep + {\huge\thechapter.~}%before code + % [\vspace{-1cm}] + +\titlespacing{\chapter}{0pt}{-50pt}{10pt} + + +\titleformat{\section} + [display] + {\flushleft}%format + {}%label + {0pt}%sep + {\Large\thesection.~}%before code + + + +\endinput diff --git a/proposal.pdf b/proposal.pdf new file mode 100644 index 0000000..d78962e Binary files /dev/null and b/proposal.pdf differ diff --git a/proposal.tex b/proposal.tex new file mode 100644 index 0000000..4d7f14e --- /dev/null +++ b/proposal.tex @@ -0,0 +1,102 @@ +\documentclass[rnd]{mas_proposal} +% \documentclass[thesis]{mas_proposal} + +\usepackage[utf8]{inputenc} +\usepackage{amsmath} +\usepackage{amsfonts} +\usepackage{amssymb} +\usepackage{graphicx} + +\title{Project Proposal Title} +\author{FirstName LastName} +\supervisors{First} + +\begin{document} + +\maketitle + +\pagestyle{plain} + +\chapter{Introduction} +\begin{itemize} + \item An introduction to the general topic you are covering. + \item Why is it important? +\end{itemize} + +\section{Problem Statement} +\begin{itemize} + \item What are you going to solve? + \item How are you evaluating? +\end{itemize} + + +\chapter{Related Work} +\begin{itemize} + \item What have other people done? + \item Why is it not sufficient? +\end{itemize} + +\section{Section 1} +\section{Section 2} + + + +\chapter{Project Plan} + +\section{Work Packages} +The bare minimum will include the following packages: +\begin{enumerate} + \item[WP1] Literature Search + \item[WP2] Experiments + \item[WP3] Project Report +\end{enumerate} +Keep in mind that depending on your project, you will probably need to add work packages that are more suited to your projects. + +\section{Milestones} +\begin{enumerate} + \item[M1] Literature search + \item[M2] Experimental setup + \item[M3] Experimental Analysis + \item[M4] Report submission +\end{enumerate} + +\section{Project Schedule} +Include a gantt chart here. It doesn't have to be detailed, but it should include the milestones you mentioned above. +Make sure to include the writing of your report throughout the whole project, not just at the end. + +\begin{figure}[h!] + \includegraphics[width=\textwidth]{rnd_deliverable_timeline} + \caption{} + \label{} +\end{figure} + +\section{Deliverables} +\subsection{Minimum Viable} + +\begin{itemize} + \item Survey + \item Analysis of state of the art + \item Simple simulated use case + \item Demo on youBot or Jenny +\end{itemize} + +\subsection{Expected} +\begin{itemize} + \item Comparation of approaches in the robot +\end{itemize} + +\subsection{Desired} +\begin{itemize} + \item Integration to scenario +\end{itemize} + + +\nocite{*} + +\bibliographystyle{plainnat} % Use the plainnat bibliography style +\bibliography{bibliography.bib} % Use the bibliography.bib file as the source of references + + + + +\end{document} diff --git a/rnd_deliverable_timeline.png b/rnd_deliverable_timeline.png new file mode 100644 index 0000000..6f5d1d3 Binary files /dev/null and b/rnd_deliverable_timeline.png differ