kami

Kami is Agent-Based Modeling in Modern C++

https://github.com/jhuapl/kami

Science Score: 65.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization jhuapl has institutional domain (www.jhuapl.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

agent-based-modeling cmake conan cplusplus-20 cybernetics simulation systems-theory
Last synced: 6 months ago · JSON representation ·

Repository

Kami is Agent-Based Modeling in Modern C++

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 11
Topics
agent-based-modeling cmake conan cplusplus-20 cybernetics simulation systems-theory
Created almost 5 years ago · Last pushed about 3 years ago
Metadata Files
Readme Citation

README.md

Build (main) Build (develop) Documentation status Release status License DOI

Kami is Agent-Based Modeling in Modern C++

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.

Compiling

```Bash

Build, test and install the library

git clone https://github.com/k3jph/kami.git cd kami conan install -if build . cmake -B build -DBUILDSHAREDLIBS:BOOL=FALSE cmake --build build cmake --build build --target test cmake --build build --target install ```

Conan Package Manager

This library comes with a conanfile.py to build it into a Conan package so that it may be used by external applications/libraries.

Create Conan Packages

Creating a Conan package is relatively easy. Simple cd into the source directory and execute the conan create function.

```bash git clone https://github.com/k3jph/kami.git cd kami

conan create . kami/develop ```

Direct Dependencies

CLI11 and spdlog are both used extensively in the examples. Neither is used directly by the Kami library.

Contribution guidelines

For more information

Owner

  • Name: Johns Hopkins Applied Physics Laboratory
  • Login: JHUAPL
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Kami is Agent-Based Modeling in Modern C++
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
license: MIT
repository-code: "https://github.com/JHUAPL/kami"
authors:
  - given-names: James Patrick
    family-names: Howard
    name-suffix: II
    email: james.howard@jhu.edu
    affiliation: Johns Hopkins Applied Physics Laboratory
    orcid: 'https://orcid.org/0000-0003-4530-1547'
keywords:
  - "agent-based modelling"
  - research
identifiers:
  - description: "This is the collection of archived snapshots of all versions of Kami"
    type: doi
    value: 10.5281/zenodo.6975259

GitHub Events

Total
Last Year

Dependencies

.github/workflows/build-develop.yml actions
  • actions/checkout v2 composite
  • turtlebrowser/get-conan main composite
.github/workflows/build-main.yml actions
  • actions/checkout v2 composite
  • turtlebrowser/get-conan main composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/init v2 composite
  • turtlebrowser/get-conan main composite
docs/requirements.txt pypi
  • Sphinx ==4.5.0
  • breathe ==4.34.0
  • documenteer ==0.7.0
  • exhale ==0.3.6
  • myst-parser ==0.18.1
  • releases ==1.6.3
  • sphinx-bootstrap-theme ==0.8.1
  • sphinx-rtd-theme ==1.1.1