Final Project
Contents
Final Project#
Goals#
This project aims to apply the tools and concepts taught in this course to a problem that interests you. This project is intentionally open-ended. Example projects might include: building a data management workflow for a process in your company or research, developing an interactive dashboard and data visualization tool, or developing an automated analysis pipeline for a task of interest. The goal is for you to get something useful out of this project while demonstrating the ability to apply computational tools. It can be an approved topic if you justify how your project fits into the course. Note that it is not a requirement that you complete the project within the timeline of the course. You will be evaluated on the progress that you have made, the use of computational tools, and the communication of impact and tasks.
Most importantly, I cannot teach you in a single course how to be proficient in applying modern computational methods. The most important skill you can get from this course is the ability and confidence to approach problems with computational methods. It is expected for this project that you will extend beyond the topics covered in the course.
White Paper#
Due 10/12/2022
To determine the topic for your project, you will submit a one-page white paper and a logical diagram of your proposed project. This white paper will not be graded. Instead, it will be used to make sure you are on the right track for your project. This white paper should describe:
The current problem you are trying to address
What is the current process that is used to solve the problem
Your approach to solving the problem. Note it is okay if you do not know the exact methodology that you will use. This will be the primary area of our discussion
Timeline for project completion
Assignment Components#
GitHub Repository (50%)#
For your assignment, you are required to create and manage your software development using version control on GitHub. Your repository does not have to be public but will need to be shared for grading. The GitHub Repository will be evaluated using the following rubric.
GitHub Repository Rubric#
Grading will be completed through peer evaluations and evaluations by Prof. Agar. Each student will be responsible for evaluating 3-4 classmates’ projects. At Prof. Agar’s discretion, he can exclude any peer evaluation, which he feels is unfair.
| Topic | Percentage |
|---|---|
| Code Functionality - How much functionality is included in the code? | 40 |
| In code documentation - How readable is your code? | 15 |
| Code Reusability - How easy is it for someone to reuse and extend your code? | 25 |
| Usage Documentation - How easy is it for someone new to your code to use it? | 20 |
Hints#
Make sure to comment on most lines of code
Functions can be documented using a standard format for autodoc string
Try to follow python conventions PEP8 or Black
Make tutorial notebooks that users can explore
Create a Jupyterbook or readthedocs
Add environment configuration file
Serve your package in a Docker container
Add a license file for reuse
Add continuous integration
Note that you do not need to fulfill all of these hints. I would be shocked if you did more than half of them. Please make sure you do what is meaningful for your project.
Presentation (50%)#
You will be required to prepare a 12-minute presentation describing your final project. The project will be graded using a combination of peer reviews and Prof. Agar’s evaluation. At Prof. Agar’s discretion, he can exclude any peer evaluation, which he feels is unfair.
Topics to Cover:#
The problem that your project addresses
Computational tools which are developed
Demonstration of how your tool works
Future development roadmap and impact
Presentation Rubric#
| Category | Scoring Criteria | Total Points | Points Scored |
|---|---|---|---|
| Organization (15 points) | The type of presentation is appropriate for the topic and audience. | 5 | |
| Information is presented in a logical sequence. | 5 | ||
| Presentation includes appropriate citations | 5 | ||
| Content (45 points) | Introduction is attention-getting, establishes the problem well, and establishes a framework for the rest of the presentation. | 5 | |
| Technical terms are well-defined in language appropriate for the target audience. | 5 | ||
| Presentation contains accurate information. | 10 | ||
| Material included is relevant to the overall Message/purpose. | 10 | ||
| Appropriate amount of material is prepared, and points made reflect well their relative importance. | 10 | ||
| There is an obvious conclusion summarizing the presentation. | 5 | ||
| Presentation (40 points) | Speakers maintains good eye contact with the audience and is appropriately animated (e.g., gestures, moving around, etc.) | 5 | |
| Speaker uses a clear, audible voice. | 5 | ||
| Delivery is poised, controlled, and smooth. | 5 | ||
| Visual aids are well prepared, informative, effective, and not distracting | 10 | ||
| Length of presentation is within the assigned time limits. | 5 | ||
| Information was well communicated. | 10 | ||
| Score | Total | 100 |