Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myphysicslab/myphysicslab
myPhysicsLab provides JavaScript classes to build real-time interactive animated physics simulations
https://github.com/myphysicslab/myphysicslab
Last synced: 3 months ago
JSON representation
myPhysicsLab provides JavaScript classes to build real-time interactive animated physics simulations
- Host: GitHub
- URL: https://github.com/myphysicslab/myphysicslab
- Owner: myphysicslab
- License: apache-2.0
- Created: 2016-10-19T21:23:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-01T19:23:06.000Z (10 months ago)
- Last Synced: 2024-04-18T22:40:01.563Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 9.88 MB
- Stars: 352
- Watchers: 28
- Forks: 83
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-physics - myphysicslab - provides JavaScript classes to build real-time interactive animated physics simulations (Mechanics / Rigid Bodies and Physics Engines)
README
myPhysicsLab README
===================
myPhysicsLab provides JavaScript classes to build real-time interactive
animated physics simulations.
The [myPhysicsLab website](https://www.myphysicslab.com) shows the simulations running
and contains explanations of the math behind them.
Author and License
------------------
myPhysicsLab is provided as open source software under the
[Apache 2.0 License](http://www.apache.org/licenses/). See the accompanying
file named `LICENSE`. The author is Erik Neumann .
Source code is available at .
Building
--------
It is possible to customize a myPhysicsLab simulation without building from source
code, see
[Customizing myPhysicsLab Simulations](https://www.myphysicslab.com/develop/docs/Customizing.html).
To build from source code:
1. Download the myPhysicsLab source code from
. You can download a zip file
from that github page, or use
git clone https://github.com/myphysicslab/myphysicslab.git
2. Install the required tools:
+ [TypeScript](https://www.typescriptlang.org)
You should be able to execute `tsc --version` within
the `myphysicslab` directory.
Making an alias in your `.bash_profile` like this might be helpful:
alias tsc=~/Documents/Programming/myphysicslab/node_modules/typescript/bin/tsc
+ [esbuild](https://esbuild.github.io)
Make a symbolic link to the `esbuild` executable within
the `myphysicslab` directory.
ln -s node_modules/esbuild/bin/esbuild esbuild
You should then be able to execute
`./esbuild --version` within the `myphysicslab` directory
+ [Perl](https://www.perl.org)
+ [GNU Make](https://www.gnu.org/software/make/)
3. Execute `tsc` at the command line. This will compile all the typescript `.ts` files
to become JavaScript `.js` files in the `build` directory.
4. Execute `make` at the command line. This creates `.html` files and
bundled `.js` files in the `build` directory for all applications and tests in all
language versions. Execute `make help` to see available options.
5. Open the file `/build/index-en.html` with a browser. This has
links to all the example files that were built.
See [Building myPhysicsLab Software](https://www.myphysicslab.com/develop/docs/Building.html)
for more information about the build process.
Installation Hints
------------------
Here are some hints about installing tools, this was on MacOS. Following
[this page](https://dyclassroom.com/howto-mac/how-to-install-typescript-on-mac-using-node-npm)
I used `HomeBrew` to install `node`, and then used node's `npm` to install the other
tools locally inside the myphysicslab directory:
cd myphysicslab
npm install typescript
npm install esbuild
Those commands create some directories and files (for example `node_modules`) inside
the myphysicslab directory that are unrelated to the myphysicslab project. The
`.gitignore` file contains entries to prevent these from being added to the
myphysicslab project.
Test whether your installation is ready to build myphysicslab:
cd myphysicslab
tsc --version
./esbuild --version
perl --version
make --version
Documentation
-------------
See [myPhysicsLab Documentation](https://www.myphysicslab.com/develop/docs/index.html)
for overview of architecture and for detailed documentation of software.
Building the documentation requires some additional tools, see
[Building myPhysicsLab Software](https://www.myphysicslab.com/develop/docs/Building.html#buildingthedocumentation)
Examples
--------
There are around 50 different simulations in the source code, each of which has
has an example file which is mainly for development and testing. Find them in the
[examples index](https://www.myphysicslab.com/develop/build/index-en.html).
History
-------
myPhysicsLab was started in 2001 using Java. From 2013 to 2016 the code was converted
to JavaScript that depended on Google Closure Compiler.
In 2023 the code was converted to TypeScript for a couple of reasons: to be able to
generate documentation, and because
[Google Closure Library is being retired](https://github.com/google/closure-library/issues/1214).
Because of how modules work in TypeScript, sometimes several classes or interfaces
are combined into a single file. For example the file `util/Observe.ts` contains what
was previously in 10 separate files. This can make finding things a little harder
in the new scheme.