% Fierce Planet

Fierce Planet

Fierce Planet is an open source toolkit for developing agent-based models, with a focus on urban and social simulations.

It runs on Node.js on the server, and uses Three.js extensively to generate 3D simulations in the browser. Click here to check your browser is compatible.

For more information, please visit:

• Fierce Planet
• GitHub

Running Fierce Planet

To run Fierce Planet locally:

• Clone the repository

• Ensure the following dependencies are installed:

  • Node
  • Gulp

• Then run:

  cd fp npm install gulp dist node app.js

• You should then be able to visit http://localhost:3000 to view the example and built-in project simulations.

In addition, a number of other commands can be run using gulp:

Building the source

To generate code documentation, run:

    gulp require

Generating code docs

To generate code documentation, run:

    gulp jsdoc

Generating the website

To convert the HTML website content from the Markdown docs:

    gulp pandoc-site

Running Babel to convert ES6 code to ES5

A small amount of code currently uses ES6 for convenience. To convert this code to ES5, run:

    gulp babel-shader

Code Layout

The code includes the following

• docs: The text content of the website, in Markdown format.
• public: All assets (HTML, JavaScript, stylesheets, images, etc.) needed to run Fierce Planet.
• public/js/fp: The source code for running Fierce Planet simulations.
• public/examples: Examples of how Fierce Planet can be configured.
• public/projects: Project that use and extend Fierce Planet.