mirror of
https://github.com/JHUAPL/kami.git
synced 2026-01-08 06:23:52 -05:00
71 lines
2.7 KiB
ReStructuredText
71 lines
2.7 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
.. image:: https://github.com/JHUAPL/kami/actions/workflows/build-main.yml/badge.svg?branch=main
|
|
:target: https://github.com/JHUAPL/kami/actions/workflows/build-main.yml
|
|
:alt: Build Status (main)
|
|
.. image:: https://github.com/JHUAPL/kami/actions/workflows/build-develop.yml/badge.svg?branch=develop
|
|
:target: https://github.com/JHUAPL/kami/actions/workflows/build-develop.yml
|
|
:alt: Build Status (develop)
|
|
.. image:: https://readthedocs.org/projects/kami/badge/?version=main
|
|
:target: https://kami.readthedocs.io/en/main/
|
|
:alt: Documentation Status
|
|
.. image:: https://img.shields.io/github/release/JHUAPL/kami.svg
|
|
:target: https://github.com/JHUAPL/kami/releases
|
|
:alt: Release Status
|
|
.. image:: https://img.shields.io/github/license/JHUAPL/kami
|
|
:alt: License Information
|
|
.. image:: https://img.shields.io/badge/DOI-10.5281%2Fzenodo.6975259-success.svg
|
|
:target: https://doi.org/10.5281/zenodo.6975259
|
|
:alt: Package DOI
|
|
|
|
Kami is Agent-Based Modeling in Modern C++.
|
|
|
|
Overview
|
|
========
|
|
|
|
Agent-based models (ABMs) are models for simulating the actions of
|
|
individual actors within a provided environment to understand the
|
|
behavior of the agents, most individually and collectively. ABMs
|
|
are particularly suited for addressing problems governed by nonlinear
|
|
processes or where there is a wide variety of potential responses
|
|
an individual agent may provide depending on the environment and
|
|
behavior of other agents. Because of this, ABMs have become powerful
|
|
tools in both simulation and modeling, especially in public health
|
|
and ecology, where they are also known as individual-based models.
|
|
ABMs also provide support in economic, business, robotics, and many
|
|
other fields.
|
|
|
|
Design Objectives
|
|
-----------------
|
|
|
|
Kami provides agent-based modeling modern C++. The objectives in
|
|
writing Kami are that it be lightweight, memory-efficient, and fast.
|
|
It should be possible to develop a simple working model in under
|
|
one hour of C++ development time. Accordingly, the platform is
|
|
modeled on the Mesa_ library in Python, which itself was inspired
|
|
by the MASON_ library in Java.
|
|
|
|
Many ABM platforms are designed around interaction and real time
|
|
observation of the agent dynamics. Kami does not provide a
|
|
visualization interface. Instead, Kami is meant to be used for
|
|
ABMs requiring many runs with different starting conditions.
|
|
Accordingly, Kami is single-threaded and multiple cores should be
|
|
taken advantage of through multiple parallel runs of the supervising
|
|
model.
|
|
|
|
.. _MASON: https://cs.gmu.edu/~eclab/projects/mason/
|
|
.. _Mesa: https://mesa.readthedocs.io
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
:maxdepth: 2
|
|
|
|
installation
|
|
abm
|
|
tutorial
|
|
api/library_root
|
|
examples/index
|
|
changelog
|
|
todo
|
|
license |