AtHeartEngineer/kami
1
0
Fork 0
mirror of https://github.com/JHUAPL/kami.git synced 2026-01-09 23:07:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updates to documentation

Browse Source
This commit is contained in:
James P. Howard, II
2021-07-20 12:16:06 -04:00
parent 382e074b7e
commit c4f369407b
6 changed files with 136 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/index.rst
View File

@@ -1,13 +1,24 @@
Kami is Agent-Based Modeling in Modern C++
==========================================
Introduction
============
|Build|
.. |Build| image:: https://github.com/k3jph/kami/actions/workflows/build.yml/badge.svg
:target: https://github.com/k3jph/kami/actions/workflows/build.yml
Kami is 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
extensively on the `Mesa
<https://mesa.readthedocs.io/en/stable/overview.html>`_ library in
Python, which itself was inspired by the `MASON
<https://cs.gmu.edu/~eclab/projects/mason/>`_ library in Java.
.. toctree::
:maxdepth: 2
:hidden:
about
tutorial
api/library_root
license