Benoît Allard avatar Benoît Allard committed 53ee551

Add a documentation

Comments (0)

Files changed (1)

  <p class="opera">WARNING: There are some drawing troubles with
  Opera. This should'nt affect the simulation though.</p>
 
+ <p>Looking for a <a href="#description">description</a> ?</p>
+
  <div id="stack">
   <canvas width="760" height="760" id="harvester"></canvas>
   <canvas width="760" height="760" id="field">
  <script type="text/javascript" src="script.js" ></script>
 
  <hr>
+
+ <div class="description" id="description">
+  <p>
+   In this simulation, the blue harvester aims at cleaning the red
+   field. Nothing is precalculated, and everything happens in the
+   web-browser in <em>real-time</em>. The black circles are the spot
+   where the pilot looks at to help him decide on the next step. When
+   they are filled, they indicate that the field already has been
+   harvested at this place.
+  </p>
+
+  <p>
+   Below the drawing, there are some controls to
+   <strong>Start</strong>, <strong>Pause</strong> or
+   <strong>Reset</strong> the simulation. When the simulation is not
+   running, one can also execute it step-by-step with the
+   <strong>Perform one Step</strong> button.
+   <p>
+    The speed of the harvester can also be changed. Beware that higher
+    speed decrease the accuracy as it increases the sampling period.
+   </p>
+  </p>
+
+
+  <p>
+   Below those controls, the possibility is offered to change the
+   field, or to switch the (auto)-pilot. Those modification will only
+   take effet upon a <strong>Reset</strong>.
+  </p>
+  <p>
+   The available fields are:
+   <ul>
+    <li>Some precalculated ones, named <i>Example &lt;n&gt;</i></li>
+    <li>some others, extracted from <a
+   href="http://osm.org">openstreetmap</a> <a
+   href="http://wiki.openstreetmap.org/wiki/Tag:landuse%3Dfarm">data</a>,
+   named <i>osm-&lt;way_id&gt;</i></li>
+    <li>complete random ones, regenerated everytime, named <i>Random-&lt;n&gt;points</i></li>
+   </ul>
+  <p>
+  </p>
+   And the available pilots are:
+   <dl>
+    <dt>Simple spiral</dt>
+    <dd>A pilot that follow the left edge of the remaining bit of the
+     field, and progress at its own pace toward the center.</dd>
+    <dt>Enhanced</dt>
+    <dd>A pilot that starts like the simple spiral, and after three
+     <i>laps</i>, having cleared the <i>headlands</i>, it switches to
+     another method: going back and forth along the same edge</dd>
+   </dl>
+   Those pilots have no notion of being <i>done</i>, and, after having
+   performed their task, will have a less predictible behavior until
+   the <strong>Pause</strong> button is pressed.
+  </p>
+ </div>
+
+ <hr>
  <p><a href="https://bitbucket.org/benallard/harvesim">Source code</a>
  available on bitbucket, or under the right-click -> 'View Page Source' menu.</p>
  <address><a href="mailto:benoit.allard@gmx.de">Benoît Allard</a></address>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.