Metadata-Version: 2.4
Name: MacroStat
Version: 0.6.0
Summary: Tools for the statistical analysis and treatment of macroeconomic simulation models, with a focus on Agent-based and Stock-Flow Consistent Models
Author-email: Karl Naumann-Woleske <karl.naumann@icloud.com>
License-Expression: MIT
Project-URL: Source, https://github.com/KarlNaumann/MacroStat/
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: dash
Requires-Dist: dash-cytoscape
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: torch
Requires-Dist: tqdm
Provides-Extra: io
Requires-Dist: fastparquet; extra == "io"
Requires-Dist: openpyxl; extra == "io"
Requires-Dist: pyarrow>=15; extra == "io"
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Provides-Extra: docs
Requires-Dist: myst-nb>=1.4.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-design>=0.7.0; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex>=2.6.5; extra == "docs"
Dynamic: license-file

.. These are examples of badges you might want to add to your README:
   please update the URLs accordingly

    .. image:: https://img.shields.io/conda/vn/conda-forge/MacroStat.svg
        :alt: Conda-Forge
        :target: https://anaconda.org/conda-forge/MacroStat
    .. image:: https://pepy.tech/badge/MacroStat/month
        :alt: Monthly Downloads
        :target: https://pepy.tech/project/MacroStat
    .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
        :alt: Twitter
        :target: https://twitter.com/MacroStat


.. image:: https://github.com/KarlNaumann/MacroStat/actions/workflows/ci.yml/badge.svg?branch=master
     :alt: Build Status
     :target: https://github.com/KarlNaumann/MacroStat/actions/workflows/ci.yml
.. image:: https://img.shields.io/pypi/v/MacroStat.svg
  :alt: PyPI-Server
  :target: https://pypi.org/project/MacroStat/
.. image:: https://readthedocs.org/projects/macrostat/badge/?version=stable
    :target: https://macrostat.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status
.. image:: https://img.shields.io/coveralls/github/KarlNaumann/MacroStat/master.svg
     :alt: Coveralls
     :target: https://coveralls.io/r/KarlNaumann/MacroStat
.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
    :alt: Project generated with PyScaffold
    :target: https://pyscaffold.org/

=========
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

.. _uv: https://github.com/astral-sh/uv

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.

.. _pre-commit: https://pre-commit.com/

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