Improved MatLab build process and some smaller misc changes
[libdai.git] / README
diff --git a/README b/README
index 78ecaf8..9dd8b2e 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
 libDAI  -  A free/open source C++ library for Discrete Approximate Inference
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Version:  git HEAD
-Date:     November 16, 2009 - or later
+Date:     February 11, 2010 - or later
 See also: http://www.libdai.org
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 License
 
@@ -22,26 +22,36 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with libDAI in the file COPYING. If not, see http://www.gnu.org/licenses/
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Citing libDAI
 
 If you write a scientific paper describing research that made substantive use
 of this program, please:
 
-   mention the fashion in which this software was used, including the version
+  * mention the fashion in which this software was used, including the version
     number, with a citation to the literature, to allow replication;
-   mention this software in the Acknowledgements section.
+  * mention this software in the Acknowledgements section.
 
 An appropriate citation would be:
-J. M. Mooij (2009) "libDAI 0.2.3: A free/open source C++ library for Discrete
-Approximate Inference", http://www.libdai.org
+
+Joris M. Mooij et al. (2010) "libDAI 0.2.4: A free/open source C++ library for
+Discrete Approximate Inference", http://www.libdai.org
+
+or in BiBTeX format:
+
+  @misc{mooij2010libdai,
+    author = "Joris M. Mooij et al.",
+    title = "lib{DAI} 0.2.4: A free/open source {C}++ library for {D}iscrete {A}pproximate {I}nference",
+    howpublished = "http://www.libdai.org/",
+    year = 2010
+  }
+
 
 Moreover, as a personal note, I would appreciate it if you would email
-(citations of) papers referencing this work to joris dot mooij at libdai dot
-org.
+(citations of) papers referencing this work to joris dot mooij at libdai dot org.
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 About libDAI
 
@@ -56,10 +66,10 @@ understanding of graphical models is needed.
 The best way to use libDAI is by writing C++ code that invokes the library; in
 addition, part of the functionality is accessibly by using the
 
-   command line interface
-   (limited) MatLab interface
-   (experimental) python interface
-   (experimental) octave interface.
+  * command line interface
+  * (limited) MatLab interface
+  * (experimental) python interface
+  * (experimental) octave interface.
 
 libDAI can be used to implement novel (approximate) inference algorithms and to
 easily compare the accuracy and performance with existing algorithms that have
@@ -69,16 +79,18 @@ Features
 
 Currently, libDAI supports the following (approximate) inference methods:
 
