Fumagalli-Motta-Tarantino-2020 0.5.3

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

This package implements the models presented in Fumagalli et al. (2020) (note, that the version from 2020 is implemented). Additionally, extensions from the models are explained in Extension of Fumagalli et al (2020).pdf.

Installation

Install the latest release from PyPi:

$ pip install Fumagalli-Motta-Tarantino-2020

Or alternatively, install this package directly from source:

$ pip install git+https://github.com/manuelbieri/Fumagalli_2020.git

Basic Usage

import Fumagalli_Motta_Tarantino_2020 as FMT20

# initialize the model (here you can adjust the parameters of the model)
# all other models conform to the interface defined in FMT20.OptimalMergerPolicy
model: FMT20.OptimalMergerPolicy = FMT20.OptimalMergerPolicy()

# print a summary of the outcome
print(model.summary())

# plot a model overview
FMT20.Overview(model).show()

# open API-documentation
FMT20.docs()

# open GitHub-repository
FMT20.repo()

A tutorial is included with the notebook Tutorial.ipynb. Additionally, find the latest documentation including all the details on manuelbieri.ch/fumagalli_2020.

Note: mybinder.org is currently not supported, since this package needs at least python 3.9.

Dependencies

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

$ pip install -r requirements.txt

Tests

Run the unittests shipped in Fumagalli_Motta_Tarantino_2020.Tests with the following command (pay attention to the current working directory):

$ python -m unittest discover Fumagalli_Motta_Tarantino_2020.Tests

For explanations about the tests, have a look at Fumagalli_Motta_Tarantino_2020.Tests. See codecov.io for a detailed report about the test coverage.

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.