Skip to content

Commit 98080fd

Browse files
committed
final changes for readme
1 parent 8a6c18f commit 98080fd

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,25 @@
22
Using limit cycle continuation methods to speed up evaluation of ion channel cell models
33

44
# Using the code
5-
The code should be cloned from GitHub, or downloaded from Zenodo.
5+
The code can be cloned from GitHub (most recent version), or downloaded from Zenodo (version of record).
66

77
# Setting up the Julia project
88
For up to date versions of the dependent packages, run the *packages.jl* file.
99

1010
To use the same package versions as used in the paper, refer to the *Project.toml* and *Manifest.toml* and use *Pkg.instantiate()*.
1111

12+
Note the figures were generated under a different environment to the one given in the *Project.toml* and *Manifest.toml* files, which were only used to generated the results/data.
13+
1214
# Running the analysis
13-
The analysis from the paper can be run by running the scripts *simulationTimings.jl* and *mhmcmc.jl*.
15+
The analysis from the paper can be run by running the scripts *simulationTimings.jl*, *mcmcSetup.jl* and *mhmcmc.jl*.
1416

1517
Note that running the scripts will override the previously recorded results.
1618

1719
When running *mhmcmc.jl*, there are a handful of changes you may wish to make.
18-
The number of samples to run the MCMC algorithm for can be changed from the default of 50,000.
19-
The "converger" can be chosen by setting the variables *use_continuation* and *use_fast_ODE*.
20+
The number of samples to run the MCMC algorithm for can be changed from the default of 40,000.
21+
The "converger" can be chosen by setting the variables *use_continuation* and *use_tracking_ODE*.
2022
If `use_continuation=true`, then the continuation converger will be used.
21-
Otherwise, the ODE solver will be used to converge, running for 10,000ms if `use_fast_ODE=true` or 50,000ms otherwise.
23+
Otherwise, the ODE solver will be used to converge, running from a previous limit cycle if `use_tracking_ODE=true` or from standard initial conditions otherwise.
2224

2325
# Reproducing the figures from the pre-generated data
24-
The figures for the benchmark results can be loaded built from the *.json* files.
25-
The files can be loaded into a Julia workspace using:
26-
```
27-
using BenchmarkTools, Plots, BenchmarkPlots, StatsPlots
28-
t = BenchmarkTools.load("simulation_timings.json")[1]
29-
```
30-
Then, the plotting code from the end of the *simulationTimings.jl* can be run.
26+
The figures can be regenerated using *figures.jl* (for results figures) and *diagrams.jl* for the phase plane diagrams.

0 commit comments

Comments
 (0)