Simulation Decomposition in Python

Simulation Decomposition in Python - Published in JOSS (2024)

https://github.com/simulation-decomposition/simdec-python

Science Score: 93.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

computational-modeling sensitivity-analysis uncertainty visualization

Scientific Fields

Physics Physical Sciences - 40% confidence
Last synced: 6 months ago · JSON representation

Repository

Sensitivity analysis using simulation decomposition

Basic Info
  • Host: GitHub
  • Owner: Simulation-Decomposition
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage: https://simdec.readthedocs.io
  • Size: 2.19 MB
Statistics
  • Stars: 26
  • Watchers: 2
  • Forks: 1
  • Open Issues: 9
  • Releases: 1
Topics
computational-modeling sensitivity-analysis uncertainty visualization
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct

README.md

Warning This library is under active development and things can change at anytime! Suggestions and help are greatly appreciated.

image

Simulation decomposition or SimDec is an uncertainty and sensitivity analysis method, which is based on Monte Carlo simulation. SimDec consists of three major parts:

  1. computing sensitivity indices,
  2. creating multi-variable scenarios and mapping the output values to them, and
  3. visualizing the scenarios on the output distribution by color-coding its segments.

SimDec reveals the nature of causalities and interaction effects in the model. See our publications and join our discord community.

Python API

The library is distributed on PyPi and can be installed with:

pip install simdec

Dashboard

A live dashboard is available at:

https://simdec.io

Citations

The algorithms and visualizations used in this package came primarily out of research at LUT University, Lappeenranta, Finland, and Stanford University, California, U.S., supported with grants from Business Finland, Wihuri Foundation, and Finnish Foundation for Economic Education.

If you use SimDec in your research we would appreciate a citation to the following publications:

  • Kozlova, M., Moss, R. J., Yeomans, J. S., & Caers, J. (2024). Uncovering Heterogeneous Effects in Computational Models for Sustainable Decision-making. Environmental Modelling & Software, 171, 105898. https://doi.org/10.1016/j.envsoft.2023.105898
  • Kozlova, M., Moss, R. J., Roy, P., Alam, A., & Yeomans, J. S. (2024). SimDec algorithm and guidelines for its usage and interpretation. In M. Kozlova & J. S. Yeomans (Eds.), Sensitivity Analysis for Business, Technology, and Policymaking. Made Easy with Simulation Decomposition. Routledge. Available here.

Owner

  • Name: Simulation-Decomposition
  • Login: Simulation-Decomposition
  • Kind: organization

JOSS Publication

Simulation Decomposition in Python
Published
June 10, 2024
Volume 9, Issue 98, Page 6713
Authors
Pamphile T. Roy ORCID
Consulting Manao GmbH, Vienna, Austria
Mariia Kozlova ORCID
LUT Business School, LUT University, Lappeenranta, Finland
Editor
Chris Vernon ORCID
Tags
SimDec statistics Sensitivity Analysis Visualization

GitHub Events

Total
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 1
Last Year
  • Issues event: 2
  • Watch event: 3
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 227
  • Total Committers: 2
  • Avg Commits per committer: 113.5
  • Development Distribution Score (DDS): 0.009
Past Year
  • Commits: 18
  • Committers: 2
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.056
Top Committers
Name Email Commits
Pamphile Roy r****e@g****m 225
gnopik 3****k 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 36
  • Total pull requests: 5
  • Average time to close issues: 13 days
  • Average time to close pull requests: 2 months
  • Total issue authors: 3
  • Total pull request authors: 1
  • Average comments per issue: 1.89
  • Average comments per pull request: 1.8
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gnopik (19)
  • tupui (11)
  • matt-graham (5)
Pull Request Authors
  • tupui (9)
Top Labels
Issue Labels
dashboard (21) enhancement (13) bug (7) Upstream (3) performance (3) documentation (3) GCP (2)
Pull Request Labels
enhancement (5) dashboard (5)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 35 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: simdec

Sensitivity analysis using simulation decomposition

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 35 Last month
Rankings
Dependent packages count: 7.1%
Average: 19.7%
Dependent repos count: 32.2%
Maintainers (1)
Last synced: 6 months ago

Dependencies

environment.yml conda
  • accessible-pygments
  • hatch
  • numpy
  • numpydoc
  • pandas
  • panel
  • pre-commit
  • pydata-sphinx-theme
  • pytest
  • pytest-cov
  • python >=3.9
  • salib
  • seaborn
  • sphinx
  • typer
Dockerfile docker
  • base latest build
  • python 3.11-slim-bookworm build
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/release.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
pyproject.toml pypi
  • SALib *
  • numpy *
  • pandas *
  • panel *
  • seaborn *
  • typer [all]