Implements the model presented in Fumagalli et al. (2020)
Project description
Basic Usage
import Fumagalli_Motta_Tarantino_2020.Model as Model
# initialize the model (here you can adjust the parameters of the model)
model: Model.MergerPolicyModel = Model.MergerPolicyModel()
# print a summary of the outcome
print(model.summary())
Dependencies
These packages include all the needed imports for the functionality of this package.
Package | Version | Annotation |
---|---|---|
scipy | 1.8.0 | Always |
numpy | 1.22.3 | Always |
black | 22.1.0 | For consistent code formatting |
jupyter | 1.0.0 | For the demonstration in jupyter Notebooks |
IPython | 8.2.0 | For the demonstration in jupyter Notebooks |
pdoc | 10.0.4 | To generate the documentation from scratch |
Install the dependencies with the following command:
$ pip install -r requirements.txt
(Note: Make sure you are operating in the same directory, where the requirements.txt
is located.)
Tests
Run the unittests with the following command (pay attention to the current working directory):
python -m unittest discover Fumagalli_Motta_Tarantino_2020/tests "Test_*.py"
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
Close
Hashes for Fumagalli_Motta_Tarantino_2020-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ab6e13df5945bb681725bdf5ef1b8b149da0b737e4dbaf69e670b54b21a3778 |
|
MD5 | dcc000dcee1667507faef409cfe65618 |
|
BLAKE2b-256 | 87c1e56a2fb702377350e7da00290b6ea510e3c78ffc6ce29300035729b131a3 |
Close
Hashes for Fumagalli_Motta_Tarantino_2020-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5bf4ccac06f34cdb630b6e89b106e9f30cb032e49e4abac52c6ad895a079dff |
|
MD5 | 230f53a152d06fdf36cd157b460d9b11 |
|
BLAKE2b-256 | 3da4279293a29218f2c59365c4f0dc6806691d812f9c5acd3b37698b3af255cc |