modelflowib 2.73__tar.gz

modelflowib-2.73/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: modelflowib
+Version: 2.73
+Summary: A tool to solve and manage dynamic economic and financial models
+Author-email: Ib Hansen <Ib.Hansen.Iv@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/IbHansen/ModelFlow2
+Project-URL: Repository, https://github.com/IbHansen/ModelFlow2
+Keywords: economics,dynamic models,BLL,numba,modelling
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: license.md
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: sympy
+Requires-Dist: numpy
+Requires-Dist: networkx
+Requires-Dist: tqdm
+Requires-Dist: scipy
+Requires-Dist: numexpr
+Requires-Dist: bottleneck
+Requires-Dist: XlsxWriter
+Requires-Dist: pyarrow
+Requires-Dist: tabulate
+Requires-Dist: openpyxl
+Requires-Dist: xarray
+Requires-Dist: cvxopt
+Requires-Dist: numba
+Requires-Dist: dash
+Requires-Dist: dash-bootstrap-components
+Requires-Dist: dash-interactive-graphviz
+Requires-Dist: lmfit
+Requires-Dist: jupyter
+Requires-Dist: ipywidgets
+Requires-Dist: ipydatagrid
+Provides-Extra: shiny
+Requires-Dist: shiny; extra == "shiny"
+Requires-Dist: shinywidgets; extra == "shiny"
+Dynamic: license-file
+
+# ModelFlow
+A Python toolkit to manage models
+
+The easy way to start is here [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/IbHansen/modelflow/master). 
+
+This will start **ModelFlow** as an online Jupyter notebook. Select one of the notebooks (files with the extension .ipynb). Some of the 
+notebooks are ModelFlow related. Other implement different model 
+
+ - FRBUS  will start the FRB/US model from the Federal reserve board. 
+ - Q-JEM will start the Quarterly Japanese Economic Model from Bank of Japan
+ - ADAM will start the Anual Danish Aggregate Model for the Danish Statistical agency. 
+ - Solow will implement a simple textybook Solow model. 
+
+You can also look at the python files of the system. Located at the **modelflow/** folder
+
+Alternative look at the *getting started* section later in this file. It explains how to run ModelFlow localy. 
+
+The **Pandas** library is a great library to handle all kinds of datamanipulation and transformations. 
+
+However when it comes to models which contains lags or models which requires solving simultanous equations, Pandas is not quite helpful. 
+
+ModelFlow extends Pandas to handle a range of such models. And they can be large.  
+
+It requires you to specify the *model* specified as equations (the **business logic**) and place the *data* in a Pandas  **DataFrame**.  ModelFlow allows the model to meet the data and return the result as a new DataFrame. 
+
+A number of **analytical tools for model and result analytic** helps to understand the model and its results.
+
+The user can **extend and modify the tools** to her or his needs.
+
+**Onboarding models and combining models from different sources**. Creating a Macro prudential model often entails recycling several models specified in different ways: Excel, Latex, Dynare, Python or other languages. Python's ecosystem makes it possible to transform many different models into ModelFlow models or to wrap them into functions which can be called from ModelFlow models.
+
+**Models can be specified in a high level Business logic language (a Domain Specific language)**. This allows the formulation of a model in a concise and expressive language which is close to the economic of the model. The user can concentrate on the economic or financial content - not the coding of the solution. The code for solving the model is generated by the tool. Then you can *solve the
+simultaneous* (or *non-simultaneous* model) in an efficient way. 
+
+## Introduction 
+
+**ModelFlow is written in Python**. Python comes "batteries included" and is
+the basis of a very rich ecosystem, which consists of a wide array of
+libraries. ModelFlow is just another library. It supplements the existing
+libraries regarding modeling language and solving and allows the use of
+Python as a model management framework.
+
+**Data handling and wrangling is done in the Pandas library**. This
+library is the Swiss army knife of data science in Python. It can import and export data to most systems and it is very powerful in manipulating and transforming data.
+The core
+element of Pandas is the *Dataframe*. A Dataframe is a two-dimensional
+tabular data structure. Each *column* consists of cells of the same type
+-- it can be a number, a string, a matrix or another Python data object.This includes matrices and other dataframes. Each *row is indexed.* The index can basically be any type of variable
+including dates, which is especially relevant for economic and financial models.
+
+**ModelFlow gives the user tools for more than solving models**. This
+includes:
+
+-   *Visualization* and comparison of results
+
+-   *Integration* of models from different sources
+
+-   *Analyze the logical structure of a model*. By applying graph theory, 
+    ModelFlow can find data lineage, find a suitable calculating sequence and trace 
+    causes of changes through the calculations.
+
+-   *Inverting* the model to calculating the necessary instruments to
+    achieve a desired target.
+
+-   Calculating the *attributions* from input to the results of a model.
+
+-   Calculating the *attribution* from input to the result of each
+    formula.
+
+-   Finding and calculating partial *derivatives* of formulas
+
+-   *Integrating user defined python functions* in the Business logic
+    language (like optimization, calculating risk weights or to make a matrices consistent with the RAS algorithm  )
+
+-   *Wrap matlab* models so they can be used in the Business logic
+    language.
+
+-   *Speed up* solving using "Just in time compilation"
+
+-   Analyze the model structure through tools from graph theory
+
+-   Handle *large models.* 1,000,000 formulas is not a problem.
+
+-   Integrate model management in Jupyter notebooks for *agile and user
+    friendly model use*
+
+
+**The core code of ModelFlow is small and
+documented.** Thus it can easily be modified and expanded to the specific need of the user. *ModelFlow is a toolset*. It can handle models, which conform to the tools.
+
+If you need a feature or have a model which can't be handled in ModelFlow,
+you are encouraged to improve ModelFlow. Please share the
+improvement, other users may have the same need, or can be inspired by
+your work.
+
+Also bear in mind that ModelFlow is experimental. It is provided ”as is”, without any representation or warranty of any kind either express or implied.   
+
+## Getting started
+
+You need Python 3.7+ with asssociated libraries. The easy way is to install Anaconda Python is to download the distribution from [https://www.anaconda.com/distribution](https://www.anaconda.com/distribution)
+
+Now you can install ModelFlow by running a command window from the Anaconda prompt and execute theese commands 
+```
+conda install modelflow -c ibh -c defaults -c conda-forge
+```
+You will find the anaconda prompt by searching "anaconda" in the start menu search field
+
+Try out one of the workbooks. to do this you:
+```
+click on the Adaconda prompth in the Anaconda folder
+cd <The location you have downloaded the workbooks>
+jupyter notebook
+```

modelflowib-2.73/README.md

@@ -0,0 +1,113 @@
+# ModelFlow
+A Python toolkit to manage models
+
+The easy way to start is here [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/IbHansen/modelflow/master). 
+
+This will start **ModelFlow** as an online Jupyter notebook. Select one of the notebooks (files with the extension .ipynb). Some of the 
+notebooks are ModelFlow related. Other implement different model 
+
+ - FRBUS  will start the FRB/US model from the Federal reserve board. 
+ - Q-JEM will start the Quarterly Japanese Economic Model from Bank of Japan
+ - ADAM will start the Anual Danish Aggregate Model for the Danish Statistical agency. 
+ - Solow will implement a simple textybook Solow model. 
+
+You can also look at the python files of the system. Located at the **modelflow/** folder
+
+Alternative look at the *getting started* section later in this file. It explains how to run ModelFlow localy. 
+
+The **Pandas** library is a great library to handle all kinds of datamanipulation and transformations. 
+
+However when it comes to models which contains lags or models which requires solving simultanous equations, Pandas is not quite helpful. 
+
+ModelFlow extends Pandas to handle a range of such models. And they can be large.  
+
+It requires you to specify the *model* specified as equations (the **business logic**) and place the *data* in a Pandas  **DataFrame**.  ModelFlow allows the model to meet the data and return the result as a new DataFrame. 
+
+A number of **analytical tools for model and result analytic** helps to understand the model and its results.
+
+The user can **extend and modify the tools** to her or his needs.
+
+**Onboarding models and combining models from different sources**. Creating a Macro prudential model often entails recycling several models specified in different ways: Excel, Latex, Dynare, Python or other languages. Python's ecosystem makes it possible to transform many different models into ModelFlow models or to wrap them into functions which can be called from ModelFlow models.
+
+**Models can be specified in a high level Business logic language (a Domain Specific language)**. This allows the formulation of a model in a concise and expressive language which is close to the economic of the model. The user can concentrate on the economic or financial content - not the coding of the solution. The code for solving the model is generated by the tool. Then you can *solve the
+simultaneous* (or *non-simultaneous* model) in an efficient way. 
+
+## Introduction 
+
+**ModelFlow is written in Python**. Python comes "batteries included" and is
+the basis of a very rich ecosystem, which consists of a wide array of
+libraries. ModelFlow is just another library. It supplements the existing
+libraries regarding modeling language and solving and allows the use of
+Python as a model management framework.
+
+**Data handling and wrangling is done in the Pandas library**. This
+library is the Swiss army knife of data science in Python. It can import and export data to most systems and it is very powerful in manipulating and transforming data.
+The core
+element of Pandas is the *Dataframe*. A Dataframe is a two-dimensional
+tabular data structure. Each *column* consists of cells of the same type
+-- it can be a number, a string, a matrix or another Python data object.This includes matrices and other dataframes. Each *row is indexed.* The index can basically be any type of variable
+including dates, which is especially relevant for economic and financial models.
+
+**ModelFlow gives the user tools for more than solving models**. This
+includes:
+
+-   *Visualization* and comparison of results
+
+-   *Integration* of models from different sources
+
+-   *Analyze the logical structure of a model*. By applying graph theory, 
+    ModelFlow can find data lineage, find a suitable calculating sequence and trace 
+    causes of changes through the calculations.
+
+-   *Inverting* the model to calculating the necessary instruments to
+    achieve a desired target.
+
+-   Calculating the *attributions* from input to the results of a model.
+
+-   Calculating the *attribution* from input to the result of each
+    formula.
+
+-   Finding and calculating partial *derivatives* of formulas
+
+-   *Integrating user defined python functions* in the Business logic
+    language (like optimization, calculating risk weights or to make a matrices consistent with the RAS algorithm  )
+
+-   *Wrap matlab* models so they can be used in the Business logic
+    language.
+
+-   *Speed up* solving using "Just in time compilation"
+
+-   Analyze the model structure through tools from graph theory
+
+-   Handle *large models.* 1,000,000 formulas is not a problem.
+
+-   Integrate model management in Jupyter notebooks for *agile and user
+    friendly model use*
+
+
+**The core code of ModelFlow is small and
+documented.** Thus it can easily be modified and expanded to the specific need of the user. *ModelFlow is a toolset*. It can handle models, which conform to the tools.
+
+If you need a feature or have a model which can't be handled in ModelFlow,
+you are encouraged to improve ModelFlow. Please share the
+improvement, other users may have the same need, or can be inspired by
+your work.
+
+Also bear in mind that ModelFlow is experimental. It is provided ”as is”, without any representation or warranty of any kind either express or implied.   
+
+## Getting started
+
+You need Python 3.7+ with asssociated libraries. The easy way is to install Anaconda Python is to download the distribution from [https://www.anaconda.com/distribution](https://www.anaconda.com/distribution)
+
+Now you can install ModelFlow by running a command window from the Anaconda prompt and execute theese commands 
+```
+conda install modelflow -c ibh -c defaults -c conda-forge
+```
+You will find the anaconda prompt by searching "anaconda" in the start menu search field
+
+Try out one of the workbooks. to do this you:
+```
+click on the Adaconda prompth in the Anaconda folder
+cd <The location you have downloaded the workbooks>
+jupyter notebook
+```

modelflowib-2.73/license.md

@@ -0,0 +1,10 @@
+Copyright © 2019 Danmarks Nationalbank and ECB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Soft-ware"), 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.
+
+Except as contained in this notice, the name of Danmarks Nationalbank and ECB shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from Danmarks Nationalbank and ECB.
+
+Based on MIT License. 

modelflowib-2.73/modelBLfunk.py

@@ -0,0 +1,180 @@
+# -*- coding: utf-8 -*-
+"""
+Created on Fri Mar  2 17:01:49 2018
+
+@author: hanseni
+
+Functions placed here are included in the Pyfs business language 
+
+"""
+from math import exp, log, sqrt, tanh, erf,isclose
+from numpy import transpose , array
+from scipy.stats import norm,lognorm
+from scipy.stats import gamma
+import inspect 
+
+try:
+    # raise ImportError("Simulating ImportError for numba.")
+
+    from numba import jit
+except ImportError:
+    print("Numba is not available. No worry")
+
+    def jit(*args, **kwargs):
+        def wrapper(func):
+            # print('jit called')
+            return func
+        return wrapper
+    
+@jit("f8(f8)",nopython=True)
+def logit_inverse(number):
+    ''' A function which returns the logit of a number 
+    
+    takes care of extreme values 
+    '''
+    if number > 100:
+        return 1.0
+    elif number < -100:
+        return 0.0
+    else: 
+        return 1/(1+exp(-number))    
+    
+classfunk = []
+try:
+    from cvxopt import matrix
+    from model_cvx import mv_opt, mv_opt_prop
+    classfunk = ['TRANS']    # names a classfunk which can be called 
+except:
+    print('ModelFlow info: CVXopt not installed. Only matters if you are incorporating optimization')
+    pass
+
+from numpy import array
+
+from model_financial_stability import lifetime_credit_loss
+
+def sum_excel(*arg):
+    ''' a functions which sums the arguments used in models franslated from excel 
+    '''
+    return sum(arg)
+    
+def logit(number):
+    ''' A function which returns the logit of a number 
+    '''
+    return(-log(1.0/number-1.0)) 
+
+# @jit("f8(f8)")
+# def logit_inverse(number):
+#     ''' A function which returns the logit of a number 
+    
+#     takes care of extreme values 
+#     '''
+#     if number > 100:
+#         return 1.0
+#     elif number < -100:
+#         return 0.0
+#     else: 
+#         return 1/(1+exp(-number))
+
+def normcdf(input,mu=0.0,sigma=1.0):
+    return norm.cdf(input,mu,sigma)    
+
+
+def qgamma(q,a,loc):
+    res = gamma.ppf(q,a,loc,scale=1)
+    return res
+
+
+def cdf_lognorm_econ(x, mu, sigma, eps=1e-12):
+    """
+    Econ / GAMS-style log-normal cumulative distribution function (Newton-safe).
+
+    Computes the CDF of a log-normal distribution using the mean-parameterized
+    (econ / GAMS) formulation, where `mu` is the mean of the level variable X,
+    not the mean of log(X).
+
+    Mathematically:
+        F(x) = Φ((ln(x / mu) + 0.5 * sigma**2) / sigma)
+
+    where Φ(·) is the standard normal CDF.
+
+    This implementation is numerically safe for use in Newton solvers and
+    numerical differentiation by applying a soft lower bound to x and using
+    a stable normal CDF.
+
+    Parameters
+    ----------
+    x : float
+        Evaluation point. May be zero or negative during numerical
+        differentiation.
+    mu : float
+        Mean of the level variable X (E[X] = mu).
+    sigma : float
+        Standard deviation of ln(X).
+    eps : float, optional
+        Small positive floor used to ensure log(x) is well-defined.
+        Default is 1e-12.
+
+    Returns
+    -------
+    float
+        Value of the log-normal CDF in the interval [0, 1].
+
+    Notes
+    -----
+    - The median of the distribution is mu * exp(-0.5 * sigma**2),
+      not mu.
+    - As x → 0, the function smoothly approaches 0 with a vanishing
+      derivative, which is critical for Newton stability.
+    - Equivalent to the standard log-mean parameterization with:
+          mu_log = ln(mu) - 0.5 * sigma**2
+    """
+    from scipy.special import ndtr
+
+    x_safe = x if x > eps else eps
+    z = (log(x_safe / mu) + 0.5 * sigma**2) / sigma
+    return float(ndtr(z))
+
+def part_exp_lognorm(k, mu, std, eps=1e-12):
+    """
+    Safe scalar equivalent of the GAMS PartExpLogNorm function.
+
+    Parameters
+    ----------
+    k : float
+        Marginal input
+    mu : float
+        Average input (scale)
+    std : float
+        Dispersion / smoothing parameter
+    eps : float, optional
+        Small positive number to avoid log/division errors
+
+    Returns
+    -------
+    float
+        Smoothed, bounded transformation
+    """
+    # protect against division by zero
+    mu_safe = mu if abs(mu) > eps else eps
+
+    # protect against log(0)
+    ratio = abs(k / mu_safe)
+    ratio_safe = ratio if ratio > eps else eps
+
+    # protect against std = 0
+    std_safe = std if abs(std) > eps else eps
+
+    return mu_safe * erf((log(ratio_safe) - 0.5 * std_safe**2) / std_safe)
+
+
+
+def clognorm(input,mu=0.0,sigma=1.0):
+    res = lognorm.cdf(input,mu,sigma)
+    return res    
+
+if __name__ == '__main__' and 1:
+    xx = logit_inverse(-3*10
+                      )
+    print(xx)
+
+