diff --git a/README.md b/README.md index 4d9af0e..1f7b7b1 100644 --- a/README.md +++ b/README.md @@ -11,5 +11,37 @@ The PhET Development. This guide includes how to obtain simulation code and its dependencies, notes about architecture & design, how to test and build the sims, as well as other important information. +### Quick Start +(1) Clone the simulation and its dependencies: +``` +git clone https://github.com/phetsims/assert.git +git clone https://github.com/phetsims/axon.git +git clone https://github.com/phetsims/babel.git +git clone https://github.com/phetsims/brand.git +git clone https://github.com/phetsims/chipper.git +git clone https://github.com/phetsims/coulombs-law.git +git clone https://github.com/phetsims/dot.git +git clone https://github.com/phetsims/inverse-square-law-common.git +git clone https://github.com/phetsims/joist.git +git clone https://github.com/phetsims/kite.git +git clone https://github.com/phetsims/phet-core.git +git clone https://github.com/phetsims/phetcommon.git +git clone https://github.com/phetsims/query-string-machine.git +git clone https://github.com/phetsims/scenery.git +git clone https://github.com/phetsims/scenery-phet.git +git clone https://github.com/phetsims/sherpa.git +git clone https://github.com/phetsims/sun.git +git clone https://github.com/phetsims/tandem.git +``` +(2) Start an http-server + +(3) Open `http://localhost/coulombs-law/coulombs-law_en.html` (You will probably need to modify this URL based on your HTTP port and relative path.) + +### Get Involved + +Contact us at our Google Group: Developing Interactive Simulations in HTML5 + +Help us improve, create a New Issue + ### License See the LICENSE diff --git a/doc/implementation-notes.md b/doc/implementation-notes.md index 7715837..a035853 100644 --- a/doc/implementation-notes.md +++ b/doc/implementation-notes.md @@ -1 +1,15 @@ -TODO implementation overview \ No newline at end of file +# Coulomb's Law - Implementation Notes + +This document contains notes that will be helpful to developers and future maintainers of this simulation. + +## Model + +Start by reading the model description in https://github.com/phetsims/coulombs-law/blob/master/doc/model.md + +Following that, almost all types in the model and view are inherited from the Inverse Square Law Common library. It will be useful to become familiar with its [model](https://github.com/phetsims/inverse-square-law-common/blob/master/doc/model.md) and [implementation](https://github.com/phetsims/inverse-square-law-common/blob/master/doc/implementation-notes.md) + +The primary type in this sim is the `Charge`. It handles all positioning as well as the charge values needed to calculate the displayed force. + +The primary distinction within Coulomb's Law is it's handling of negative object properties (charges) and force values. Here the force can be attractive or repulsive. + +## View \ No newline at end of file diff --git a/doc/model.md b/doc/model.md index d899721..3a8fb04 100644 --- a/doc/model.md +++ b/doc/model.md @@ -1 +1,19 @@ -TODO model description \ No newline at end of file +# Coulomb's Law Model + +This document describes the model for the Coulomb's Law simulation.
+@author Michael Barlow (PhET Interactive Simulations) + +## Inverse Square Law +Coulomb's law is one of two inverse square laws that defines the force that two charges will exert upon each other. + +F = k( q1 * q2 / d2) + +Note: See the [Inverse Square Law Common](https://github.com/phetsims/inverse-square-law-common/blob/master/doc/model.md) library for model details. + +## Macro Scale + +Applies to a visual scale where the charges are ~1cm in diameter. When calculating the force, we use each charge's center when measuring distance. + +## Atomic Scale + +Applies to a more realistic scale in which the charges arou ~1pm in diameter and charge is measured in atomic units. \ No newline at end of file