ssb-model-solver 1.2.0__tar.gz

ssb_model_solver-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2024 Statistics Norway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ssb_model_solver-1.2.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: ssb-model-solver
+Version: 1.2.0
+Summary: Class to define, block analyse and solve dynamic and algebraic models numerically
+Home-page: https://github.com/statisticsnorway/ssb-model-solver
+License: MIT
+Author: Benedikt Goodman
+Author-email: benedikt.goodman@ssb.no
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: matplotlib (>=3.7.1)
+Requires-Dist: networkx (>=3.3)
+Requires-Dist: numba (>=0.57.0)
+Requires-Dist: numpy (>=1.26)
+Requires-Dist: pandas (>=2.0)
+Requires-Dist: symengine (>=0.9.2)
+Project-URL: Changelog, https://github.com/statisticsnorway/ssb-model-solver/releases
+Project-URL: Documentation, https://statisticsnorway.github.io/ssb-model-solver
+Project-URL: Repository, https://github.com/statisticsnorway/ssb-model-solver
+Description-Content-Type: text/markdown
+
+# SSB Model Solver
+
+[![PyPI](https://img.shields.io/pypi/v/ssb-model-solver.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/ssb-model-solver.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/ssb-model-solver)][pypi status]
+[![License](https://img.shields.io/pypi/l/ssb-model-solver)][license]
+
+[![Documentation](https://github.com/statisticsnorway/ssb-model-solver/actions/workflows/docs.yml/badge.svg)][documentation]
+[![Tests](https://github.com/statisticsnorway/ssb-model-solver/actions/workflows/tests.yml/badge.svg)][tests]
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-model-solver&metric=coverage)][sonarcov]
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-model-solver&metric=alert_status)][sonarquality]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
+
+[pypi status]: https://pypi.org/project/ssb-model-solver/
+[documentation]: https://statisticsnorway.github.io/ssb-model-solver
+[tests]: https://github.com/statisticsnorway/ssb-model-solver/actions?workflow=Tests
+
+[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-model-solver
+[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-model-solver
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+[poetry]: https://python-poetry.org/
+
+`ModelSolver` is a class that defines, block analyses and solves dynamic and algebraic models numerically.
+See [documentation](https://github.com/statisticsnorway/model-solver/blob/main/model-solver.pdf) for detailed information about theory and implementation of the class.
+
+Opprettet av:
+Magnus Kvåle Helliesen <mkh@ssb.no>
+
+## Features
+
+ModelSolver is a Python class. It defines, analyses and solves dynamic algebraic model with lots of equations.
+
+The package is imported using
+
+```python
+import model_solver as ms
+```
+
+Usage is
+
+```python
+model = ms.ModelSolver(equations, endogenous)
+```
+
+where `equations` are equations and `endogenous` are endogenous variables, both stored as strings in lists.
+
+## Built with
+ModelSolver uses the following packages
+* [NumPy](https://numpy.org/)
+* [NetworkX](https://networkx.org/)
+* [Pandas](https://pandas.pydata.org/)
+* [SymEngine](https://pypi.org/project/symengine/)
+* [Numba](https://numba.pydata.org/)
+* [collections](https://docs.python.org/3/library/collections.html)
+* [functools](https://docs.python.org/3/library/functools.html)
+* [Matplotlib](https://matplotlib.org/)
+
+## Example of use
+Let `equations = ['x+y = 1', 'x-y = 2']` and `endogenous = ['x', 'y']`, then the model class is initialized by
+
+```python
+model = ms.ModelSolver(equations, endogenous)
+```
+
+When initialized, the class reads in the equations, analyzes them for any lags, before it block analyzes it to find the smalles model blocks that must be solved simultaneously.
+Note that ModelSolver is not case sensitive, such that 'x' and 'X' are the same, both in equations, lists and dataframe (below).
+
+When the class is finished initializing, the user can call the following methods:
+* ```solution = model.solve(dataframe)``` where `dataframe` is a **Pandas** dataframe containing initial values for the endogenous variables and values for the exogenous variables. `solution` is a dataframe with same dimensions as `dataframe` containing the solutions for the endogenous variables.
+* ```model.switch_endo_vars(old_endo_var, new_endo_var)``` switches the endogenous variables `old_endo_var` for `new_endo_var`.
+* ```model.describe()``` writes out information about the model: the number of blocks, the size of the blocks etc.
+* ```model.find_endo_var('var')``` returns the block number in which `var` is solved for.
+* ```model.show_block(block_number)``` returns information about the block: endogenous variables, predetermined variables and equations.
+* ```model.show_blocks()``` returns information about all blocks.
+* ```model.trace_to_exog_vars(block_nunber)``` traces back to the exogenous variables that may affect the block.
+* ```model.trace_to_exog_vals(block_nunber, period_index)``` traces back to the exogenous variable values for the period.
+* ```model.draw_blockwise_graph(variable, maximum_ancestor_generations, maximum_decendants_generations)``` where `variable` is a variable of interest, and `maximum_ancestor_generations` and `maximum_decendants_generations`are non-negative integers that governs the number of generations before and after the variable to be graphed. The output is a HTML-file with a relational graph.
+* ```model.sensitivity(block_nunber, period_index[, method='std', exog_subset=None])``` analyses the sensitivity of the endogenous variable in the block with respect to the exogenous variabels that determine the solution for the period.
+
+## Installation
+
+You can install _SSB Model Solver_ via [pip] from [PyPI]:
+
+```console
+pip install ssb-model-solver
+```
+
+## Usage
+
+Please see the [Reference Guide] for details.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB Model Solver_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-model-solver/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-model-solver/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-model-solver/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-model-solver/reference.html
+

ssb_model_solver-1.2.0/README.md

@@ -0,0 +1,126 @@
+# SSB Model Solver
+
+[![PyPI](https://img.shields.io/pypi/v/ssb-model-solver.svg)][pypi status]
+[![Status](https://img.shields.io/pypi/status/ssb-model-solver.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/ssb-model-solver)][pypi status]
+[![License](https://img.shields.io/pypi/l/ssb-model-solver)][license]
+
+[![Documentation](https://github.com/statisticsnorway/ssb-model-solver/actions/workflows/docs.yml/badge.svg)][documentation]
+[![Tests](https://github.com/statisticsnorway/ssb-model-solver/actions/workflows/tests.yml/badge.svg)][tests]
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-model-solver&metric=coverage)][sonarcov]
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_ssb-model-solver&metric=alert_status)][sonarquality]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
+
+[pypi status]: https://pypi.org/project/ssb-model-solver/
+[documentation]: https://statisticsnorway.github.io/ssb-model-solver
+[tests]: https://github.com/statisticsnorway/ssb-model-solver/actions?workflow=Tests
+
+[sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-model-solver
+[sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_ssb-model-solver
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+[poetry]: https://python-poetry.org/
+
+`ModelSolver` is a class that defines, block analyses and solves dynamic and algebraic models numerically.
+See [documentation](https://github.com/statisticsnorway/model-solver/blob/main/model-solver.pdf) for detailed information about theory and implementation of the class.
+
+Opprettet av:
+Magnus Kvåle Helliesen <mkh@ssb.no>
+
+## Features
+
+ModelSolver is a Python class. It defines, analyses and solves dynamic algebraic model with lots of equations.
+
+The package is imported using
+
+```python
+import model_solver as ms
+```
+
+Usage is
+
+```python
+model = ms.ModelSolver(equations, endogenous)
+```
+
+where `equations` are equations and `endogenous` are endogenous variables, both stored as strings in lists.
+
+## Built with
+ModelSolver uses the following packages
+* [NumPy](https://numpy.org/)
+* [NetworkX](https://networkx.org/)
+* [Pandas](https://pandas.pydata.org/)
+* [SymEngine](https://pypi.org/project/symengine/)
+* [Numba](https://numba.pydata.org/)
+* [collections](https://docs.python.org/3/library/collections.html)
+* [functools](https://docs.python.org/3/library/functools.html)
+* [Matplotlib](https://matplotlib.org/)
+
+## Example of use
+Let `equations = ['x+y = 1', 'x-y = 2']` and `endogenous = ['x', 'y']`, then the model class is initialized by
+
+```python
+model = ms.ModelSolver(equations, endogenous)
+```
+
+When initialized, the class reads in the equations, analyzes them for any lags, before it block analyzes it to find the smalles model blocks that must be solved simultaneously.
+Note that ModelSolver is not case sensitive, such that 'x' and 'X' are the same, both in equations, lists and dataframe (below).
+
+When the class is finished initializing, the user can call the following methods:
+* ```solution = model.solve(dataframe)``` where `dataframe` is a **Pandas** dataframe containing initial values for the endogenous variables and values for the exogenous variables. `solution` is a dataframe with same dimensions as `dataframe` containing the solutions for the endogenous variables.
+* ```model.switch_endo_vars(old_endo_var, new_endo_var)``` switches the endogenous variables `old_endo_var` for `new_endo_var`.
+* ```model.describe()``` writes out information about the model: the number of blocks, the size of the blocks etc.
+* ```model.find_endo_var('var')``` returns the block number in which `var` is solved for.
+* ```model.show_block(block_number)``` returns information about the block: endogenous variables, predetermined variables and equations.
+* ```model.show_blocks()``` returns information about all blocks.
+* ```model.trace_to_exog_vars(block_nunber)``` traces back to the exogenous variables that may affect the block.
+* ```model.trace_to_exog_vals(block_nunber, period_index)``` traces back to the exogenous variable values for the period.
+* ```model.draw_blockwise_graph(variable, maximum_ancestor_generations, maximum_decendants_generations)``` where `variable` is a variable of interest, and `maximum_ancestor_generations` and `maximum_decendants_generations`are non-negative integers that governs the number of generations before and after the variable to be graphed. The output is a HTML-file with a relational graph.
+* ```model.sensitivity(block_nunber, period_index[, method='std', exog_subset=None])``` analyses the sensitivity of the endogenous variable in the block with respect to the exogenous variabels that determine the solution for the period.
+
+## Installation
+
+You can install _SSB Model Solver_ via [pip] from [PyPI]:
+
+```console
+pip install ssb-model-solver
+```
+
+## Usage
+
+Please see the [Reference Guide] for details.
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_SSB Model Solver_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+This project was generated from [Statistics Norway]'s [SSB PyPI Template].
+
+[statistics norway]: https://www.ssb.no/en
+[pypi]: https://pypi.org/
+[ssb pypi template]: https://github.com/statisticsnorway/ssb-pypitemplate
+[file an issue]: https://github.com/statisticsnorway/ssb-model-solver/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/statisticsnorway/ssb-model-solver/blob/main/LICENSE
+[contributor guide]: https://github.com/statisticsnorway/ssb-model-solver/blob/main/CONTRIBUTING.md
+[reference guide]: https://statisticsnorway.github.io/ssb-model-solver/reference.html

ssb_model_solver-1.2.0/pyproject.toml

@@ -0,0 +1,156 @@
+[tool.poetry]
+name = "ssb-model-solver"
+version = "1.2.0"
+description = "Class to define, block analyse and solve dynamic and algebraic models numerically"
+authors = ["Benedikt Goodman <benedikt.goodman@ssb.no>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/statisticsnorway/ssb-model-solver"
+repository = "https://github.com/statisticsnorway/ssb-model-solver"
+documentation = "https://statisticsnorway.github.io/ssb-model-solver"
+packages = [{ include = "model_solver", from = "src" }]
+classifiers = ["Development Status :: 4 - Beta"]
+
+[tool.poetry.urls]
+Changelog = "https://github.com/statisticsnorway/ssb-model-solver/releases"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+symengine = ">=0.9.2"
+matplotlib = ">=3.7.1"
+numba = ">=0.57.0"
+numpy = ">=1.26"
+pandas = ">=2.0"
+networkx = ">=3.3"
+
+[tool.poetry.group.dev.dependencies]
+pygments = ">=2.10.0"
+black = { extras = ["jupyter"], version = ">=23.1.0" }
+coverage = { extras = ["toml"], version = ">=6.2" }
+darglint = ">=1.8.1"
+furo = ">=2021.11.12"
+mypy = ">=0.930"
+pre-commit = ">=2.16.0"
+pre-commit-hooks = ">=4.1.0"
+ruff = ">=0.0.284"
+pytest = ">=6.2.5"
+sphinx = ">=6.2.1"
+sphinx-autobuild = ">=2021.3.14"
+sphinx-autodoc-typehints = ">=1.24.0"
+sphinx-click = ">=3.0.2"
+typeguard = ">=2.13.3"
+xdoctest = { extras = ["colors"], version = ">=0.15.10" }
+myst-parser = { version = ">=0.16.1" }
+pandas-stubs = ">=2.2.2.240807"
+ipykernel = ">=6.29.5"
+deptry = ">=0.20.0"
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+tests = ["tests", "*/tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["model_solver", "tests"]
+relative_files = true
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 50
+
+[tool.mypy]
+strict = true
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_context = true
+disallow_any_generics = false
+
+[[tool.mypy.overrides]]
+module = [
+#    "matplotlib",
+#    "matplotlib.pyplot",
+    "networkx.*",
+    "numba.*",
+    "symengine.*",
+]
+ignore_missing_imports = true
+
+[tool.ruff]
+force-exclude = true  # Apply excludes to pre-commit
+show-fixes = true
+src = ["src", "tests"]
+target-version = "py310"  # Minimum Python version supported
+include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
+extend-exclude = [
+    "__pycache__",
+    "old",
+    ".ipynb_checkpoints",
+    "noxfile.py",
+    "docs/conf.py",
+]
+
+# Ruff rules may be customized as desired: https://docs.astral.sh/ruff/rules/
+[tool.ruff.lint]
+select = [
+    "A",    # prevent using keywords that clobber python builtins
+    "ANN",  # check type annotations
+    "B",    # bugbear: security warnings
+    "D",    # documentation
+    "E",    # pycodestyle
+    "F",    # pyflakes
+    "ISC",  # implicit string concatenation
+    "I",    # sort imports
+    "UP",   # alert you when better syntax is available in your python version
+    "RUF",  # the ruff developer's own rules
+]
+ignore = [
+    "ANN101", # Supress missing-type-self.
+    "ANN102", # Supress missing-type-cls.
+    "ANN202", # Don't requiere return type annotation for private functions.
+    "ANN401", # Allow type annotation with type Any.
+    "D100",   # Supress undocumented-public-module. Only doc of public api required.
+    "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
+    "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"  # You can also use "numpy".
+
+[tool.ruff.lint.pep8-naming]
+classmethod-decorators = ["classmethod", "validator", "root_validator", "pydantic.validator"]
+
+[tool.ruff.lint.per-file-ignores]
+"*/__init__.py" = ["F401"]
+"**/tests/*" = [
+    "ANN001",  # type annotations don't add value for test functions
+    "ANN002",  # type annotations don't add value for test functions
+    "ANN003",  # type annotations don't add value for test functions
+    "ANN201",  # type annotations don't add value for test functions
+    "ANN204",  # type annotations don't add value for test functions
+    "ANN205",  # type annotations don't add value for test functions
+    "ANN206",  # type annotations don't add value for test functions
+    "D100",    # docstrings are overkill for test functions
+    "D101",
+    "D102",
+    "D103",
+    "S101",    # asserts are encouraged in pytest
+]
+
+[tool.jupytext]
+formats = "ipynb,auto:percent"
+notebook_metadata_filter = "jupytext.text_representation,-jupytext.text_representation.jupytext_version,-widgets,-varInspector"
+cell_metadata_filter = "-papermill,tags"
+
+[tool.deptry.per_rule_ignores]
+DEP001 = ["src", "nox", "nox_poetry"]  # packages available by default
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

ssb_model_solver-1.2.0/src/model_solver/__init__.py

@@ -0,0 +1,5 @@
+"""SSB Model Solver."""
+
+from .model_solver import ModelSolver
+
+__all__ = ["ModelSolver"]