Fumagalli-Motta-Tarantino-2020 0.0.1

Implements the model presented in Fumagalli et al. (2020)

Basic Usage

import Fumagalli_Motta_Tarantino_2020.Model as Model

# initialize the model (here you can adjust the parameters of the model)
# if the parameters are not valid for the model an assertion-error with a corresponding message will be displayed
model: Model.BaseModel = Model.BaseModel()

Dependencies

These packages include all the needed imports for the functionality of this package.

Package	Version	Annotation
scipy	1.8.0	Always
numpy	1.22.3	Always
jupyter	1.0.0	For the demonstration in jupyter Notebooks
IPython	8.1.1	For the demonstration in jupyter Notebooks
pdoc	10.0.3	To generate the documentation from scratch

Install the dependencies with the following command:

$ pip install -r requirements.txt

(Note: Make sure you are operating in the same directory, where the requirements.txt is located.)

Generate Documentation

Generate the documentation with the following command:

$ pdoc -o docs Fumagalli_Motta_Tarantino_2020 --docformat numpy --math

or run the shell-script docs/build.sh in the terminal.