MacroStat 0.6.0

Tools for the statistical analysis and treatment of macroeconomic simulation models, with a focus on Agent-based and Stock-Flow Consistent Models

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

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

Continuous Integration

MacroStat runs on GitHub Actions across Linux (ubuntu-latest) and Windows (windows-latest) for Python 3.11, 3.12, and 3.13. The full test suite including slow-marked tests runs nightly on master. macOS is not currently covered; it is tracked as a follow-up before the planned JOSS submission.

Development Installation

For development, install the package in editable mode. This project uses uv for dependency management:

uv sync                    # Install all dependencies
uv pip install -e .        # Install package in editable mode

After this, you can run tests with:

uv run pytest

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/.