Skip to content

Project Template

Cara Walter edited this page Dec 8, 2020 · 24 revisions

Project Name | Updates | Github

Project Leads: __ and __

Abstract

Context/Purpose: One to two sentences explaining why this project exists and what is significant about it. Do other hardware solutions exist? How does your project add to existing knowledge/hardware? Major components: One to two sentences outlining the major components you used to create your system. Outcomes: Three to four sentences about what your system accomplishes.

Keywords

Hardware In Context

A short description of the hardware, putting into context of similar open hardware and proprietary equipment in the field.

  • Why do we need this invention?
  • What problem is solved? Why is it a problem?
  • Past solutions? Why were they inadequate?
  • My idea for a solution. Why it is better.
  • Why it is worth pursuing.
  • Specific objectives: How I am going to do it.

Hardware Description

Describe the hardware, highlighting the customization rather than the steps of the procedure. Highlight how it differs/which advantage it offers over pre-existing methods. For example, how could this hardware: be compared to other hardware in terms of cost or ease of use, be used in the development of further designs in a particular area, and so on. Add 3-5 bulleted points to broadly explain to other researchers how the hardware could be potentially useful to them, for either standard or novel laboratory tasks, inside or outside of the original user community.

  • Hierarchical: big picture to details
  • Overview: major parts & functions
  • Integration: how does it work (diagram of logic, steps, material flow, …?)
  • Parts, sub-parts, sub-sub-parts in logical order
  • Clear, informative headings that map where each detail is in the bigger picture

Validation and Characterization

Demonstrate the operation of the hardware and characterize its performance over relevant critical metrics:

  • Demonstrate the use of the hardware for a relevant use case.
  • If possible, characterize performance of the hardware over operational parameters.
  • Create a bulleted list that describes the capabilities (and limitations) of the hardware. For example consider descriptions of load, operation time, spin speed, coefficient of variation, accuracy, precision and etc.

Future

This section includes the future expectations of this project.

Resource List

  • Bill of Materials

  • Build Guide

  • Operating Instructions

  • ex. Loom GitHub

Tutorials

References

  • Example

  • Mariotte, E. (1679). Essais de Physique : ou Mémoires pour servir à la science des choses naturelles, Paris.

Clone this wiki locally