Skip to main content

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.

Project description

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

We recommend to install sfctools in a fresh Python 3.8 environment. For example, with conda, do

conda create --name sfcenv python=3.8
conda activate sfcenv
conda install pip

Then, in a terminal of your choice, type:

pip install sfctools

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

Usage with Graphical User Interface 'Attune'

Type

python -m sfctools attune

to start the GUI.

Usage inside Python

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

Running examples

| Author Thomas Baldauf, German Aerospace Center (DLR), Curiestr. 4 70563 Stuttgart | thomas.baldauf@dlr.de |

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sfctools-1.0.5.3.tar.gz (559.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sfctools-1.0.5.3-py3-none-any.whl (337.8 kB view details)

Uploaded Python 3

File details

Details for the file sfctools-1.0.5.3.tar.gz.

File metadata

  • Download URL: sfctools-1.0.5.3.tar.gz
  • Upload date:
  • Size: 559.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.9.12 Windows/10

File hashes

Hashes for sfctools-1.0.5.3.tar.gz
Algorithm Hash digest
SHA256 acb7c2da100f7786d292f6752f195210e76947c80cc54be256ecec849e6e4ac1
MD5 3f10e36b977a612e83eef10a68c55949
BLAKE2b-256 b3b9fa97f5c826cd4bf615940150ea68cb92e9c3d6c87775d0b71cac61e72833

See more details on using hashes here.

File details

Details for the file sfctools-1.0.5.3-py3-none-any.whl.

File metadata

  • Download URL: sfctools-1.0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 337.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.9.12 Windows/10

File hashes

Hashes for sfctools-1.0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 45978fd67e9f2d1af0878452f3795692fc98cf92a12eb93905696454de0f7e3b
MD5 8c749909a8a2a952a82e33e29eefd9fc
BLAKE2b-256 9a027c4c476b74cf005edefe36a4c4bbef16296526b8af179e2d218318088beb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page