Grama

Grama: A Grammar of Model Analysis - Published in JOSS (2020)

https://github.com/zdelrosario/py_grama

Science Score: 95.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 10 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    4 of 10 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

uq

Scientific Fields

Sociology Social Sciences - 87% confidence
Mathematics Computer Science - 84% confidence
Last synced: 4 months ago · JSON representation

Repository

Implementation of a grammar of model analysis

Basic Info
Statistics
  • Stars: 19
  • Watchers: 4
  • Forks: 11
  • Open Issues: 36
  • Releases: 13
Topics
uq
Created almost 7 years ago · Last pushed 9 months ago
Metadata Files
Readme Contributing License

README.md

py_grama

DOI PyPI version Documentation Status Python package test codecov CodeFactor

Implementation of a grammar of model analysis (grama). See the documentation for more info.

Overview

Grama is a grammar of model analysis---a Python package that supports building and analyzing models with quantified uncertainties. This language is heavily inspired by the Tidyverse. Grama provides convenient syntax for building a model (with functions and distributions), generating data, and visualizing results. The purpose of this language is to support scientists and engineers learning to handle uncertainty, and to improve documentation + reproducibility of results.

Uncertainty Quantification (UQ) is the science of analyzing uncertainty in scientific problems and using those results to inform decisions. UQ has important applications to building safety-critical engineering systems, and to making high-consequence choices based on scientific models. However, UQ is generally not taught at the undergraduate level: Many engineers leave their undergraduate training with a purely deterministic view of their discipline, which can lead to probabilistic design errors that negatively impact safety. To that end, Grama is designed to facilitate rapid model analysis, communication of results, and the teaching of concepts, all with quantified uncertainties. Intended users of Grama are scientists and engineers at the undergraduate level and upward, seeking to analyze computationally-lightweight models.

Installation

Quick install:

bash $ pip install py-grama

For a manual install clone this repo, change directories and run the following to install dependencies. (Note: I recommend Anaconda as a Python distribution; it takes care of most of the dependencies.)

bash $ git clone git@github.com:zdelrosario/py_grama.git $ cd py_grama/ $ pip install -r requirements.txt $ pip install .

Run the following to check your install:

```bash $ python

import grama ```

Quick Tour

py_grama has tools for both building and analyzing models. For a quick look at functionality, see the following notebooks:

Tutorials

The tutorials page has educational materials for learning to work with py_grama.

Support and Contributing

If you are seeking support or want to contribute, please see Contributing.

Cite As

If you find Grama useful in your work, we'd appreciate that you cite it as:

del Rosario, Z., (2020). Grama: A Grammar of Model Analysis. Journal of Open Source Software, 5(51), 2462, https://doi.org/10.21105/joss.02462

Bibtex code:

@article{del Rosario2020, doi = {10.21105/joss.02462}, url = {https://doi.org/10.21105/joss.02462}, year = {2020}, publisher = {The Open Journal}, volume = {5}, number = {51}, pages = {2462}, author = {Zachary del Rosario}, title = {Grama: A Grammar of Model Analysis}, journal = {Journal of Open Source Software} }

Owner

  • Name: Zachary del Rosario
  • Login: zdelrosario
  • Kind: user
  • Location: Massachusetts
  • Company: Olin College

JOSS Publication

Grama: A Grammar of Model Analysis
Published
July 28, 2020
Volume 5, Issue 51, Page 2462
Authors
Zachary del Rosario ORCID
Visiting Professor, Olin College of Engineering
Editor
Matthew Sottile ORCID
Tags
Modeling Uncertainty quantification Functional programming Pedagogy Communication Reproducibility

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,102
  • Total Committers: 10
  • Avg Commits per committer: 110.2
  • Development Distribution Score (DDS): 0.141
Past Year
  • Commits: 2
  • Committers: 1
  • Avg Commits per committer: 2.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
zdelrosario z****o@o****m 947
mstites m****e@m****m 63
Riya-1 2****a@g****m 30
Oscar De La Garza o****a@o****u 25
Oscar De La Garza o****a@o****u 24
MayaSimone m****n@m****m 5
Rick Fenrich r****h 2
QingmuDeng q****g@o****u 2
Ellen Sun s****n@g****m 2
Rick Fenrich r****h@s****u 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 30
  • Total pull requests: 88
  • Average time to close issues: 4 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 4
  • Total pull request authors: 6
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.49
  • Merged pull requests: 85
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • zdelrosario (20)
  • mstites (6)
  • OscarDeGar (3)
  • ckborg (1)
Pull Request Authors
  • zdelrosario (78)
  • OscarDeGar (5)
  • syclops (2)
  • eys123 (2)
  • mstites (2)
Top Labels
Issue Labels
enhancement (17) bug (7) good first issue (7) invalid (3) fix (2) question (1)
Pull Request Labels
enhancement (2) fix (1) bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 17 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 22
  • Total maintainers: 1
pypi.org: py-grama

A grammar of model analysis

  • Versions: 22
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 17 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 10.9%
Dependent repos count: 11.6%
Stargazers count: 13.9%
Average: 17.9%
Downloads: 43.0%
Maintainers (1)
Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi
  • recommonmark *
  • sphinx-markdown-tables *
requirements.txt pypi
  • matplotlib *
  • networkx *
  • numpy >=1.15
  • pandas *
  • plotnine >=0.8.0
  • scipy *
  • toolz *
setup.py pypi
  • matplotlib *
  • networkx *
  • numpy >=1.15
  • pandas *
  • plotnine >=0.8.0
  • scipy *
  • toolz *
.github/workflows/python-app.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v3 composite