Checklist
- Prepare for a successful demonstration of your final project on Friday December 13 at 1:30pm in the lab
- Your project github, moved to the campusrover organization
- Each teammate adds one FAQ to the Lab Notebook
- Your project report has been added to the Lab Notebook
- A max 5 minute video, with teammates narrating, mostly a tour of the code but also including sections of demo
Dates
Tuesday Deccember 10, 11:55pm
- Teammate FAQ’s have been added to lab notebook
- Project Report has been added to lab notebook
- Github repo hof your project as been cleaned up of old and not working stuff
- Github repo has been moved to campusrover github organization
NOTE: You are permitted to continue changing and fixing the code in your github repo until the very last minute.
Submit to moodle To receive credit you should submit these
- URL to your github repo
- URL to your project report in the lab notebook
- A URL to your video (can redo on Friday if needed)
- One URL for each teamm mate to your FAQ
By Friday December 13
- Be fully prepared for a successful demo
- Record video as described below
- Do final cleanup of your project github repo
Submit to moodle: The url to your video
Assessment
Your project will be assessed based on:
- Preparation for demo day
- Completeness of the deliverables per these instructions
- Quality and professionalism of the Deliverables
- Degree of challenge that you undertook. This is relative to the number of students on your team, AND the amount of time that you were given to work on the project.
- How well you met that challenge
Details
Preparing your demo
- Time and Equipment
- Plan for a 5-10 minute presentation using physical robots, with the option to use either the big screen or movable screen for display
- Preparation
- Test your software thoroughly to ensure it’s working, complete, and reliable
- Reserve your required robot in advance
- Prepare any necessary props like walls, obstacles, or costumes
- Multiple practice runs are essential before the final demonstration
- Content and Presentation
- Design an engaging demonstration that effectively showcases your learning and development
- Choose an interesting approach that highlights your work’s capabilities
- Teams may share demos, but assessment remains individual
Preparing your github repo for publication
- Create a brief readme.md that includes:
- An introduction and summary
- Links to the video, lab notebook project report, and poster PDF
- Code Quality
- Clean and well-structured code organized as a working ROS package
- Include thorough documentation
- Remove all test files, unused code, and experimental content
- Purpose
- Repository should be portfolio-ready and professional enough to reference on your resume
- Ensure all content represents your best work as it will be reviewed and may be used for future reference
- Move it to the campusrover organizatoin
- Easiest way is to go to
settings
for the organization, to the very bottom, and look for transfer ownership
. Indicate campusrover
- If you want to still have it in your github account then:
- Make a full copy of your project’s directory on your computer
- Delete the .git subdirectory in the copy (which takes away it’s
gitness
)
- Create a new repo in campusrover and point it at the copy directory
AGAIN: You can keep on modifying your code up until the last minute
Preparing FAQ Entries in the LabNotebook
Preparing your Final Report
- There are plenty of examples to look at
- Add it to this section of the labnotebook
- We pay attention to appearance, quality of writing, “fit and finish”.
- It should be approximately 10 pages (but in markdown)
- It’s more important to follow this outline than to worry about the length
- Introduction
- Problem statement, including original objectives
- Relevant literature
- What was created (biggest section)
- Technical descriptions, illustrations
- Discussion of interesting algorithms, modules, techniques
- Guide on how to use the code written
- Tables listing names and one sentence purpose of each of these:
- Python source files
- Nodes created
- Topics and their messages
- Story of the project.
- How it unfolded, how the team worked together
- Your own assessment
- problems that were solved, pivots that had to be taken
Preparing your video
- Very analogous to what you did for the various programming assignments
- Requirements:
- Explanation of interesting parts of the code
- In your actual voice(s)
- Around 4-5 minutes at most
- Include a video of the IRL demo
- Upload to google drive or youtube