Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.58 KB

ProjectPlanner.md

File metadata and controls

40 lines (24 loc) · 2.58 KB
Raw

EMSC4033 project plan template

Project title

Executive summary

In one to two sentences, explain the background, the broad goals of the project and what the specific outcomes will be.

Example: (this is based on the seismic monitoring dashboard that Louis showed). Seismic stations can be used to monitor human noise over the course of the day. Some seismometers stream data live to a server and so this processing can be done in near-real time. In this project I plan to build an online dashboard which processes the data once a day and uploads the results to github as 1) raw data, 2) an image that can be embedded in websites, 3) an updating csv table in github. I also plan to use the github "actions" engine to provide all the necessary processing power.

Goals

  • Goal 1
  • Goal 2
  • ...

(Write things that you can assess whether they have been accomplished. For example, a goal like “improve visualisation of ocean output” is vague... But a goal that reads “implement functionality to plot streamlines of horizontal velocities in various slices from 3D ocean output” is specific enough.)

Background and Innovation

Give more details on the scientific problem that you are working on and how this project will advance the discipline or help with your own research. (Where applicable, describe how people have been achieving this goal up to now, talk about existing packages, their limitations, whether you can generalise something to help other people use your code).

Resources & Timeline

What do you have at your disposal already that will help the project along. Did you convince somebody else to help you ? Are there already some packages you can build upon. What makes it possible to do this project in the time available. Do you intend to continue this project in the future ?

(For example:

  • I’ll be using data of X from satellite and then also data from baby blue seals…
  • I’ll step on existing package Y and build extra functionality on top of class W.
  • I’ll use textbook Z that describes algorithms a, b, c
  • … )

Testing, validation, documentation

Note: You need to think about how you will know your code is correct and achieves the goals that are set out above (specific tests that can be implemented automatically using, for example, the assert statement in python.) It can be really helpful if those tests are also part of the documentation so that when you tell people how to do something with the code, the example you give is specifically targetted by some test code.

Provide some specific tests with values that you can imagine asserting