@@ -12,7 +12,7 @@ This package also contains Bayesian optimization routines for 1) finding optimal
1212This package is intended for educational use only.
1313
1414Try [ emcee] ( https://arxiv.org/abs/1202.3665 ) ,
15- [ pymc3] ( https://docs.pymc.io/ ) , or Dakota for mature MCMC implementations; however, one can
15+ [ pymc3] ( https://docs.pymc.io/ ) , or Dakota for alternative MCMC implementations; however, one can
1616use BiPyMc as a starting point for implementing their own fancy MCMC samplers.
1717
1818Implemented MCMC Methods
@@ -25,6 +25,16 @@ Implemented MCMC Methods
2525- Delayed Rejection Metropolis
2626- Delayed Rejection Adaptive Metropolis (DRAM)
2727
28+ ## Example: Sample Bimodal Gaussian Distribution with DREAM
29+
30+ ![ image] ( https://github.com/wgurecky/bipymc/blob/master/doc/images/bimodal_mont.png )
31+
32+ ### Included Tests:
33+ - ` tests/test_100dgauss.py ` : 100 Dimensional normal distribution test. Shows improved performance of DREAM in high dimensions.
34+ - ` tests/test_dblgauss.py ` : Ensures DREAM and DE-MC samplers handle multi-modal distributions. Demonstrates DRAM and AM limitations.
35+ - ` tests/test_banana.py ` : Ensures all MCMC methods obtain correct samples from non-linear, distorted-gaussian distribution.
36+
37+
2838Implemented Bayesian Optimization Methods
2939---------------------------------
3040
@@ -46,12 +56,12 @@ Quickstart
4656
4757Install depends:
4858
49- pip install corner mpi4py numpy scipy matplotlib
59+ pip install corner mpi4py numpy scipy matplotlib pytest
5060
5161Or if using conda:
5262
5363 conda install -c astropy corner
54- conda install mpi4py numpy scipy matplotlib
64+ conda install mpi4py numpy scipy matplotlib pytest
5565
5666Install and run examples:
5767
@@ -71,6 +81,7 @@ Depends
7181- python3.2+
7282- numpy
7383- scipy
84+ - pytest (optional for tests)
7485- mpi4py (optional for parallel DE-MC)
7586- matplotlib (optional for plotting)
7687- [ corner] ( https://corner.readthedocs.io/en/latest/ ) (optional for plotting)
0 commit comments