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 the 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()
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 the 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 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.
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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51550accd2c7e55303fd3232b6872dd3b85a1f59a8b10cfe9bbea8567c588441 |
|
MD5 | c7303f4450dcd23c125cfa07010b3e54 |
|
BLAKE2b-256 | 4b518cb75dda9e7f202d458f3020bc985d2a663abde9a0a301603a94eb48dee1 |
Hashes for Fumagalli_Motta_Tarantino_2020-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03bc9294924fb9b6be4bd94d742391ac1e000d686f85a9e6fde3242bb3da5c90 |
|
MD5 | 7f05b9d06061c934442843e56753d47a |
|
BLAKE2b-256 | 27afea725f04c0a1debe39b94b1d93d8c11a03680033dcf406e70d82270c26e7 |