Skip to content

Commit e525231

Browse files
author
Johan Dahlin
committed
removed plots, workspaces and moved to release. updated READMEs to reflect this.
Former-commit-id: 12da617
1 parent 8b02a54 commit e525231

22 files changed

+7
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ This code was downloaded from https://github.com/compops/pmh-tutorial and contai
44

55
J. Dahlin and T. B. Schön, **Getting started with particle Metropolis-Hastings for inference in nonlinear models**. Pre-print, arXiv:1511:01707, 2017.
66

7-
The papers are available as a preprint from http://arxiv.org/pdf/1511.01707
7+
The papers are available as a preprint from http://arxiv.org/pdf/1511.01707. The R package connected to this tutorial is available directly via CRAN and the source code is available at https://github.com/compops/pmh-tutorial-rpkg/.
88

99
Included material
1010
--------------
11-
**r/** This is the main implementation. The complete R code developed and implemented in the tutorial. This code was used to make all the numerical illustrations in the tutorial including the figures and tables. The workspaces for these runs are also provided together with the code to reproduce all the figures.
11+
**r/** This is the main implementation. The complete R code developed and implemented in the tutorial. This code was used to make all the numerical illustrations in the tutorial including the figures and tables. The workspaces for these runs are also provided as a [zip-file in the latest release of the code](https://github.com/compops/pmh-tutorial/releases/latest) to reproduce all the figures in the tutorial.
1212

1313
**python/** Code for Python to implement the basic algorithms covered in the tutorial. Implementations for the advanced topics are not provided. Only simple plotting is implemented and no figures or saved data from runs are provided.
1414

r/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ These are the main script files that implement the various algorithms discussed
2424
**example5-sv.R** Modified version of the code in *example3-sv.R* to make use of another parameterisation of the model and a better tailored parameter proposal. The details are discussed in Section 6.3.3 and the results are presented in the same section. Note that the differences in the code is the use of another implemenation of PMH ant that the variable stepSize is changed.
2525

2626

27-
Additional script files for creating plots for tutorial (codeForPaper/)
27+
Additional script files for creating plots for tutorial (extra-code-for-tutorial/)
2828
--------------
2929
These are some additional files to recreate some extra results discussed in the tutorial.
3030

@@ -47,8 +47,11 @@ Supporting files (helpers/)
4747

4848
Saved results (savedWorkspaces/ and figures/)
4949
--------------
50+
These directories are placeholders for the output from running the code. The workspaces and plots used in the tutorial are found as a zip-file in the [latest release of the code](https://github.com/compops/pmh-tutorial/releases/latest) as binaries are not usually version controlled by Git and the workspaces are quite large (ca 80 mb).
51+
5052
**savedWorkspaces/** Saved copies of the workspace after running the corresponding code. These outputs are used to generate all the results in the aper. Can be used to directly recreate the plots in the tutorial by setting the flags loadSavedWorkspace and savePlotToFile to TRUE.
5153

54+
**figures/** Saved plots from running the files.
5255

5356
Adapting the code for another model
5457
--------------

r/codeForPaper/example4-sv-varyingN.R renamed to r/extra-code-for-tutorial/example4-sv-varyingN.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ loadSavedWorkspace <- FALSE
2323
tuneProposals <- FALSE
2424

2525
# Should we use the tuned proposals (requires "../savedWorkspaces/example4-sv-varyingN-proposals.RData")
26-
useTunedProposals <- TRUE
26+
useTunedProposals <- FALSE
2727

2828
##############################################################################
2929
# Load data

r/figures/example1-lgss.pdf

-12 KB
Binary file not shown.

r/figures/example2-lgss.pdf

-36 KB
Binary file not shown.

r/figures/example3-sv.pdf

-64 KB
Binary file not shown.
-41.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)