README.md

Welcome to DNest3

Relative to older DNest versions, DNest3 has improved performance
(in terms of the sampling overhead, likelihood evaluations still dominate in
general) and is cleaner code: implementing new models should be easier than it
was before. In addition, DNest3 is multi-threaded, so you can run multiple
MCMC walkers at the same time, and the results will be combined together.

For documentation (currently in a draft state),
please compile the LaTeX manual in the doc directory.

The Paper

Before you use DNest3, you might want to read the paper describing the
Diffusive Nested Sampling algorithm. If you find this software useful in your
own work, please also feel free to cite this paper.

Building

This will install the DNest3 library and header files into /usr/local, while
example programs are available in DNest3/Examples. If required,
change the installation location by giving a -DCMAKE_INSTALL_PREFIX option
to CMake:

cmake -DCMAKE_INSTALL_PREFIX=/tmp ..

Other useful options include:

-DCMAKE_BUILD_TYPE=debug

Turn off optimization and include debugging symbols: the resulting code will
be much slower.

-DBUILD_SHARED_LIBS=true

Build libdnest3 as a shared library.

-DBUILD_MANUAL=true

Build a PDF manual in DNest3/build/doc. Requires pdfLaTeX.

Copyright and Licence

DNest3 is Copyright (c) 2009-2014 Brendon J. Brewer.

DNest3 is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

DNest3 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.