[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/CodeCov.yml)
[](https://codecov.io/gh/manuelbieri/Fumagalli_2020)
[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/codeql-analysis.yml)
[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/Black.yml)
[](https://www.codefactor.io/repository/github/manuelbieri/fumagalli_2020)
[](https://github.com/manuelbieri/Fumagalli_2020)
[](https://github.com/manuelbieri/Fumagalli_2020/blob/master/LICENSE)
[](https://github.com/manuelbieri/Fumagalli_2020/releases)
[](https://manuelbieri-fmt20web-fmt20-app-hryht2.streamlitapp.com/)
This package implements the models presented in [Fumagalli et al. (2020)](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=3674889) (note, that the version from 2020 is implemented).
Additionally, extensions from the models are explained in [Extension of Fumagalli et al (2020).pdf](https://github.com/manuelbieri/Fumagalli_2020/blob/master/Extension%20of%20Fumagalli%20et%20al%20(2020).pdf).
## Installation
You can either [install the package](#Package) (functionality only) or [download the whole repository](#Repository) (with documentation and assets).
<h3 id="Package">Package</h3>
Install the latest release from [PyPi](https://pypi.org/project/Fumagalli-Motta-Tarantino-2020/):
```shell
$ pip install Fumagalli-Motta-Tarantino-2020
```
Or install this package directly from source:
```shell
$ pip install git+https://github.com/manuelbieri/Fumagalli_2020.git
```
The necessary dependencies are automatically installed during the setup.
<h3 id="Repository">Repository</h3>
If you would like to get the whole repository, download it [here](https://github.com/manuelbieri/Fumagalli_2020/archive/refs/heads/master.zip)
or clone it with GIT (requires GIT installation):
```shell
$ git clone https://github.com/manuelbieri/Fumagalli_2020.git
```
Install the dependencies for the repository with the following command (Note: Make sure you are operating in the same directory, where the
`requirements.txt` is located.):
```shell
$ pip install -r requirements.txt
```
Note: This package requires a working latex installation for the plots!
## Basic Usage
```python
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 the API-documentation
FMT20.docs()
# open the 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](https://manuelbieri.ch/Fumagalli_2020/).
Note: mybinder.org is currently not supported, since this package needs at least python 3.9.
## Overview
This sections provides a quick overview for this repository.
### Assets
Additional files about the code style (scripts), class diagram and a more detailed project overview (Fumagalli_Motta_Tarantino_2020.Project).
### Docs
Contains the files of the [automatically](#docs) generated API - documentation
### Fumagalli_Motta_Tarantino_2020
Contains the actual code of the package. See Fumagalli_Motta_Tarantino_2020.Models and Fumagalli_Motta_Tarantino_2020.Visualizations for
the available models and visualization options. In Fumagalli_Motta_Tarantino_2020.Notebooks are some jupyter notebooks included
(e.g., Interactive.ipynb or Tutorial.ipynb).
## Tests
Run the unittests shipped in Fumagalli_Motta_Tarantino_2020.Tests with the following command (pay attention to the current working directory):
```shell
$ 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](https://app.codecov.io/gh/manuelbieri/Fumagalli_2020) for a detailed report about the test coverage.
## Code style
As the default code style [Black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) is used and
automatically checked and enforced by GitHub - workflows. To run black in the terminal either run `assets/code style/run_black.sh` or use the following command:
```shell
$ python -m black ./Fumagalli_Motta_Tarantino_2020
```
This command modifies the source code if the preset rules are not met. You can as well just check, whether the rules are met or not with `assets/code style/check_black.sh` or:
```shell
$ python -m black ./../../Fumagalli_Motta_Tarantino_2020 --diff
```
<h2 id="docs">Generate Documentation</h2>
Generate the documentation with the following command (as always be aware of the working directory):
```shell
$ pdoc -o docs Fumagalli_Motta_Tarantino_2020 --docformat numpy --math
```
or run the shell-script `docs/build.sh` in the terminal.
Raw data
{
"_id": null,
"home_page": "https://github.com/manuelbieri/Fumagalli_2020#readme",
"name": "Fumagalli-Motta-Tarantino-2020",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Killer Acquisition, Competition, Innovation",
"author": "Manuel Bieri",
"author_email": "mail@manuelbieri.ch",
"download_url": "https://files.pythonhosted.org/packages/ad/19/56bc502c95c597209e545dffc6636b1c02ae0008768dc804fdb23e4f3f7d/fumagalli_motta_tarantino_2020-1.0.2.tar.gz",
"platform": null,
"description": "[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/CodeCov.yml)\n[](https://codecov.io/gh/manuelbieri/Fumagalli_2020)\n[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/codeql-analysis.yml)\n[](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/Black.yml)\n[](https://www.codefactor.io/repository/github/manuelbieri/fumagalli_2020)\n[](https://github.com/manuelbieri/Fumagalli_2020)\n[](https://github.com/manuelbieri/Fumagalli_2020/blob/master/LICENSE)\n[](https://github.com/manuelbieri/Fumagalli_2020/releases)\n\n\n[](https://manuelbieri-fmt20web-fmt20-app-hryht2.streamlitapp.com/)\n\nThis package implements the models presented in [Fumagalli et al. (2020)](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=3674889) (note, that the version from 2020 is implemented).\nAdditionally, extensions from the models are explained in [Extension of Fumagalli et al (2020).pdf](https://github.com/manuelbieri/Fumagalli_2020/blob/master/Extension%20of%20Fumagalli%20et%20al%20(2020).pdf).\n\n## Installation\n\nYou can either [install the package](#Package) (functionality only) or [download the whole repository](#Repository) (with documentation and assets).\n\n<h3 id=\"Package\">Package</h3>\n\nInstall the latest release from [PyPi](https://pypi.org/project/Fumagalli-Motta-Tarantino-2020/):\n\n```shell\n$ pip install Fumagalli-Motta-Tarantino-2020\n```\nOr install this package directly from source:\n\n```shell\n$ pip install git+https://github.com/manuelbieri/Fumagalli_2020.git\n```\nThe necessary dependencies are automatically installed during the setup.\n\n<h3 id=\"Repository\">Repository</h3>\n\nIf you would like to get the whole repository, download it [here](https://github.com/manuelbieri/Fumagalli_2020/archive/refs/heads/master.zip)\nor clone it with GIT (requires GIT installation):\n```shell\n$ git clone https://github.com/manuelbieri/Fumagalli_2020.git\n```\n\nInstall the dependencies for the repository with the following command (Note: Make sure you are operating in the same directory, where the \n`requirements.txt` is located.):\n\n```shell\n$ pip install -r requirements.txt\n```\n\nNote: This package requires a working latex installation for the plots!\n\n## Basic Usage\n\n```python\nimport Fumagalli_Motta_Tarantino_2020 as FMT20\n\n# initialize the model (here you can adjust the parameters of the model)\n# all other models conform to the interface defined in FMT20.OptimalMergerPolicy\nmodel: FMT20.OptimalMergerPolicy = FMT20.OptimalMergerPolicy()\n\n# print a summary of the outcome\nprint(model.summary())\n\n# plot a model overview\nFMT20.Overview(model).show()\n\n# open the API-documentation\nFMT20.docs()\n\n# open the GitHub-repository\nFMT20.repo()\n```\n\nA tutorial is included with the notebook Tutorial.ipynb. Additionally, find the latest documentation including all the details on [manuelbieri.ch/fumagalli_2020](https://manuelbieri.ch/Fumagalli_2020/).\n\nNote: mybinder.org is currently not supported, since this package needs at least python 3.9.\n\n## Overview\n\nThis sections provides a quick overview for this repository.\n\n### Assets\n\nAdditional files about the code style (scripts), class diagram and a more detailed project overview (Fumagalli_Motta_Tarantino_2020.Project).\n\n### Docs\n\nContains the files of the [automatically](#docs) generated API - documentation\n\n### Fumagalli_Motta_Tarantino_2020\n\nContains the actual code of the package. See Fumagalli_Motta_Tarantino_2020.Models and Fumagalli_Motta_Tarantino_2020.Visualizations for\nthe available models and visualization options. In Fumagalli_Motta_Tarantino_2020.Notebooks are some jupyter notebooks included \n(e.g., Interactive.ipynb or Tutorial.ipynb).\n\n## Tests\n\nRun the unittests shipped in Fumagalli_Motta_Tarantino_2020.Tests with the following command (pay attention to the current working directory):\n\n```shell\n$ python -m unittest discover Fumagalli_Motta_Tarantino_2020.Tests\n```\n\nFor explanations about the tests, have a look at Fumagalli_Motta_Tarantino_2020.Tests. See [codecov.io](https://app.codecov.io/gh/manuelbieri/Fumagalli_2020) for a detailed report about the test coverage.\n\n## Code style\n\nAs the default code style [Black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) is used and\nautomatically checked and enforced by GitHub - workflows. To run black in the terminal either run `assets/code style/run_black.sh` or use the following command:\n```shell\n$ python -m black ./Fumagalli_Motta_Tarantino_2020\n```\nThis command modifies the source code if the preset rules are not met. You can as well just check, whether the rules are met or not with `assets/code style/check_black.sh` or:\n```shell\n$ python -m black ./../../Fumagalli_Motta_Tarantino_2020 --diff\n```\n\n<h2 id=\"docs\">Generate Documentation</h2>\nGenerate the documentation with the following command (as always be aware of the working directory):\n\n```shell\n$ pdoc -o docs Fumagalli_Motta_Tarantino_2020 --docformat numpy --math\n```\n\nor run the shell-script `docs/build.sh` in the terminal.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Implements the models presented in Fumagalli et al. (2020)",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://manuelbieri.ch/Fumagalli_2020/",
"Download": "https://github.com/manuelbieri/Fumagalli_2020/releases",
"Homepage": "https://github.com/manuelbieri/Fumagalli_2020#readme",
"Source": "https://github.com/manuelbieri/Fumagalli_2020"
},
"split_keywords": [
"killer acquisition",
" competition",
" innovation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52ece086e968d442164b98e73850ddbf5514663b5da28ffa1d77a7613d6f5c05",
"md5": "344991e69a6766271f377e80e4fe9634",
"sha256": "611fc8b4b475a2d8a73f12d1e7026b2bd6549b69517ca8e922f23a97fc1d86b2"
},
"downloads": -1,
"filename": "Fumagalli_Motta_Tarantino_2020-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "344991e69a6766271f377e80e4fe9634",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2250280,
"upload_time": "2024-09-20T13:58:22",
"upload_time_iso_8601": "2024-09-20T13:58:22.603613Z",
"url": "https://files.pythonhosted.org/packages/52/ec/e086e968d442164b98e73850ddbf5514663b5da28ffa1d77a7613d6f5c05/Fumagalli_Motta_Tarantino_2020-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad1956bc502c95c597209e545dffc6636b1c02ae0008768dc804fdb23e4f3f7d",
"md5": "b8e6117ecd6fea64861fd24a8ee4234f",
"sha256": "57cf02864da9e6277301af0f0231d43a15f8851c3454529b2000857941681d1d"
},
"downloads": -1,
"filename": "fumagalli_motta_tarantino_2020-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b8e6117ecd6fea64861fd24a8ee4234f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2233517,
"upload_time": "2024-09-20T13:58:24",
"upload_time_iso_8601": "2024-09-20T13:58:24.393310Z",
"url": "https://files.pythonhosted.org/packages/ad/19/56bc502c95c597209e545dffc6636b1c02ae0008768dc804fdb23e4f3f7d/fumagalli_motta_tarantino_2020-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-20 13:58:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manuelbieri",
"github_project": "Fumagalli_2020#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "scipy",
"specs": [
[
"==",
"1.14.1"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.1.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.9.2"
]
]
},
{
"name": "ipympl",
"specs": [
[
"==",
"0.9.4"
]
]
},
{
"name": "mockito",
"specs": [
[
"==",
"1.5.1"
]
]
},
{
"name": "black",
"specs": [
[
"==",
"24.8.0"
]
]
},
{
"name": "jupyter-black",
"specs": [
[
"==",
"0.4.0"
]
]
},
{
"name": "ipython",
"specs": [
[
"==",
"8.27.0"
]
]
},
{
"name": "jupyter",
"specs": [
[
"==",
"1.1.1"
]
]
},
{
"name": "ipywidgets",
"specs": [
[
"==",
"7.8.4"
]
]
},
{
"name": "pdoc",
"specs": [
[
"==",
"14.7.0"
]
]
}
],
"lcname": "fumagalli-motta-tarantino-2020"
}
JSON
