The goal of the project report is to provide a document that could be printed out and given to someone to read and fully understand the project. This document should be written like a scientific paper and not include dynamic content such as video and code that needs to be run (although figures and images are encouraged).

You can print this report as a PDF and include it as an attachment in your email to the instructor and sponsors.

✅ Project Title

By ✅ "Your names and emails"

Abstract

✅ A summary describing the high-level functionality and purpose of the project for a diverse, non-specialist audience. Include a summary of what you did and your conclusions.

Background and Motivation

✅ A clear statement of need that illustrates the purpose of the project. Include any background information someone would need to understand the problem. Make sure you define any jargon and spell out any acronyms that will be used.

Methodology

✅ Tell the story about how your team tried to solve this problem. Include descriptions of software packages and any theory you used. This should be written such that someone Knowledgeable could try to use this description and your repository to reproduce the project results.

Results

This section outlines the major results of the project. Include summary figures with references to the jupyter notebooks that describe how the figures were produced. This should tell a story about what you learned and be in a logical order.

Concluding Discussion and Future Work

✅ This section should summaries what the project did and what conclusions you can make from the results. Teams should also include ideas for future work.

Acknowledgements

✅ Teams should acknowledge their sponsors and any other groups that helped with their project.

References

✅ A numbered list of key references including a link to the software archive. These numbers should be included in the text above.

Appendices

Although not required use appendices to include any more details which you don’t want to include in your main report. This will vary by project.