Skip to content

Commit c1a8dbb

Browse files
committed
Improve README
1 parent e82ee13 commit c1a8dbb

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ To give you a quick idea, the following figure is created with the [`plot.py`](p
2727
Your eyes may need some time to adapt to the correct depth perception: black ridges are high-altitude separations between the colored valleys.
2828

2929
Note that the starting point and the finish are denoted as green and red circles, respectively.
30-
All other circles are waypoints that must be reached on the way down.
30+
All other circles are waypoints that must be visited on the way down.
3131

3232
## Concept
3333

3434
The idea is for students to use the surface implemented in `soapboxslide` to simulate the dynamics of a particle (or a connected set of particles) sliding down.
35-
In addition to correctly implementing the dynamics, students must do so as quickly as possible without missing any of the waypoints shown as dotted circles.
35+
In addition to correctly implementing the dynamics, students are instructed to find the physical parameters that allow the point mass(es) to reach the final target as quickly as possible, without missing any of the intermediate waypoints.
3636

3737
Two classes of physical models can be considered:
3838

3939
1. The most convenient is to assume a model of point particles strictly bound to the surface with holonomic constraints.
4040
In this case, equations of motion can be derived using a Lagrangian, possibly with a generalized force to include non-conservative friction forces.
4141

42-
2. A more challenging scenario (not used for now, but closer in spirit to real soap box races) is to impose inequality constraints, allowing particles to detach from the surface.
42+
2. A more challenging scenario (not used for now, but closer in spirit to real soap box races) is to impose inequality constraints, allowing particles to fly over the surface.
4343

4444
## `Slide` Class Usage
4545

46-
One can load a surface from a [TOML](https://toml.io/en/) file and calculate slide properties at a given point, e.g. $x=5$ and $y=38$, as follows:
46+
You can load a slide surface from a [TOML](https://toml.io/en/) file and calculate slide properties at a given point, e.g. $x=5$ and $y=38$, as follows:
4747

4848
```python
4949
import numpy as np

0 commit comments

Comments
 (0)