Implements the models presented in Fumagalli et al. (2020)
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Fumagalli_Motta_Tarantino_2020-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 524ca1939adc243564162e1eba4bcd96d76d8d214bb2ff0322e6aaec0e3df5f0 |
|
MD5 | 652f4920577b622c81c525fa1e8196d7 |
|
BLAKE2b-256 | 6c9fcffcda8154cdbde4017cc2a2bc11eea54d9c0143159b26deb8e122a2ae0e |
Hashes for Fumagalli_Motta_Tarantino_2020-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cce5e67468632ea2e664d02cc2f16c90700a51c19d05674f71956fbf7cba92e |
|
MD5 | 43fe410e108ed10f288cb36666946f01 |
|
BLAKE2b-256 | 483abe9d971dfca50675338ec45acabda4417a167f335f86aece722c1642bd59 |