Metadata-Version: 2.1
Name: mud_examples
Version: 0.1.post0
Summary: Maximal Updated Density Examples
Home-page: https://github.com/mathematicalmichael/mud-examples.git
Author: Mathematical Michael
Author-email: consistentbayes@gmail.com
License: mit
Project-URL: Documentation, https://github.com/mathematicalmichael/mud-examples.git
Description: [![codecov](https://codecov.io/gh/mathematicalmichael/mud-examples/branch/main/graph/badge.svg?token=JQZao81BSp)](https://codecov.io/gh/mathematicalmichael/mud-examples)
        [![PyPI version](https://badge.fury.io/py/mud-examples.svg)](https://badge.fury.io/py/mud-examples)
        ![unit testing workflow](https://github.com/mathematicalmichael/mud-examples/actions/workflows/main.yml/badge.svg)
        ![example workflow](https://github.com/mathematicalmichael/mud-examples/actions/workflows/examples.yml/badge.svg)
        ![publish workflow](https://github.com/mathematicalmichael/mud-examples/actions/workflows/publish.yml/badge.svg)
        
        # MUD-Examples
        ## Examples for _Existence, Uniqueness, and Convergence of Parameter Estimates with Maximal Updated Densities_
        
        Authors: Troy Butler & Michael Pilosov
        
        # Installation
        
        ```sh
        pip install mud-examples
        ```
        
        # Quickstart
        
        Generate all of the figures the way they are referenced in the paper:
        ```sh
        mud_run_all
        ```
        The above is equivalent to running all of the examples sequentially:
        
        ```sh
        mud_run_inv
        mud_run_lin
        mud_run_ode
        mud_run_pde
        ```
        
        # Usage
        
        The `mud_run_X` scripts all call the same primary entrypoint, which you can call with the console script `mud_examples`.
        
        Here are two examples:
        ```sh
        mud_examples --example ode
        ```
        
        ```sh
        mud_examples --example lin
        ```
        
        and so on. (More on this later, once argparsing is better handled, they might just be entrypoints to the modules themselves rather than a central `runner.py`, which really only exists to compare several experiments, so perhaps it warrants renaming to reflect that).
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.5
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: test
Provides-Extra: pub
