unit testing workflow example workflow build workflow publish workflow docker workflow

MUD-Examples

Examples for Existence, Uniqueness, and Convergence of Parameter Estimates with Maximal Updated Densities

Authors: Troy Butler & Michael Pilosov

Installation

For Python 3.7-3.12:

pip install mud-examples

To reproduce the results in Michael's thesis, use mud-examples==0.1. However, this comes with mud==0.0.28. Newer versions should still produce the same figures.

TeX is recommended (but not required):

apt-get install -yqq \
    texlive-base \
    texlive-latex-base \
    texlive-latex-extra \
    texlive-fonts-recommended \
    texlive-fonts-extra \
    texlive-science \
    latexmk \
    dvipng \
    cm-super

Quickstart

Generate all of the figures the way they are referenced in the paper:

mud_run_all

The above is equivalent to running all of the examples sequentially:

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:

mud_examples --example ode

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).

Metadata

Release files for mud-examples 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mud-examples 0.2.2
File	Size	Uploaded
mud_examples-0.2.2.tar.gz	11.7 MB	Jan 22, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for mud-examples 0.2.2
File	Interpreter	ABI	Platform	Reset
mud_examples-0.2.2-py3-none-any.whl 11.7 MB Jan 22, 2024	Python 3	none	any	Details

Total release size: 23.4 MB

Release files / mud_examples-0.2.2.tar.gz

Download URL	mud_examples-0.2.2.tar.gz
Size	11.7 MB
Tags	Source
SHA-256 checksum How to use checksums	`7aec7d1201f667e9b2b15626898b21b54e34f14b0a17010810134fe1210d48d7`
BLAKE2b-256 checksum How to use checksums	`e9b8e819ff2f1b071fafe6cb7dc6dbff1bf7f0b2009575aad92af85393c21869`
Upload date	Jan 22, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`

Release files / mud_examples-0.2.2-py3-none-any.whl

Download URL	mud_examples-0.2.2-py3-none-any.whl
Size	11.7 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`f145581eafdd4299e271a61ab7eb31456c5e885c6ef2c3f6554a9b6483979c4c`
BLAKE2b-256 checksum How to use checksums	`357095a444fda3b895ba0cf775a5fca2e387549b31fb52c52796602975d46d0d`
Upload date	Jan 22, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.18`