Welcome to the sfctools documentation page!

sfctools is an ABM-SFC modeling suite for agent-based macroeconomic, stock-flow consistent (ABM-SFC) modeling. Unlike more generic frameworks like mesa or AgentPy, it concentrates on agents in economics. It further is a toolbox which helps you to construct agents, helps you to ensure stock-flow consistency and facilitates basic economic data structures (such as the balance sheet).

Getting Started

• Installation

Quick start:

pip install sfctools

About This Software

• Context and Scope
• Framework Structure
• Ongoing Development

You can cite the software as follows:

Baldauf, T., (2023). sfctools - A toolbox for stock-flow consistent, agent-based models. Journal of Open Source Software, 8(87), 4980, https://doi.org/10.21105/joss.04980

You can cite the software repository as follows:

Thomas Baldauf. (2023). sfctools - A toolbox for stock-flow consistent, agent-based models (1.1.0.2b). Zenodo. https://doi.org/10.5281/zenodo.8118870

GitLab Software repository: click https://gitlab.com/dlr-ve/esy/sfctools/framework

API Handbook

• Getting Started
• Economic Agents
• Additional Data Structures
• Flow Matrix
• World and Settings
• Markets
• Automation
• Miscellaneous

Examples

• Example from Paper
• API Examples
• GUI Examples

sfctools-attune GUI

• The Modeling Workflow
• Getting Started
  • Starting the GUI
  • The Transaction Editor
  • The Transaction View
  • The Graph View
  • Creating an Agent
  • Settings and Parameters

sfctools-attune Language

• sfctools-attune Language Basics
  • Agents
  • Init sequence
  • Read the settings
  • Links between agents
  • Functions (Methods)
  • Custom Imports
  • Transactions
  • Balance Sheet Operations
  • Income Statement

Contact

• Author: Thomas Baldauf

• Contact: thomas.baldauf@dlr.de