Data

Tools

Indexes

Applications

Experiments

Open Source Science

fumagalli-motta-tarantino-2020

Implements Fumagalli et al. (2020).

https://github.com/manuelbieri/fumagalli_2020

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Implements Fumagalli et al. (2020).

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 19
Created about 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

CI codecov CodeQL Code Style Check CodeFactor GitHub repo size GitHub license GitHub release (latest by date) PyPI - Status PyPI - Python Version Streamlit App

This package implements the models presented in Fumagalli et al. (2020) (note, that the version from 2020 is implemented). Additionally, extensions from the models are explained in Extension of Fumagalli et al (2020).pdf.

Installation

You can either install the package (functionality only) or download the whole repository (with documentation and assets).

Package

Install the latest release from PyPi:

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.

Repository

If you would like to get the whole repository, download it here 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 FumagalliMottaTarantino_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.

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 (FumagalliMottaTarantino_2020.Project).

Docs

Contains the files of the automatically generated API - documentation

FumagalliMottaTarantino_2020

Contains the actual code of the package. See FumagalliMottaTarantino2020.Models and FumagalliMottaTarantino2020.Visualizations for the available models and visualization options. In FumagalliMottaTarantino_2020.Notebooks are some jupyter notebooks included (e.g., Interactive.ipynb or Tutorial.ipynb).

Tests

Run the unittests shipped in FumagalliMottaTarantino_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 FumagalliMottaTarantino_2020.Tests. See codecov.io for a detailed report about the test coverage.

Code style

As the default code style Black 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

Generate Documentation

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.

Owner

  • Name: Manuel Bieri
  • Login: manuelbieri
  • Kind: user
  • Location: Switzerland

Student at the University of Bern

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Implementation of Fumagalli et al. (2020)
message: Please cite this software using these metadata.
type: software
authors:
  - given-names: Manuel
    family-names: Bieri
    email: mail@manuelbieri.ch
    orcid: "https://orcid.org/0000-0002-1530-423X"
version: 1.0.2
date-released: "2024-09-20"
license: MIT
repository-code: "https://github.com/manuelbieri/Fumagalli_2020"

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 252
  • Total Committers: 3
  • Avg Commits per committer: 84.0
  • Development Distribution Score (DDS): 0.405
Top Committers
Name Email Commits
Manuel Bieri m****i@o****m 150
Manuel Bieri m****l@m****h 97
Manuel Bieri 6****i@u****m 5
Committer Domains (Top 20 + Academic)
manuelbieri.ch: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 4
  • Total pull requests: 0
  • Average time to close issues: 5 months
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • manuelbieri (4)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 52 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 17
  • Total maintainers: 1
pypi.org: fumagalli-motta-tarantino-2020

Implements the models presented in Fumagalli et al. (2020)

  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 52 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.5%
Average: 25.3%
Downloads: 26.3%
Forks count: 29.8%
Stargazers count: 38.8%
Maintainers (1)
manuelbieri
Last synced: 8 months ago

Dependencies

requirements.txt pypi
  • black >=22.6.0
  • ipython >=7.31.0
  • ipywidgets >=7.7.1
  • jupyter *
  • jupyter-black >=0.3.1
  • matplotlib *
  • mockito *
  • numpy *
  • pdoc *
  • scipy *
setup.py pypi
  • ipython >=7.31.0
  • jupyter *
  • matplotlib >=3.5.2
  • mockito *
  • numpy >=1.22.4
  • scipy >=1.8.1
.github/workflows/Black.yml actions
  • actions/checkout v2 composite
  • rickstaa/action-black v1 composite
.github/workflows/CodeCov.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
.github/workflows/PyPI.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite