https://github.com/phetsims/magnet-and-compass
"Magnet and Compass" is an educational simulation in HTML5, by PhET Interactive Simulations.
https://github.com/phetsims/magnet-and-compass
Last synced: 4 months ago
JSON representation
"Magnet and Compass" is an educational simulation in HTML5, by PhET Interactive Simulations.
- Host: GitHub
- URL: https://github.com/phetsims/magnet-and-compass
- Owner: phetsims
- License: gpl-3.0
- Created: 2024-01-13T21:39:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-17T23:43:05.000Z (9 months ago)
- Last Synced: 2025-09-18T01:22:22.585Z (9 months ago)
- Language: HTML
- Size: 1.15 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Magnet and Compass
=============
"Magnet and Compass" is an educational simulation in HTML5, by PhET
Interactive Simulations
at the University of Colorado Boulder. For a description of this simulation, associated resources, and a link to the
published version,
visit the simulation's web page.
### Try it!
Click here to
run "Magnet and Compass".
### Documentation
The PhET
Development Overview is the most complete guide to PhET Simulation 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/bamboo.git
git clone https://github.com/phetsims/brand.git
git clone https://github.com/phetsims/chipper.git
git clone https://github.com/phetsims/dot.git
git clone https://github.com/phetsims/faradays-electromagnetic-lab.git
git clone https://github.com/phetsims/joist.git
git clone https://github.com/phetsims/kite.git
git clone https://github.com/phetsims/magnet-and-compass.git
git clone https://github.com/phetsims/perennial.git perennial-alias
git clone https://github.com/phetsims/phet-core.git
git clone https://github.com/phetsims/phetcommon.git
git clone https://github.com/phetsims/phetmarks.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/tambo.git
git clone https://github.com/phetsims/tandem.git
git clone https://github.com/phetsims/twixt.git
git clone https://github.com/phetsims/utterance-queue.git
```
(2) Install dev dependencies:
```
cd chipper
npm install
cd ../perennial-alias
npm install
cd ../magnet-and-compass
npm install
```
(3) Run `grunt dev-server` to start a local development server that will serve the simulation.
(4) Open in the browser: `http://localhost/magnet-and-compass/magnet-and-compass_en.html`
#### Optional: Build the simulation into a single file
(1) Change directory to the simulation directory: `cd ../magnet-and-compass`
(2) Build the sim: `grunt --brands=adapted-from-phet`. It is safe to ignore warnings
like `>> WARNING404: Skipping potentially non-public dependency`, which indicate that non-public PhET-iO code is not
being included in the build.
(3) Open in the
browser: `http://localhost/magnet-and-compass/build/adapted-from-phet/magnet-and-compass_en_adapted-from-phet.html`
### Get Involved
Contact us at our Google
Group:
Developing Interactive Simulations in HTML5
Help us improve, create a New Issue
### License
See the LICENSE