Skip to content

A Package providing multiple tools for the statistical analysis and treatment of macroeconomic simulation models, with a particular focus on Agent-based and Stock-Flow Consistent Models

License

Notifications You must be signed in to change notification settings

KarlNaumann/MacroStat

Repository files navigation

Built Status PyPI-Server Documentation Status Coveralls Project generated with PyScaffold

MacroStat

A Package providing multiple tools for the statistical analysis and treatment of macroeconomic simulation models, with a particular focus on Agent-based and Stock-Flow Consistent Models

The purpose of this project is to provide a statistical toolbox for the analysis of Agent-based Models. The toolbox is developed in python and aims to provide a simple interface for researchers to attach their model, such that simulations can be steered from within the toolbox and the relevant analysis can be run (such as sensitivities, confidence intervals, and simulation studies). Only the analysis itself requires python, while the models can be written in any language.

The code was developed using Python 3.10. Backwards compatibility is not guaranteed

Roadmap

Some features that are currently under development:

  1. diff: Implementation of numerical differentiation using parallel processing and a wrapper for PyTorch to compute Jacobians and Hessians
  2. sample: Implementation of further common samplers (e.g. MC, MCMC)
  3. analysis: Implementation of basic statistical tests following Vandin et al. "Automated and distributed statistical analysis of economic agent-based models"
  4. models: Starting a library of basic macroeconomic models such as the basic models from https://macrosimulation.org/, the SFC models of Godley & Lavoie, and agent-based models such as Mark-0
  5. explore: Implementation of parameter-space analysis approaches such as the alogirthm of Naumann-Woleske et al. (2024)

Installation

This project requires Python v3.10 or later.

To install the latest version of the package from PyPI:

pip install macrostat

Or, directly from GitHub:

pip install git+https://github.com/KarlNaumann/MacroStat.git#egg=macrostat

If you'd like to contribute to the package, please read the CONTRIBUTING.md guide.

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd MacroStat
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Don't forget to tell your contributors to also install and use pre-commit.

Contact

Karl Naumann-Woleske - karlnaumann.com

Project Link: [https://github.com/KarlNaumann/MacroStat](https://github.com/KarlNaumann/MacroStat)

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.

About

A Package providing multiple tools for the statistical analysis and treatment of macroeconomic simulation models, with a particular focus on Agent-based and Stock-Flow Consistent Models

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages