No project description provided
Project description
Dynamic BEAST
This command line tool can be used to create a dynamic version of BEAST2 XML files. This dynamic XML file can be used to set BEAST parameters at runtime, which can be useful for testing different configurations or quickly modifying parameters without having to edit the XML file.
Install
Install dynamic-beast
with pip (requires python -V >= 3.6.2).
pip install dynamic-beast
Usage
Give dynamic-beast
the path to a BEAST2 XML file and specify where to save the dynamic XML file (if --outfile
is not specified XML will be printed to stdout).
dynamic-beast hcv_coal.xml > dynamic_hcv_coal.xml
This will produce a dynamic_hcv_coal.xml
file that can be used as standard in a BEAST analysis.
beast dynamic_hcv_coal.xml
To modify parameters at runtime use the beast
definitions option -D
.
# Change the chain length to 1000.
beast -D 'mcmc.chainLength=1000' dynamic_hcv_coal.xml
Multiple definitions can be passed at the same time.
# Change the treelog and tracelog sampling freq to 10000.
beast -D 'treelog.logEvery=10000,tracelog.logEvery=10000' dynamic_hcv_coal.xml
The full id
of a parameter you'd like to set must be specified.
beast -D 'clockRate.c:hcv=7.9E-4' dynamic_hcv_coal.xml
Explanation
The dynamic-beast
tool replaces all the parameter values in the XML file with the $(id.key=value)
format. The value variable is the default value that was initially specified in the XML file. However, the value can be redefined when running a BEAST analysis by making use of the BEAST2 definitions option (-D
) that allows for user specified values.
To ensure reproducibility you should recreate static XML files of runs using dynamic parameters, this can be achieved using the -DFout
argument e.g., beast -D 'clockRate.c:hcv=7.9E-4' -DFout static_hcv_coal.xml dynamic_hcv_coal.xml
.
Addtional features
CoupledMCMC
MC3 options for the BEAST package CoupledMCMC can be added by using the --mc3
option. This will add the default CoupledMCMC options which can then be configured at runtime with -D
.
# Create dynamic MC3 XML
dynamic-beast --mc3 hcv_coal.xml > dynamic_mc3_hcv_coal.xml
# Configure MC3 with BEAST
beast -D 'mcmc.chains=4' dynamic_mc3_hcv_coal.xml
Path Sampling (Stepping Stone)
Path sampling options for the package model-selection can be add by using the --ps
option. This will add the default model-selection options (e.g. stepping stone) which can then be configured at runtime with -D
.
# Create dynamic Path Sampling XML
dynamic-beast --ps hcv_coal.xml > dynamic_ps_hcv_coal.xml
# Configure Path Sampling with BEAST
beast -D "ps.doNotRun=true,ps.rootdir=$(pwd)" dynamic_ps_hcv_coal.xml
Nested sampling
Nested sampling for the package nested-sampling
can be add by using the --ns
option. This will add the default model-selection options which can then be configured at runtime with -D
.
# Create dynamic Nested Sampling XML
dynamic-beast --ns hcv_coal.xml > dynamic_ns_hcv_coal.xml
# Configure Path Sampling with BEAST
beast -D "mcmc.threads=6,mcmc.chainLength=40000" dynamic_ns_hcv_coal.xml
Auto apply optimisation suggestion
At the end of a analysis BEAST provides suggestions for optimising operators e.g. Try setting scaleFactor to about 0.96
. See the end of the example file. A path to the output file can be provided to the --optimise
flag and the suggestions will automatically be extracted and applied to the generated dynamic XML file.
dynamic-beast --optimise hcv_coal.out hcv_coal.xml > dynamic_hcv_coal.xml
Dynamic-beast will look for a line starting with Operator
and extract the suggestion from the lines that follow. So if you make your own .out
file (i.e. by copy-pasting the BEAST output) you need to make sure the file starts with Operator
on the first line.
Produce a json file of dynamic variables
Use the --json-out
file to produce a json file for all the dynamic variables.
dynamic-beast --json-out hcv_coal.json hcv_coal.xml > dynamic_hcv_coal.xml
Can be used with the beast -DF flag
beast -DF hcv_coal.json dynamic_hcv_coal.xml
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dynamic-beast-1.8.2.tar.gz
.
File metadata
- Download URL: dynamic-beast-1.8.2.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.2 Linux/5.11.0-1028-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5678d296f79c3678013baac546d379f74938045cfb2f12fdf1685f723a3a972c |
|
MD5 | 9ea7a75d6965cdfc921ab7e424c65cac |
|
BLAKE2b-256 | 0d42bc2f477b44af7eaa1aa6e40de782d4af29ee7ed0d883efb105c3a4f43f8e |
File details
Details for the file dynamic_beast-1.8.2-py3-none-any.whl
.
File metadata
- Download URL: dynamic_beast-1.8.2-py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.8.2 Linux/5.11.0-1028-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebe0521b97283e94701a257b1ccb2137fe0bbdc7de1005c86354385533a788f5 |
|
MD5 | b69968add483de9181e5511989e717af |
|
BLAKE2b-256 | cf77ce0f2b059b5c54a9471b1f728424f2531c9a0ca780cca7679807ee3a118e |