-  • Exact inference by brute force enumeration;
-  • Exact inference by junction-tree methods;
-  • Mean Field;
-  • Loopy Belief Propagation [KFL01];
-  • Tree Expectation Propagation [MiQ04];
-  • Generalized Belief Propagation [YFW05];
-  • Double-loop GBP [HAK03];
-  • Various variants of Loop Corrected Belief Propagation [MoK07, MoR05];
-  • Gibbs sampler;
-  • Conditioned BP [EaG09].
+  * Exact inference by brute force enumeration;
+  * Exact inference by junction-tree methods;
+  * Mean Field;
+  * Loopy Belief Propagation [KFL01];
+  * Fractional Belief Propagation [WiH03];
+  * Tree-Reweighted Belief Propagation [WJW03];
+  * Tree Expectation Propagation [MiQ04];
+  * Generalized Belief Propagation [YFW05];
+  * Double-loop GBP [HAK03];
+  * Various variants of Loop Corrected Belief Propagation [MoK07, MoR05];
+  * Gibbs sampler;
+  * Conditioned Belief Propagation [EaG09].
 
 These inference methods can be used to calculate partition sums, marginals over
 subsets of variables, and MAP states (the joint state of variables that has
@@ -139,19 +151,21 @@ Mailing list
 
 The Google group "libDAI" (http://groups.google.com/group/libdai) can be used
 for getting support and discussing development issues.
-
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Building libDAI under UNIX variants (Linux / Cygwin / Mac OS X)
 
+Preparations
+
 You need:
 
-  • a recent version of gcc (at least version 3.4)
-  • GNU make
-  • doxygen
-  • graphviz
-  • recent boost C++ libraries (at least version 1.34, or 1.37 for cygwin;
-    version 1.37 shipped with Ubuntu 9.04 is known not to work)
+  * a recent version of gcc (at least version 3.4)
+  * GNU make
+  * doxygen
+  * graphviz
+  * recent boost C++ libraries (at least version 1.34 if you have a recent
+    version of GCC, otherwise at least version 1.37; however, version 1.37
+    shipped with Ubuntu 9.04 is known not to work)
 
 On Debian/Ubuntu, you can easily install all these packages with a single
 command:
@@ -177,65 +191,72 @@ http://www.boost.org/ and compile/install it with:
   make install
 
 
+Building libDAI
+
 To build the libDAI source, first copy a template Makefile.* to Makefile.conf
 (for example, copy Makefile.LINUX to Makefile.conf if you use GNU/Linux). Then,
 edit the Makefile.conf template to adapt it to your local setup. Especially
-directories may differ from system to system. Finally, run
+directories may differ from system to system. Platform independent build
+options can be set in Makefile.ALL. Finally, run
 
   make
 
 The build includes a regression test, which may take a while to complete.
 
-If the build was successful, you can test the example program:
+If the build is successful, you can test the example program:
 
   examples/example tests/alarm.fg
 
-or the more elaborate test program:
+or the more extensive test program:
 
   tests/testdai --aliases tests/aliases.conf --filename tests/alarm.fg --methods JTREE_HUGIN BP_SEQMAX
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Building libDAI under Windows
 
+Preparations
+
 You need:
 
-  • A recent version of MicroSoft Visual Studio (2008 works)
-  • recent boost C++ libraries (version 1.34 or higher)
-   GNU make (can be obtained from http://gnuwin32.sourceforge.net)
+  * A recent version of MicroSoft Visual Studio (2008 is known to work)
+  * recent boost C++ libraries (version 1.37 or higher)
+  * GNU make (can be obtained from http://gnuwin32.sourceforge.net)
 
 For the regression test, you need:
 
-  • GNU diff, GNU sed (can be obtained from http://gnuwin32.sourceforge.net)
+  * GNU diff, GNU sed (can be obtained from http://gnuwin32.sourceforge.net)
+
+Building libDAI
 
 To build the source, copy Makefile.WINDOWS to Makefile.conf. Then, edit
-Makefile.conf to adapt it to your local setup. Finally, run (from the command
-line)
+Makefile.conf to adapt it to your local setup. Platform independent build
+options can be set in Makefile.ALL. Finally, run (from the command line)
 
   make
 
 The build includes a regression test, which may take a while to complete.
 
-If the build was successful, you can test the example program:
+If the build is successful, you can test the example program:
 
-  example tests\alarm.fg
+  examples\example tests\alarm.fg
 
-or the more elaborate test program:
+or the more extensive test program:
 
   tests\testdai --aliases tests\aliases.conf --filename tests\alarm.fg --methods JTREE_HUGIN BP_SEQMAX
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Building the libDAI MatLab interface
 
 You need:
 
-   MatLab
-   The platform-dependent requirements described above
+  * MatLab
+  * The platform-dependent requirements described above
 
 First, you need to build the libDAI source as described above for your
 platform. By default, the MatLab interface is disabled, so before compiling the
-source, you have to enable it in the Makefile.conf by setting
+source, you have to enable it in Makefile.ALL by setting
 
   WITH_MATLAB=true
 
@@ -259,7 +280,7 @@ at the MatLab prompt), which performs exact inference by the junction tree
 algorithm and approximate inference by belief propagation on the ALARM network:
 
   cd path_to_libdai/matlab
-  [psi] = dai_readfg ('../examples/alarm.fg');
+  [psi] = dai_readfg ('../tests/alarm.fg');
   [logZ,q,md,qv,qf] = dai (psi, 'JTREE', '[updates=HUGIN,verbose=0]')
   [logZ,q,md,qv,qf] = dai (psi, 'BP', '[updates=SEQMAX,tol=1e-9,maxiter=10000,logdomain=0]')
 
@@ -267,7 +288,7 @@ where "path_to_libdai" has to be replaced with the directory in which libDAI
 was installed. For other algorithms and some default parameters, see the file
 tests/aliases.conf.
 
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
 
 Building the documentation
 
@@ -278,4 +299,3 @@ Install doxygen, graphviz and a TeX distribution and use
 to build the documentation. If the documentation is not clear enough, feel free
 to send me an email (or even better, to improve the documentation and send a
 patch!). The documentation can also be browsed online at http://www.libdai.org.
-