docs: update example 8 for --plot_projection functionality, version bump

hvasbath · Sep 14, 2022 · 56ba0e9 · 56ba0e9
1 parent f521a89
commit 56ba0e9
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ Contributors: Hannes Vasyura-Bathke @hvasbath
 
 **plotting**
 - *plot_projection* argument available for *stage_posteriors* plot: cdf, pdf, kde
+- update Example 8 to showcase the use of this functionality
 
 ### Fixed
 - stage_posterior plot supports multipage output, figsize fixed to fractions of A4

diff --git a/docs/_static/example8/pol_stage_posteriors_variations.png b/docs/_static/example8/pol_stage_posteriors_variations.png
diff --git a/docs/examples/MTQT_polarity.rst b/docs/examples/MTQT_polarity.rst
@@ -394,6 +394,13 @@ It may look like this.
 
 The vertical black lines are the true values and the vertical red lines are the maximum likelihood values.
 
+The posterior marginals can be plotted using different forms, either "kde", "pdf", or "cdf" through the option *--plot_projection*::
+
+    beat plot MTQT_polarity stage_posteriors --stage_number=-1 --format='png' --varnames=strike1,kappa --plot_projection=kde
+
+Repeatedly calling the above commandline and combining the output yields following figure, from top to bottom: with varying *--plot_projection* kde, pdf, cdf.
+
+.. image:: ../_static/example8/pol_stage_posteriors_variations.png
 
 To get an image of parameter correlations (including the maximum aposterior (MAP) value in red) of moment tensor components and posterior likelihood.::
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "beat"
-version = "1.2.0"
+version = "1.2.1"
 requires-python = ">=3.7"
 license = {text = "GPLv3"}
 description = "'Bayesian Earthquake Analysis Tool'"

diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@
 op = os.path
 
 packname = "beat"
-version = "1.2.0"
+version = "1.2.1"
 
 
 try: