Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
C++ Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
Release notes for Muninn ------------------------ Table of content 1. Introduction 2. Documentation and manual 3. Installation 4. Supported systems 5. License 5.1 The Eigen library 1. Introduction --------------- Muninn is a software package for estimating generalized ensemble weights in Markov chain Monte Carlo (MCMC) simulations. The method is full automated and makes use of the generalized multihistogram (GMH) equations for estimation the density of states . The package is implemented in C++ and has a convenient interface. A scientific article describing the method is currently in preparation for publication. The package is developed by Jes Frellsen and Jesper Ferkinghoff-Borg.  Jesper Ferkinghoff-Borg (2002) Optimized Monte Carlo analysis for generalized ensembles. Eur Phys J B 29(3):481. doi:10.1140/epjb/e2002-00328-1 2. Documentation and manual --------------------------- The Muninn code is documented using Doxygen and in-line comments. The Doxygen documentation can be generated by running the command 'doxygen' from the Muninn root folder. The browsable html-documentation will be made available online. A manual for Muninn is in preparations. 3. Installation --------------- The GNU build system (Autotools) is the preferred build systems for Muninn, however CMake is also supported. First the configure script has to be generated. If the Muninn root folder already contains the script 'configure' you can skip this step. The configure script is generated by running the script autogen.sh in the Muninn root folder, that is ./autogen When you have the configure script, Muninn can be build with the following commands from the Muninn root folder ./configure make After this Muninn can be installed on the system using the command make install 4. Supported systems -------------------- Muninn has been compiled successfully on many different Linux distributions and on Mac OS X. It compiles both with GCC (version 4.2.4 to 4.4.5 has been tested) and Intel compilers. 5. License ---------- Muninn is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation. Muninn 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. GNU General Public License is described in the file LICENSE.txt. For further details regarding the GNU General Pulbic License we refer to the GNU web-site <http://www.gnu.org/licenses/>. The following additional terms apply to the Muninn software: Neither the names of its contributors nor the names of the organizations they are, or have been, associated with may be used to endorse or promote products derived from this software without specific prior written permission. 5.1 The Eigen library --------------------- The Eigen library is distributed along with the Muninn library (in the sub-folder external/Eigen). The Eigen library can normally be licensed under GNU Lesser General Public License version 3 (or later) or GNU General Public License version 2 (or later). See the Eigen web pages for more details <http://eigen.tuxfamily.org/>. Here, Eigen is distributed under the General Public License version 3.