Metadata-Version: 2.1
Name: sfctools
Version: 0.8
Summary: Framework for stock-flow consistent agent-based modeling, being developed at the German Aerospace Center (DLR) for and in the scientific context of energy systems analysis, however, it is widely applicable in other scientific fields.
Home-page: https://gitlab.com/dlr-ve/esy/sfctools/framework
License: MIT
Keywords: stock-flow-consistent,agent-based,agent,macroeconomics,computational economics
Author: Thomas Baldauf, Benjamin Fuchs
Author-email: thomas.baldauf@dlr.de, benjamin.fuchs@dlr.de
Maintainer: Thomas Baldauf
Maintainer-email: thomas.baldauf@dlr.de
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: attrs (>=19,<20)
Requires-Dist: cattrs (==1.0.0)
Requires-Dist: graphviz (>=0.19,<0.20)
Requires-Dist: matplotlib (>=3.4,<4.0)
Requires-Dist: networkx (>=2.6.3,<3.0.0)
Requires-Dist: numpy (>=1.20.1,<2.0.0)
Requires-Dist: pandas (>=1.0,<2.0)
Requires-Dist: pdflatex (>=0.1,<0.2)
Requires-Dist: poetry (>=1.1.6,<2.0.0)
Requires-Dist: pydot (>=1.4,<2.0)
Requires-Dist: pyperclip (>=1.8,<2.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: seaborn (>=0.11.2,<0.12.0)
Requires-Dist: setuptools (>=60.0.0,<61.0.0)
Requires-Dist: wheel (>=0.36.2,<0.37.0)
Project-URL: Documentation, https://sfctools-framework.readthedocs.io/en/latest/
Description-Content-Type: text/markdown

# sfctools - A toolbox for stock-flow consistent, agent-based models

Sfctools is a lightweight and easy-to-use Python framework for agent-based macroeconomic, stock-flow consistent (ABM-SFC) modeling. It concentrates on agents in economics and helps you to construct agents, helps you to manage and document your model parameters, assures stock-flow consistency, and facilitates basic economic data structures (such as the balance sheet).


## Installation 

In a terminal of your choice, type: 

    pip install sfctools 

see https://pypi.org/project/sfctools/


## Usage

```console
from sfctools import Agent,World
class MyAgent(Agent):
    def __init__(self, a):
        super().__init__(self)
        self. = a 
my_agent = MyAgent()
print(my_agent)
print(World().get_agents_of_type("MyAgent"))
```


| Author Thomas Baldauf, German Aerospace Center (DLR), Curiestr. 4 70563 Stuttgart | thomas.baldauf@dlr.de | version: 0.5 (Beta) | date: February 2022

