Metadata-Version: 2.1
Name: Fumagalli_Motta_Tarantino_2020
Version: 0.3.1
Summary: Implements the models presented in Fumagalli et al. (2020)
Home-page: https://github.com/manuelbieri/Fumagalli_2020#readme
Download-URL: https://github.com/manuelbieri/Fumagalli_2020/archive/refs/tags/v0.3.1.tar.gz
Author: Manuel Bieri
Author-email: manuel.bieri@outlook.com
License: MIT
Project-URL: Documentation, https://manuelbieri.ch/Fumagalli_2020/
Project-URL: Download, https://github.com/manuelbieri/Fumagalli_2020/releases
Project-URL: Source, https://github.com/manuelbieri/Fumagalli_2020
Keywords: Killer Acquisition,Competition,Innovation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE

[![CI](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/CodeCov.yml/badge.svg)](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/CodeCov.yml)
[![codecov](https://codecov.io/gh/manuelbieri/Fumagalli_2020/branch/master/graph/badge.svg?token=RRZ3PJI9U1)](https://codecov.io/gh/manuelbieri/Fumagalli_2020)
[![CodeQL](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/codeql-analysis.yml)
[![Code Style Check](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/Black.yml/badge.svg)](https://github.com/manuelbieri/Fumagalli_2020/actions/workflows/Black.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/manuelbieri/fumagalli_2020/badge)](https://www.codefactor.io/repository/github/manuelbieri/fumagalli_2020)
[![GitHub repo size](https://img.shields.io/github/repo-size/manuelbieri/Fumagalli_2020)](https://github.com/manuelbieri/Fumagalli_2020)
[![GitHub license](https://img.shields.io/github/license/manuelbieri/Fumagalli_2020)](https://github.com/manuelbieri/Fumagalli_2020/blob/master/LICENSE)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/manuelbieri/Fumagalli_2020)](https://github.com/manuelbieri/Fumagalli_2020/releases)
![PyPI - Status](https://img.shields.io/pypi/status/Fumagalli-Motta-Tarantino-2020)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Fumagalli-Motta-Tarantino-2020)
[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://share.streamlit.io/manuelbieri/fmt20web/fmt20_app.py)

### Installation

Install the latest release from [PyPi](https://pypi.org/project/Fumagalli-Motta-Tarantino-2020/):

```shell
$ pip install Fumagalli-Motta-Tarantino-2020
```

Or alternatively, install the package directly from source:

```shell
$ pip install git+https://github.com/manuelbieri/Fumagalli_2020.git
```


### Basic Usage

```python
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](https://manuelbieri.ch/Fumagalli_2020/).

### Dependencies

These packages include all the needed imports for the functionality of this package.

| Package &emsp; | Version &emsp; | Annotation &emsp;                          |
|:---------------|:--------------:|:-------------------------------------------|
| scipy          |     1.8.1      | Always                                     |
| numpy          |     1.22.4     | Always                                     |
| matplotlib     |     3.5.2      | Always                                     |
| black          |     22.3.0     | For consistent code formatting             |
| jupyter        |     1.0.0      | For the demonstration in jupyter Notebooks |
| IPython        |     8.3.0      | For the demonstration in jupyter Notebooks |
| pdoc           |     12.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.):

```shell
$ 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):

```shell
$ python -m unittest discover Fumagalli_Motta_Tarantino_2020/tests
```

For explanations about the tests, have a look at [TestCases.md](Fumagalli_Motta_Tarantino_2020/tests/TestCases.md) . See [codecov.io](https://app.codecov.io/gh/manuelbieri/Fumagalli_2020) for a detailed report about the test coverage.

### Generate Documentation
Generate the documentation with the following command:

```shell
$ pdoc -o docs Fumagalli_Motta_Tarantino_2020 --docformat numpy --math
```

or run the shell-script `docs/build.sh` in the terminal.
