# Lab XX: Lab Report Template # 0.0 Lab Report Requirements First off, this template contains things that should not be modified. Each report you write **must contain** *all and only* these five section headings: 1. Introduction (*no more* than **500** words) 2. Technical Approach (*no more* than **2250** words) 3. Experimental Evaluation (*no more* than **1250** words) 4. Conclusion (*no more* than **500** words) 5. Lessons Learned (**each** student must write one **brief** section) NOTE: Report may not exceed **4500** words, excluding figures You can have any number of subsections off of these in whatever logical order you choose, but these section headings must remain constant. When writing your lab report make sure you remember the following: **Audience:** RSS faculty and staff , hypothetical managers, and professionals in the field (including potential employers). **Purpose:** Demonstrate to faculty that you understand the Lab. Provide detailed technical explanation, justification, and documentation that would be persuasive to a hypothetical manager unfamiliar with the Lab. **Requirements:** - See rubric for content guidance. - Each student must author at least one substantive section and one section of Lessons Learned. (Tech grades will be team-based; CI grades will be individual.) - Label each section with the author’s name. - You may peer review each other’s sections for the purpose of learning from each other. - The Report as a whole should be edited for consistency and clarity - editor's name(s) at the top - editing tasks should be shared over all the Reports. - Submit to github by 1:00 on due date - Submit the markdown file (located in the lab folder with the index.html) - Make sure to render the markdown into html to include it in the index.html for that lab To use this template just write your report here and then run md_make.py to see how it will render. (Note: you will need to copy the resulting html over to the correct files for your website; make sure to exclude the none relevant sections that are used for viewing, i.e. the sections outside the body tags (do not copy over the body tags too.)) If you want to make your report fancier, modify md_mark.py with custom options you can learn more about from here http://www.discoversdk.com/blog/custom-markdown-parsing-with-mistune-and-python. To make a pdf of your markdown, use ``` pandoc lab_template.md -o lab_template.pdf ``` You need to download pandoc to do this. It would be really nice if you could embed the resulting pdf in your website as well so the CI instructors can just reference that for grading. Once again, we expect you to modify the template and template code to make your report stand out from the rest. Style goes a long way when it comes to quality reports. # Table of Contents 1. Introduction (Person who wrote this) 2. Technical Approach 1. Tables (Person 99) 2. Images/Videos (Person 13) 4. Latex (Frank) 3. Experimental Evaluation (Person 7) 4. Conclusion 1. Technical Conclusion (Person 42) 5. Lessons Learned (Person -1) ## 1 Introduction This is my introduction to the template, it is kinda lame so make sure to change it. ## 2 Technical Approach ### 2.1 Tables *Author:* TA 89 Colons can be used to align columns. | Tables | Are | Cool | | ------------- |:-------------:| -----:| | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. Markdown | Less | Pretty --- | --- | --- *Still* | `renders` | **nicely** 1 | 2 | 3 ### 2.2 Images/Videos *Author:* TA 9 Make sure you place images in the right folders for them to actually be rendered in html ![alt text](https://cdn-ssl.s7.disneystore.com/is/image/DisneyShopping/3061105551624-1 "Iron Man") Why is the image so large? Because you have to manual reszie if you use markdown... try using html to include the image like this one | <img src="http://www.storywarren.com/wp-content/uploads/2016/09/space-1.jpg" width="50%"> | |:--:| | This is a caption for our image! Ooo, Ahhh **SPACE** | Look at this https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet ### 2.4 Latex/other *Author:* TA 1 $$ \begin{bmatrix} \lambda&0\\ 0&\lambda \end{bmatrix}=\lambda I $$ This is inline latex $6=\sqrt{42}$ ```json { "6.141": "normal", "16.405": "woke", "no_sleep": "spoke" } ``` ```python { def do_something_productive(): if not_productive: do_work() else: cry() } ``` Try using blockquotes! > Blockquotes are very handy in email to emulate reply text. > This line is part of the same quote. We are don with that now ## 3 Experimental Evaluation *Author:* TA 2 IT WORKED! ## 4 Conclusion *Author:* TA 42 You all will write good labs (using Markdown and html) for us and follow the rules we outlined here ## 5 Lessons Learned *Author:* TA 007 I learned that most of you will read this, some of you will just copy it, and some of you will make your own style. Good luck!