Link to this document as a Jupyter notebook

ASSIGNMENT - Project Plan

Project Title

By "Your name"

Replace the following with a picture that “defines” your project. This could be sponsor logo, an expected outcome of your project, a graphical representation of the research area, etc.

Image from: URL REFERENCE

NOTE: This image should either be available on the Internet (in which case you include the full url in the src field. Or, the image should be added to your repository in the docs/images directory in which case the src field should be a relative path such as ./images/myfile.png. DO NOT use absolute paths for local files.

Instructions

Please write your proposals either in full markdown files (md) or as Jupyter notebooks (ipynb). This notebook not only acts as instructions/outline for your proposal but should be used as a template for writing. Rename the file to something like proposal.md or proposal.ipynb and commit it to your docs folder. DO NOT leave the instructions in your submitted document. Erase all instructions and only leave the basic structure and format. Try to write the proposal to a general audience that may be interested (for example your classmates, your advisor or your lab mates).

Make this look as professional as possible. You will be sending this to your project sponsors.

Overview

Provide a couple of paragraphs about the research domain you are going to cover in your project. Explain as if to someone outside your area of expertise. Please use references when appropriate.

Program Description

Provide a more detailed paragraph about the software be modifying or developing as part of your project. What components already exists and what components do you hope to add and/or improve as part of your project?

This should be written mostly in your own words. Do not just copy and paste words from the project description.

Project Goals Labor and Timeline

Explain in more detail the parts of the code you are going to get working for the project. How is this work going to be divided between team members such as there is an even distribution of labor. Lay out some short term, mid-term and long term goals. As best you can, try to scope the project such that you can complete the short term and mid-term goals and if time/luck permits maybe a few of the long term goals.

Note: it is expected that these goals will adjust change as things move forward.

As a reminder, here are a set of dates (Approx. every other Friday) that include deliverables related to your projects. These sub-projects are designed to introduce you to useful software development tools

1/23/2022 - Create git repository
1/30/2022 - Proposal due
2/6/2022 - Proposal Presentation Slides due
2/13/2022 - Proposal video due
3/13/2022 - Closed Loop Presentation Slides due
3/20/2022 - Closed Loop Video due
4/3/2022 - Full project Draft due
4/17/2022 - Final Presentaion slides due
4/24/2022 - Final Video and Report due

Anticipating Challenges

List any key pieces of information/skills do you need to learn and/or mater to successfully complete all of your project goals.

Also list challenges that you are worried about or that may come up in the course of completing your project. Include changes you will make to your plan if these challenges do arise.

Proposal Grading Rubric

The following basic grading rubric instructors will try to use to evaluate your proposal

Grading Overall
10 points - Project title
10 points - Descriptive picture
20 points - Overview
20 points - Program Description
20 points - Project Goals / Timeline
20 points - Anticipating Challenges

Grading Rubric
-5 Leaving in instructions in report.
-5 Sloppy formatting

Submitting Assignment

To submit your proposal add a copy to the git repository. Your instructors will download the updated repository after the due date.

Once your instructor’s have graded your reports, teams will be asked to respond to the feedback and then email the final reports to their sponsors (while cc’ing the instructors).

Written by Dr. Dirk Colbry, Michigan State University
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.