[GRASS-SVN] r66815 - in grass-addons/grass7/raster/r.agent: . r.agent.aco r.agent.rand

[svn_grass at osgeo.org]

Author: mic
Date: 2015-11-11 12:14:59 -0800 (Wed, 11 Nov 2015)
New Revision: 66815

Modified:
   grass-addons/grass7/raster/r.agent/r.agent.aco/r.agent.aco.html
   grass-addons/grass7/raster/r.agent/r.agent.html
   grass-addons/grass7/raster/r.agent/r.agent.rand/r.agent.rand.html
Log:
update docs

Modified: grass-addons/grass7/raster/r.agent/r.agent.aco/r.agent.aco.html
===================================================================
--- grass-addons/grass7/raster/r.agent/r.agent.aco/r.agent.aco.html	2015-11-11 18:36:34 UTC (rev 66814)
+++ grass-addons/grass7/raster/r.agent/r.agent.aco/r.agent.aco.html	2015-11-11 20:14:59 UTC (rev 66815)
@@ -1,21 +1,16 @@
 <h2>DESCRIPTION</h2>
 
-<em>r.agent</em> shall provide an inital base for organizing worlds
-with raster playgrounds and agents in.
-<p>
-As this is only a first implementation the encapsulation that grants
-a modular usage is still suffering..
-<p>
-<em>r.agent</em> is written in python for more transparency and
-better extendability.
-<p>
-As a first world example there is an ACO-based environment
+As a first real example of a world there is an ACO-based environment
 (see <a href="http://en.wikipedia.org/wiki/Ant_colony_optimization_algorithms">Ant Colony Optimization</a>)
-available (in <em>libold</em> see below..).
+available.
 <p>
 The basic concept of such an ACO world, is to take some cost surface
-and transform it to a penalty layer - where for human ants for example
-this penalty layer may be expressed by the walking velocity, e.g. calculated
+and transform it to a penalty layer. Even if the algorithm comes from
+the realm of insects, it might be adopted to different animal kingdoms.
+Depending on the type of agent this penalty layer must be reinterpreted:
+if for example we want to talk about human
+agents
+the penalty layer may be expressed by the walking velocity, e.g. calculated
 with the algorithm proposed by
 <a href="http://www.geodyssey.com/papers/tobler93.html">Tobler1993</a>.
 The actors on the playground will wander around on the playground
@@ -36,18 +31,7 @@
 <h2>NOTES</h2>
 
 The state of this software is: "first do it".
-This is work in progress and its structure will probably change quite a lot
-in the future due to a better integration in GRASS and other refactoring.
 <p>
-The refactoring causes <em>r.agent</em> to not work for the moment. The general
-behaviour can be seen by changeing the imports in <em>r.agent.aco</em>
-to the old library <em>libold</em> -- <em>libagent</em> is coming soon.
-<p>
-Unfortunately the colletion is not very well included in GRASS yet.
-At the moment <em>libold</em> only handles ASCII grid and vector in- and
-output data. With a better GRASS integration (arrays) not only will the code
-get lighter but also these drawbacks shall vanish.
-<p>
 ACO works best on dynamic maps -- it constantly tries to improve paths...
 
 

Modified: grass-addons/grass7/raster/r.agent/r.agent.html
===================================================================
--- grass-addons/grass7/raster/r.agent/r.agent.html	2015-11-11 18:36:34 UTC (rev 66814)
+++ grass-addons/grass7/raster/r.agent/r.agent.html	2015-11-11 20:14:59 UTC (rev 66815)
@@ -1,3 +1,18 @@
 <h2>DESCRIPTION</h2>
 
-TODO
+<em>r.agent</em> consists of a library <em>libagent</em> and some submodules
+which use this it. The submodules are described in their resp. directories.
+The library provides the basic functionality to introduce agent based modeling
+on raster maps and fully integrates with GRASS thanks to the new python API!
+<p>
+For a maximum of transparency and the hope that it might serve as a
+framework to build more submodules on it, it is written in python and in
+an object oriented manner.
+<p>
+Let's think of the maps and layers as playgrounds where little worlds
+with agents may evolve.
+<p>
+Please note the <em>tests</em> subfolder. It contains unit tests that
+might be called after each change on the library to verify that nothing
+was broken during the development.
+

Modified: grass-addons/grass7/raster/r.agent/r.agent.rand/r.agent.rand.html
===================================================================
--- grass-addons/grass7/raster/r.agent/r.agent.rand/r.agent.rand.html	2015-11-11 18:36:34 UTC (rev 66814)
+++ grass-addons/grass7/raster/r.agent/r.agent.rand/r.agent.rand.html	2015-11-11 20:14:59 UTC (rev 66815)
@@ -1,3 +1,12 @@
 <h2>DESCRIPTION</h2>
 
-TODO
+This submodule - <em>r.agent.rand</em> -
+is nothing but an example of how the <em>libagent</em>
+library might be used to get a simple setup running.
+
+As the name suggests, <em>r.agent.rand</em>
+lets agents wander around just based on chance.
+You only need to define a single input
+map, just some raster map, that will be completly ignored,
+it is only used to set the frame for the agents to come.
+