IN.1010, IN.0111, IN.0114, IN.1910, IN.0300

IN.1010, IN.0111, IN.0114, IN.1910, IN.0300 Robotics ProjectTechnical ReportingSession 9 - 12 November 2013 Prof. B. Hirsbrunner (beat.hirsbrunner@unifr.ch)Thomas Rouvinez (thomas.rouvinez@unifr.ch)

Today • Discussion of delivrables for the robotics project • Introduction to technical reporting • Introduction to LaTeX and related tools for scientific and technical reporting • Preparing a project presentation • Creating a demo video • Todo's

Presentation • Each person of the group has to choose a specific problem they have solved in their implementation. The presentation will be structured as follows: • Problem description • Description of the solutionEach person has 5 minutes, this means 10 minutes per group • Video snippets are possible, but don’t show the complete video in the presentation

Deadlines for Robotics Project • Tue 14 January, 18h00: Upload of project report, slides, and video to www.diuf.unifr.ch/pai/pr1 • Tue 21 January, 8h15-12h00: Project Presentations (room number will be communicated on www.diuf.unifr.ch/pai/pr1)

Final Assignment • In exercise 6 we asked you to write the code for the final assignment in the simulation • For this assignment you have to implement the code of exercise 6 in the physical arena

Guidelines for Writing a Technical Report

Purpose of Technical Reports • Transfer author's knowledge • Description of concepts, methods, and technologies that were used • Description of the implementation

Technical Report Characteristics (1) • Informative and objective style • Precision • One word for one concept, avoid synonyms and variations even if you have to repeat it • Solutions must be comprehensible • Start with the big picture first, before describing implementation details

Technical Report Characteristics (2) • References to external sources must be complete • Respect intellectual property and the work of researchers • If you use someone else's content, cite the source • Example reference: • [1] Amershi, Saleema, Morris, Meredith Ringel, Moraveji, Neema, Balakrishnan, Ravin & Toyama, Kentaro (2010). Multiple Mouse Text Entry for Single-Display Groupware (Proceedings of the 2010 ACM conference on Computer supported cooperative work). Savannah, Georgia, USA: ACM.

Structureof Technical Reports • Title, name(s) and affiliation(s) of author(s) • Abstract • Introduction • Problem Statement • Description of the Solution • Validation • Conclusion • References • Appendix (e.g. code of implementation)

Abstract • A brief description of the content of a report (5-10 lines) • Allows people to decide if the text is relevant for them or not • Summarizes the most important features of a report • The abstract is usually writen after the report has been completed

Introduction • Context • Describe the objects: e-pucks, physical arena, simulation, capabilities etc. • Objectives • Objectives of the robotics project • Brief description of the approach • Short description of the final assignment • Organisation of the document • „In section 2, we will discuss... Section 3 will show...“

Problem Statement • Description of the e-puck behaviours which are required for the final assignment • What capabilities (e.g. sensors, camera) do you need to implement the final assignment?

Description of the solution • How did you solve the problems that you described in the problem statement? • Description of the strategy chosen, then description of the implementation • Explanation of the code written (use code snippets to illustrate the implementation, but put only the relevant portion of codes)

Validation • How is your solution different from a perfect solution? Why is it different? What problems did you encounter? What would a perfect solution look like? • Under which condition have you tested the solution?

Conclusion • Short summary and synthesis of the paper • What could be done in the future to improve your solution

References • List of papers, websites, and documents used throughout the report • Very important • No plagiarism!

Appendix • Screenshots and pictures explaining specific situations • Important parts of implementation code

Introduction to Latex

Tools for Technical Reporting • LATEX is a de-facto standard for scientific publications and technical reports.

Why Latex and not Word? • Word is a WYSIWYG program, fine for short simple documents. It's intuitive and easy to learn • Latex is a powerful mark-up language that provides tools to edit large documents and scientific papers or books.

Making PDF documents with Latex 1. 1. Editor with .tex document 2. Compiling the .tex file 3. Generated .pdf document 2. 3.

Latex Distribution • It’s up to you on which system you want to write your Latex code. Some suggestions: • Windows • MiKTeX • Linux (Ubuntu) • TeX Live • Mac • MacTeX

Hands-On: Hello World • Type the following code, compile and observe the results: \documentclass[a4paper]{article} \begin{document} This document is fairly short\footnote{however it contains a footnote} We call: \begin{center}\textbf{Hello World!}\end{center} \end{document}

Discussion of Hello World • Type the following code, compile and observe the results: \documentclass[a4paper]{article} \begin{document} …CONTENT is placed within the document tags \end{document}

Using Accents in Latex • German: • \“o for ö • \"U for Ü • French: • \`e for è • \'e for é • Packages exist to help : \usepackage[latin1]{inputenc}

Sections and Subsections • In Latex, you can create sections and subsections (similar to Word) like this: \section{Title 1} Text \subsection{Title 2} Text \subsubsection{Title 3} Text \paragraph{paragraphe 1} etc.

Guide • Good guide/introduction to Latex: • http://www.ctan.org/starter.html • The bible : • http://en.wikibooks.org/wiki/LaTeX

Preparing a Project Presentation • Use Powerpoint, Latex or OpenOffice Impress to create slides • Use bullet points and keywords instead of long texts • Illustrate concepts with images • Add a title and slide numbers to each slide

Creating a Demo Video • Set up the camera in a stable position • There will be a tripod in the lab • Don't use the zoom or follow the robots around with the camera • Create a video of max. 60 seconds and cut out or accelerate unnecessary scenes • Free video editors: OpenShot (Ubuntu), iMovie (OS X), MovieMaker (Windows)

Todo's (1) • For next week, we ask each person to create a Latex .tex file for you technical report (use the provided template at diuf.unifr.ch/pai/pr1 > Exercises) • It should contain the structure of the report: Create all section and subsection headings with a brief description of what you want to write in this section • Write the text of the introduction and the problem statement • Upload the .pdf file to www.diuf.unifr.ch/pai/pr1 until Monday at 14h00 • You can have a look at the sample report on diuf.unifr.ch/pai/pr1 > Miscellaneous for inspiration (note that the code excerpts are badly formatted)

Todo's (2) • You have another full week to improve your solution for exercise 6 (simulation) • Reserve time slots to implement the challenge solution in the physical arena

Please Note • This is our last lecture • From now on you will work on the project individually • You will receive a feedback for the first part of your report (structure, introduction, problem statement) next week on moodle • If you have any questions, I will be available every Tuesday morning from 8h00 to 10h00 in the class room and Friday from 11h00 to 13h00 in the physical arena's room

Thank you for your attention

IN.1010, IN.0111, IN.0114, IN.1910, IN.0300