.. AdjSim documentation master file, created by
   sphinx-quickstart on Mon Oct 16 23:10:29 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

AdjSim Class Documentation
==========================

At its core, AdjSim is an agent-based modelling engine. It allows users to define simulation environments through which agents interact through ability casting and timestep iteration. The framework is targeted towards agents that behave intelligently, for example a bacterium chasing down food. However, the framework is extremely flexible - from enabling physics simulation to defining an environment in which Conway's Game of Life plays out! AdjSim aims to be a foundational architecture on top of which reinforcement learning can be built.

External Navigation
-------------------

1. `AdjSim Feature Abstract <https://github.com/SeverTopan/AdjSim>`__
2. `Installation Instructions <https://github.com/SeverTopan/AdjSim/blob/master/INSTALL.md>`__
3. `Tutorial <https://github.com/SeverTopan/AdjSim/blob/master/tutorial/tutorial.ipynb>`__

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   adjsim.rst

Indices and Tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`