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.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. The declared version should ensure compatibility with mybinder.org
Package | Version | Annotation |
---|---|---|
scipy | 1.7.3 | Always |
numpy | 1.21.6 | Always |
matplotlib | 3.5.1 | Always |
black | 22.1.0 | For consistent code formatting |
jupyter | 1.0.0 | For the demonstration in jupyter Notebooks |
IPython | 7.32.0 | For the demonstration in jupyter Notebooks |
pdoc | 11.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.
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc635053ed1e50e47a4be128cbf9e4064b6745b1f7eed17f2fc88bc8a5aff866 |
|
MD5 | be7791fd6d6eb21094be52089bf3c296 |
|
BLAKE2b-256 | 9d4cc00ca7ff48cb0e6de566deda0a36a32f914117cb499158d42407d42ce6f6 |
Hashes for Fumagalli_Motta_Tarantino_2020-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd1e848a17cf7914e4dc2dfe31bed76b7f5a4e34251e5df98825cb2168601f1c |
|
MD5 | db5f95cb0503221bc42f61851a96ec32 |
|
BLAKE2b-256 | c7be7003d4cc58879f8338b2cba3855f9688a2485fc51aaa86b53ebac81b3855 |