Implements the models presented in Fumagalli et al. (2020)
Project description
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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7aba026d3f6266b8721eaebc56881ac35296efb45e317e2ce76cc1089c889e91 |
|
MD5 | 380a504824598252bef9f122139251c4 |
|
BLAKE2b-256 | 51d54d95118eb8863b42ce71269302b1dbac94f8b4258c9ea317bd44fb9cea06 |
Hashes for Fumagalli_Motta_Tarantino_2020-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96527b64fd20f3c1700f8aecdf8c7993b322c5efeff5e07b214380972bbf5388 |
|
MD5 | 08e945d40942dc0c7d7cce40429dd8ef |
|
BLAKE2b-256 | 3b416d04a4c105b276554e7b85c17a8e629c67defed082609fffef07ad16023f |