Fumagalli-Motta-Tarantino-2020 0.3.1

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

Installation

Install the latest release from PyPi:

$ pip install Fumagalli-Motta-Tarantino-2020

Or alternatively, install the package directly from source:

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

Basic Usage

import Fumagalli_Motta_Tarantino_2020.Models as Model

# initialize the model (here you can adjust the parameters of the model)
model: Model.OptimalMergerPolicy = Model.OptimalMergerPolicy()

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

A tutorial is included with the notebook tutorial.ipynb.

Find the latest documentation on manuelbieri.ch/fumagalli_2020.

Dependencies

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

Package	Version	Annotation
scipy	1.8.1	Always
numpy	1.22.4	Always
matplotlib	3.5.2	Always
black	22.3.0	For consistent code formatting
jupyter	1.0.0	For the demonstration in jupyter Notebooks
IPython	8.3.0	For the demonstration in jupyter Notebooks
pdoc	12.0.0	To generate the documentation from scratch

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 TestCases.md . 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.