AgentScript is a minimalist Agent Based Modeling (ABM) framework based on NetLogo agent semantics. Its goal is to promote the Agent Oriented Programming model in a highly deployable CoffeeScript/JavaScript implementation. Please drop by our Google Group to get involved. We have a gh-pages site agentscript.org.
Cake is used to build agentscript.coffee from individual source files, and to compile into agentscript.js, agentscript.min.js, and agentscript.map. The map file allows debugging in Chrome via CoffeeScript source.
See the template.html and models/*.html files for example models. The individual .coffee files are documented via Jeremy Ashkenas's docco in the docs/ dir. See the Cakefile for details.
Currently the documentation is hosted directly on our GitHub Pages or directly from agentscript.org from the docco generated html found in the doc/ directory.
util.coffee: is the base module for all of the miscellaneous functions used by the rest of the project.
shapes.coffee: is a simple agent shapes module containing the default shapes and a few functions for getting the named shapes and adding your own shapes.
agentset.coffee is the core array subclass used by patches, agents, and links.
agentsets.coffee contains the three subclasses of AgentSet: Patches, Agents, and Links along with the three classes they manage: Patch, Agent, and Link.
model.coffee is the top level integration for all the agentsets and is subclassed by all user models.
template.html is a trivial subclass of Model showing the basic structure how you build your own models. In addition, the models/ directory contains 10 simple models used in teaching NetLogo. You can run the model here.
The extras/ directory contains libraries that are too specialized to be in the core AgentScript but are essential for certain applications. They are compiled to JavaScript in the lib/ directory.
data.coffee A 2D DataSet library for data best expressed as an array of numbers. It includes the ability to treat Images as data, to parse GIS elevation .asc files, to create datasets from patch variables etc. It includes analytic abilities like nearest neighbor and bilinear sampling, convolution with 3x3 kernels, and resampling datasets to different resolutions.
fbui.coffee A simple start at a User Interface abstraction, with JSON representing buttons, sliders, switches and menus. Each item in the JSON tree modifies the state of the model, either directly by setting Model variables or indirectly by calling a method in class Model.
mouse.coffee A trivial event based interface to the mouse, mainly for direct interaction with the model's graphic layers. It converts the mouse raw coordinates into patch coordinates.
The models/ directory contains tiny models used to test the system and offer examples to get started with. These also are our our GitHub pages. They usually print to the console.log, so opening the developer's javascript console will show model information.
ants.html Ant foraging with nest and food pheromone diffusion.
buttons.html Stuart Kauffman's example of randomly connecting pairs of buttons in a pile resulting in a tipping point.
diffusion.html Agents randomly flying on a patch grid dropping a color which is diffused over the grid.
fire.html A CA based spread of fire showing burn behavior.
flock.html The classic "boids" model where agents use three simple rules resulting in realistic flocking.
gridpath.html One of Knuth's great puzzles on the probability of all Manhattan traversals diagonally traversing a grid.
linktravel.html Agents traversing a graph of nodes and links.
nbody.html Nonlinear gravitation of n bodies.
prefattach.html Example of a dynamic graph with new links preferentially attaching to nodes with most links. This results in a power-law distribution.
tspga.html A Traveling Sales Person solution via a Genetic Algorithm showing the rapid conversion of stochastic methods.
droplets.html A simple GIS model based on ESRI asc elevation file with droplets agents which seek lowest elevation. Uses the data.js extension.
Our example models use CoffeeScript directly within the browser via text/coffeescript script tags:
<html>
<head>
<title>AgentScript Model</title>
<script src="agentscript.js"></script>
<script src="coffee-script.js"></script>
<script type="text/coffeescript">
class MyModel extends ABM.Model
...
model = new MyModel "layers", 13, -16, 16, -16, 16
...
</script>
</head>
<body>
<div id="layers" style="padding:20"></div>
</body>
</html>
You may see this by running a sample model, then use the browser's View Page Source. (Google "view page source")
Similarly, the models will print to the "javascript console" while they run. (Google "view javascript console")
CNAME DNS agentscript.org file for gh-pages
Cakefile cake file for build, docs etc.
LICENSE GPLv3 License
README.md This file
index.html gh-pages index.html file
docs/ Docco documentation
extras/ AgentScript extensions
lib/ All .js/min.js and .map files
models/ Sample models
src/ Component .coffee files for agentscript.coffee
tools/ coffee-script.js and others
Copyright Owen Densmore, RedfishGroup LLC, 2012, 2013
http://agentscript.org/
AgentScript may be freely distributed under the GPLv3 license:
AgentScript is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program, see LICENSE within the distribution. If not, see http://www.gnu.org/licenses/.