Skip to content

Commit

Permalink
corrected some typos for code review, #33
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelzoom authored Jun 28, 2022
1 parent 4f597a2 commit 420c387
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ This document is a high-level description of the model used in PhET's Mean: Shar
This description currently pertains to the Intro Screen.

## Overview
The goal of this simulation is to provide users an understanding of mean as it relates to a data set. More specifically, how mean can be calculated, and how changing the data set affects the mean. The intro screen provides an experience of embodied math, allowing users to feel what the mean/average is in a qualitative sense as water levels out among cups.
The goal of this simulation is to provide users an understanding of mean as it relates to a data set. More specifically, how mean can be calculated, and how changing the data set affects the mean. The Intro screen provides an experience of embodied math, allowing users to feel what the mean/average is in a qualitative sense as water levels out among cups.

## Water Cup Data Set

The data set is represented by water levels in cups. There are two sets of cups: 3D cups, and 2D cups. Although the total amount of water on the screen is always equal between both sets of cups, a 2D cup may have more or less water than it's respective 3D cup.

In this sim, the 3D cups are treated as the "ground truth". Any calculations on mean, as well as reset or sync are based off of the water levels in the 3D cups. 2D cups provide users feedback on how the different water levels in the 3D set can be leveled out evenly.
In this sim, the 3D cups are treated as the "ground truth". Any calculations on mean, as well as reset or sync, are based off of the water levels in the 3D cups. 2D cups provide users with feedback on how the different water levels in the 3D set can be leveled out evenly.

## Pipes

Expand All @@ -23,19 +23,19 @@ The pipes only allow water movement across 2D cups. Water will not flow between

### Restrictions

Several restrictions were placed on how users can interact with the water levels in the cups due to concerns on the physics of the simulation, data set integrity, and UX design.
Several restrictions were placed on how users can interact with the water levels in the cups due to concerns about the physics of the simulation, data set integrity, and UX design.

- **Water Level Sliders**
- The water level slider on the 3D cups is restricted to only adding and removing water that it's 2D representation will allow.
- The water level slider on the 3D cups is restricted to only adding and removing water that its 2D representation will allow.
- Ex 1. Water has been shared across multiple cups, and now the 2D cup has less water than its 3D counterpart. The slider is restricted so that no more water than what the 2D cup contains can be removed from the 3D representation.
- Ex 2. Water has been shared across multiple cups, and now the 2D cup has more water than its 3D counterpart. The slider is restricted so that when a 2D cup has reached capacity, the corresponding 3D cup can no longer add water.


- **Sync Data**
- A "Sync" button was added to provide users a way to reset the 2D cups so that they match their 3D representations
- A "Sync" button was added to provide users a way to reset the 2D cups so that they match their 3D representations.
- The pipes must all close to prevent water from flowing out. This ensures that users can easily go back to matching 2D and 3D representations.

- **Adding and Removing Cups**
- By default cups are added at 1/2 capacity.
- When "Auto Share" is enabled, a cup will add on with an open pipe, leveling out the water and providing automatic feedback on mean across the cups.
- When a cup is removed the 3D cup is the "ground truth". That is the amount of water removed from each set's water total.
- When a cup is removed 2D water levels reset to their corresponding 3D values. Pipe states remain the same, and water will level back out if a pipe remains open.
- When a cup is removed, the 3D cup is the "ground truth". That is the amount of water removed from each set's water total.
- When a cup is removed, 2D water levels reset to their corresponding 3D values. Pipe states remain the same, and water will level back out if a pipe remains open.

1 comment on commit 420c387

@pixelzoom
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#41

Please sign in to comment.