Skip to content
AgentScript Core Model modules without Views
JavaScript HTML
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
data
dist
models
models2
models3
mvc2
src
test
tests
vendor
workers3
workflow
.eslintrc.js
.gitignore
.prettierrc.js
LICENSE
README.md
_config.yml
favicon.ico
package.json
yarn.lock

README.md

AgentScript

AgentScript is a minimalist Agent Based modeling system based on NetLogo semantics.

It has a Model/View architecture for which this is the Model. A set of Views will be provided in the future.

One such Three.js View is provided by as-app3d. Here is fire model, and a flocking model.

Obserable is also useful for Views, see: this example

Dual Build

AgentScript is based on es6 Modules (ESM) which are delivered as two Rollup bundles:

* UMD: agentscript.umd.js
* ESM: agentscript.esm.js

The UMD can be used in the browser as a <script> tag, and in Node using require()

The ESM is used in es6 import statements.

Both are available in minified form. All are in the project's dist/ directory.

The UMD's global name is AS

NPM Package

AgentScript is available as a npm scoped package: @redfish/agentscript.

To install the package, yarn add @redfish/agentscript. This places the bundles in node_modules/@redfish/agentscript/dist

To use the package as a CDN, use unpkg.com.

View the unpkg.dashboard: https://unpkg.com/@redfish/agentscript/

Developer Information

To clone the github repo:

  • cd to where you want the agentscript/ dir to appear.
  • git clone https://github.com/backspaces/agentscript
  • cd agentscript # go to new repo
  • yarn install # install all dev dependencies
  • yarn build # complete the install

All workflow is npm run scripts. See package.json's scripts, or use yarn run for a list. JavaScript Standard Style is used.

Github Pages

A gh-page is used for the site. It contains the dist/ dir and a models/ dir with sample models also used for testing.

It uses the docs/ simplification for gh-page creation.

The gh-page hosts our sample models. The fire model can be run with:

http://backspaces.github.io/agentscript/models?fire

The Github page can be used as a CDN for experimental use:

Files

Our directory layout is:

bin: workflow scripts
dist: the umd and esm bundles with their min.js versions.
docs: gh-page
models: sample models used for tests and demos
src: individual agentscript es6 modules
test: test files

License

Copyright Owen Densmore, RedfishGroup LLC, 2012-2018
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/.

You can’t perform that action at this time.