From 2027ff05eb3d10ac34c92d7a09eae36424d03879 Mon Sep 17 00:00:00 2001 From: "James P. Howard, II" Date: Thu, 23 Sep 2021 15:38:00 -0400 Subject: [PATCH] Reworked Overview and TOC --- docs/changelog.rst | 2 ++ docs/index.rst | 40 ++++------------------------------------ docs/license.rst | 4 +++- docs/overview.rst | 37 +++++++++++++++++++++++++++++++++++++ 4 files changed, 46 insertions(+), 37 deletions(-) create mode 100644 docs/overview.rst diff --git a/docs/changelog.rst b/docs/changelog.rst index 47c604a..020daf1 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -7,3 +7,5 @@ Changelog - :release:`0.3.0 <2021.09.20>` - :feature:`0` Initial public release. + +.. toctree:: diff --git a/docs/index.rst b/docs/index.rst index ad7803c..1e1c696 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,6 @@ Introduction ============ - .. image:: https://github.com/JHUAPL/kami/actions/workflows/build.yml/badge.svg?branch=main :target: https://github.com/JHUAPL/kami/actions/workflows/build.yml :alt: Build Status (main) @@ -17,46 +16,15 @@ Introduction .. image:: https://img.shields.io/github/license/JHUAPL/kami :alt: License Information -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 +Kami is Agent-Based Modeling in Modern C++. .. toctree:: - :maxdepth: 2 :hidden: + :maxdepth: 2 - index + overview installation tutorial api/library_root changelog - license + license \ No newline at end of file diff --git a/docs/license.rst b/docs/license.rst index c8fa638..ea67f52 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -22,4 +22,6 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. + +.. toctree:: diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..5fd154d --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,37 @@ +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::