plugins/base1/se.lu.thep.wenni/trunk/INSTALL

Code
Comments
Other
Rev Date Author Line
69 11 Feb 06 jari 1 $Id$
69 11 Feb 06 jari 2
317 28 May 07 peter 3 ----------------------------------------------------------------------
317 28 May 07 peter 4 {{{
409 29 Aug 07 peter 5 Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
317 28 May 07 peter 6 Copyright (C) 2007 Peter Johansson
665 16 Apr 08 jari 7 Copyright (C) 2008 Jari Häkkinen
95 05 Apr 06 jari 8
95 05 Apr 06 jari 9 This file is part of WeNNI,
825 26 Nov 08 jari 10 http://baseplugins.thep.lu.se/wiki/se.lu.thep.WeNNI
95 05 Apr 06 jari 11
95 05 Apr 06 jari 12 WeNNI is free software; you can redistribute it and/or modify it under
95 05 Apr 06 jari 13 the terms of the GNU General Public License as published by the Free
824 26 Nov 08 jari 14 Software Foundation; either version 3 of the License, or (at your
95 05 Apr 06 jari 15 option) any later version.
95 05 Apr 06 jari 16
95 05 Apr 06 jari 17 WeNNI is distributed in the hope that it will be useful, but WITHOUT
95 05 Apr 06 jari 18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
95 05 Apr 06 jari 19 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
95 05 Apr 06 jari 20 for more details.
95 05 Apr 06 jari 21
95 05 Apr 06 jari 22 You should have received a copy of the GNU General Public License
824 26 Nov 08 jari 23 along with WeNNI. If not, see <http://www.gnu.org/licenses/>.
317 28 May 07 peter 24 }}}
317 28 May 07 peter 25 ----------------------------------------------------------------------
95 05 Apr 06 jari 26
95 05 Apr 06 jari 27
69 11 Feb 06 jari 28 If you think the instructions are worthless or stupid or maybe both,
69 11 Feb 06 jari 29 please tell me and I'll try to improve them. Even better, tell me how
70 13 Feb 06 jari 30 to improve them. My email address is jari@thep.lu.se
69 11 Feb 06 jari 31
389 14 Aug 07 peter 32 This package can be built in three different modes: base2, base1, and
389 14 Aug 07 peter 33 stand-alone. The base2 mode is default and the mode you should use if
389 14 Aug 07 peter 34 you plan on running WeNNI as plugin to BASE2. The base1 mode is the
665 16 Apr 08 jari 35 old (classic) mode similar to WeNNI 0.6 (or earlier). This is the mode
389 14 Aug 07 peter 36 you should use if you plan on using WeNNI as a plugin to BASE1. The
389 14 Aug 07 peter 37 stand-alone mode is intended for you who want to use the WeNNI
389 14 Aug 07 peter 38 algorithm independently of BASE. The different modes build and require
389 14 Aug 07 peter 39 different things. You choose the mode by giving the `configure` script
823 26 Nov 08 jari 40 the appropriate option. See below for more details on how to compile
823 26 Nov 08 jari 41 the package in the different modes.
71 14 Feb 06 jari 42
69 11 Feb 06 jari 43
389 14 Aug 07 peter 44
823 26 Nov 08 jari 45 = General requirements =
389 14 Aug 07 peter 46
823 26 Nov 08 jari 47 General requirements to build the package are that you work in a
823 26 Nov 08 jari 48 decent computing environment where you have access to tools such as
854 01 Dec 08 jari 49 make and a standards compliant C++ compiler. Since parts of the
854 01 Dec 08 jari 50 algorithms in WeNNI depends on the GNU scientific library it is
823 26 Nov 08 jari 51 required. GSL can be downloaded from http://www.gnu.org/software/gsl/.
389 14 Aug 07 peter 52
389 14 Aug 07 peter 53
389 14 Aug 07 peter 54
823 26 Nov 08 jari 55 = BASE 2 mode =
413 30 Aug 07 peter 56
823 26 Nov 08 jari 57 The core WeNNI algorithms are implemented in C++ and to be useful in
823 26 Nov 08 jari 58 BASE2 a Java wrapper is required. BASE2 only accepts plug-ins written
823 26 Nov 08 jari 59 in the Java programming language hence a Java wrapper is provided with
823 26 Nov 08 jari 60 WeNNI for BASE2. The wrapper will export appropriate data from the
823 26 Nov 08 jari 61 BASE2 server, run the WeNNI binary, and import data back to the
823 26 Nov 08 jari 62 server.
413 30 Aug 07 peter 63
844 01 Dec 08 jari 64 == Short instructions ==
844 01 Dec 08 jari 65
844 01 Dec 08 jari 66 It can be this easy:
844 01 Dec 08 jari 67
844 01 Dec 08 jari 68  1. Download and unpack WeNNI and `cd` to the root directory of the
844 01 Dec 08 jari 69     distribution.
844 01 Dec 08 jari 70
844 01 Dec 08 jari 71  2. If you haven't access to a BASE2 installation or prefer to use the
844 01 Dec 08 jari 72     standard compilation components, run the configure script with
854 01 Dec 08 jari 73     {{{
854 01 Dec 08 jari 74     $ ./configure --with-plugindir=/path/to/base/plugin-directory/wenni
854 01 Dec 08 jari 75     $ make
854 01 Dec 08 jari 76     $ make check
854 01 Dec 08 jari 77     $ make install-plugin
854 01 Dec 08 jari 78     }}}
844 01 Dec 08 jari 79
854 01 Dec 08 jari 80 If you have problems check the pre-requisites below.
844 01 Dec 08 jari 81
823 26 Nov 08 jari 82 == Pre-requisite ==
389 14 Aug 07 peter 83
823 26 Nov 08 jari 84  1. Java 1.6.
389 14 Aug 07 peter 85
844 01 Dec 08 jari 86  2. A working BASE2 installation or Internet connection. Some BASE2
823 26 Nov 08 jari 87     program libraries are required for the creation of the wrapper
844 01 Dec 08 jari 88     plug-in. Required libraries will be downloaded automatically, or
844 01 Dec 08 jari 89     local libraries can be used.
389 14 Aug 07 peter 90
854 01 Dec 08 jari 91  3. Version 0.1 of !PluginUtilities (http://baseplugins.thep.lu.se)
854 01 Dec 08 jari 92     package. Needed for creation of the Java wrapper. If the package
854 01 Dec 08 jari 93     is not available it will automatically be downloaded during the
854 01 Dec 08 jari 94     compilation process.
389 14 Aug 07 peter 95
823 26 Nov 08 jari 96  4. BASE 2.9 or later for plug-in use. Earlier versions may work but
823 26 Nov 08 jari 97     it is not tested.
389 14 Aug 07 peter 98
854 01 Dec 08 jari 99  5. Optionally, for testing, Perl (http://www.cpan.org/). The test
823 26 Nov 08 jari 100     programs can be run manually, see README for details.
389 14 Aug 07 peter 101
844 01 Dec 08 jari 102 == Automatic download of required BASE components ==
844 01 Dec 08 jari 103
844 01 Dec 08 jari 104 During the build process and depending on configuration options,
854 01 Dec 08 jari 105 required program libraries will be downloaded from the official BASE
854 01 Dec 08 jari 106 sites, http://base2.thep.lu.se/base and
854 01 Dec 08 jari 107 http://baseplugins.thep.lu.se. If you feel uncomfortable with this
854 01 Dec 08 jari 108 procedure you need to do some manual work.
844 01 Dec 08 jari 109
844 01 Dec 08 jari 110  1. If you have no working BASE2 installation, download the latest
844 01 Dec 08 jari 111     BASE2 binary package from http://base.thep.lu.se and unpack
844 01 Dec 08 jari 112     it. There is no need for further work, use the created directory
844 01 Dec 08 jari 113     as the path for the `--with-basedir` option given to the configure
844 01 Dec 08 jari 114     script below.
844 01 Dec 08 jari 115
854 01 Dec 08 jari 116  2. Download the !PluginUtilities package from
854 01 Dec 08 jari 117     http://base.thep.lu.se/wiki/net.sf.basedb.pluginutilities and
854 01 Dec 08 jari 118     place the package file in directory `base/base2`. The install
854 01 Dec 08 jari 119     process will use this file automatically but beware, a `make
854 01 Dec 08 jari 120     distclean` will erase the file (but `make clean` will not). This
854 01 Dec 08 jari 121     WeNNI package is known to work with version 0.1 of the
854 01 Dec 08 jari 122     !PluginUtilities package (only the latest known version will be
854 01 Dec 08 jari 123     given here), and the stated version is the one automatically
854 01 Dec 08 jari 124     downloaded in the build process.
844 01 Dec 08 jari 125
823 26 Nov 08 jari 126 == Building and installing the plug-in (WeNNI and the Java wrapper) ==
389 14 Aug 07 peter 127
823 26 Nov 08 jari 128  1. Download and unpack WeNNI and `cd` to the root directory of the
823 26 Nov 08 jari 129     distribution.
389 14 Aug 07 peter 130
823 26 Nov 08 jari 131  2. If you haven't access to a BASE2 installation or prefer to use the
823 26 Nov 08 jari 132     standard compilation components, run the configure script with
854 01 Dec 08 jari 133     {{{
854 01 Dec 08 jari 134     $ ./configure
854 01 Dec 08 jari 135     }}}
844 01 Dec 08 jari 136     This will automatically download required BASE related libraries
844 01 Dec 08 jari 137     from the official BASE package repositories (see output from the
854 01 Dec 08 jari 138     configure script on details about the downloads).
854 01 Dec 08 jari 139     [[br]] [[br]]
854 01 Dec 08 jari 140     There is a possibility to use the build tools to automatically
823 26 Nov 08 jari 141     install the package. In this case you may want to change the
823 26 Nov 08 jari 142     default plug-in installation path.
854 01 Dec 08 jari 143     {{{
854 01 Dec 08 jari 144     $ ./configure --with-plugindir=DIR
854 01 Dec 08 jari 145     }}}
844 01 Dec 08 jari 146     The default plug-in installation directory is the directory
856 02 Dec 08 jari 147     plugins/se/lu/thep/wenni rooted in `basedir`. If you prefer to
856 02 Dec 08 jari 148     install the plug-in manually you must place `nni`, `WeNNI.jar`,
856 02 Dec 08 jari 149     and `PluginUtilities-0.1pre.jar` in the same installation
856 02 Dec 08 jari 150     directory.
854 01 Dec 08 jari 151     [[br]] [[br]]
823 26 Nov 08 jari 152     If you prefer to compile WeNNI Java wrapper using your local BASE2
823 26 Nov 08 jari 153     installation. This is only needed if you have made local changes
823 26 Nov 08 jari 154     affecting plugins and where these modifications are required in
823 26 Nov 08 jari 155     the WeNNI Java wrapper. You should know if this is required, if
823 26 Nov 08 jari 156     you do not know simply go for the above option. So, if you know do
854 01 Dec 08 jari 157     {{{
854 01 Dec 08 jari 158     $ ./configure --with-basedir=/path/to/base
854 01 Dec 08 jari 159     }}}
844 01 Dec 08 jari 160     where `/path/to/base` should point to the directory containing
844 01 Dec 08 jari 161     directory `www`.
854 01 Dec 08 jari 162     [[br]] [[br]]
887 05 Dec 08 jari 163     ''Some notes on configure options:''
887 05 Dec 08 jari 164     [[br]] [[br]]
887 05 Dec 08 jari 165     The configure script accepts
854 01 Dec 08 jari 166     a few options that may be of interest. You can provide
854 01 Dec 08 jari 167     `./configure` with BASE2 location information with
854 01 Dec 08 jari 168     `--with-basedir=BASEDIR`. This information is used to find jar
854 01 Dec 08 jari 169     files such as `BASE2Core.jar` needed for compilation. The plug-in
854 01 Dec 08 jari 170     installation directory can be changed using `./configure` option
854 01 Dec 08 jari 171     `--with-plugindir=DIR`. Files will be installed in
854 01 Dec 08 jari 172     `<DIR>`. Default `DIR` is set to
887 05 Dec 08 jari 173     `<BASEDIR>/plugins/se/lu/thep/wenni/`.
887 05 Dec 08 jari 174     [[br]] [[br]]
887 05 Dec 08 jari 175     You may use `with-gsl=DIR`
823 26 Nov 08 jari 176     to provide information on GSL location. The option `enable-debug`
823 26 Nov 08 jari 177     turns on debug options on the compilation of binary `nni`
823 26 Nov 08 jari 178     (e.g. enables assertions).
887 05 Dec 08 jari 179     [[br]] [[br]]
887 05 Dec 08 jari 180     The Java compiler sometimes fails to recognize the character
887 05 Dec 08 jari 181     encoding of the source files. Use
887 05 Dec 08 jari 182     `--with-javasourceencoding=coding` to set the encoding of source
887 05 Dec 08 jari 183     files. You can find available encodings by doing `man javac`.
823 26 Nov 08 jari 184
823 26 Nov 08 jari 185  3. Now build using
854 01 Dec 08 jari 186     {{{
854 01 Dec 08 jari 187     $ make
854 01 Dec 08 jari 188     }}}
823 26 Nov 08 jari 189     If all went well `nni` was created in directory `bin/nni` as well
823 26 Nov 08 jari 190     as `WeNNI.jar` in directory `base/base2/`.
413 30 Aug 07 peter 191
823 26 Nov 08 jari 192  4. Optionally, run the test programs
854 01 Dec 08 jari 193     {{{
854 01 Dec 08 jari 194     $ make check
854 01 Dec 08 jari 195     }}}
823 26 Nov 08 jari 196
823 26 Nov 08 jari 197  5. Install files using
854 01 Dec 08 jari 198     {{{
854 01 Dec 08 jari 199     $ make install-plugin
854 01 Dec 08 jari 200     }}}
858 02 Dec 08 jari 201     If you prefer to install the plug-in manually you must place
858 02 Dec 08 jari 202     `nni`, `WeNNI.jar`, and `PluginUtilities-0.1pre.jar` in the same
858 02 Dec 08 jari 203     installation directory.
858 02 Dec 08 jari 204     [[br]] [[br]]
853 01 Dec 08 jari 205     Note! `make install` will install in location `${exec_prefix}/bin`
858 02 Dec 08 jari 206     which may be something else than your BASE plugin directory.
853 01 Dec 08 jari 207
823 26 Nov 08 jari 208  6. Make BASE2 aware of the plugin, see BASE2 documentation
858 02 Dec 08 jari 209     http://base.thep.lu.se/chrome/site/doc/html/index.html and use
858 02 Dec 08 jari 210     the below information with appropriate change of Path
858 02 Dec 08 jari 211     {{{
858 02 Dec 08 jari 212     Class: se.lu.thep.wenni.WeNNI
858 02 Dec 08 jari 213     Path : /path/to/base/pluginsse/lu/thep/wenni-0.7/WeNNI.jar
858 02 Dec 08 jari 214     }}}
858 02 Dec 08 jari 215     Path should be the absolute path to the WeNNI.jar file.
413 30 Aug 07 peter 216
413 30 Aug 07 peter 217
389 14 Aug 07 peter 218
823 26 Nov 08 jari 219 = BASE 1 mode =
69 11 Feb 06 jari 220
823 26 Nov 08 jari 221 This section is not well tested. Please report success or failure
823 26 Nov 08 jari 222 following these BASE1 related instructions.
71 14 Feb 06 jari 223
823 26 Nov 08 jari 224 The core WeNNI algorithms are implemented in C++ and to be useful in
823 26 Nov 08 jari 225 BASE1 a Perl wrapper is used. The wrapper will parse the from the
823 26 Nov 08 jari 226 BASE1 server exported data file, run the WeNNI binary, and generate a
823 26 Nov 08 jari 227 data file for import of data back to the server.
71 14 Feb 06 jari 228
823 26 Nov 08 jari 229 == Pre-requisite ==
69 11 Feb 06 jari 230
823 26 Nov 08 jari 231  1. Perl (http://www.cpan.org/) for testing and plug-in execution in
823 26 Nov 08 jari 232     the BASE1 server environment. The test programs can be run
823 26 Nov 08 jari 233     manually, see README for details.
70 13 Feb 06 jari 234
823 26 Nov 08 jari 235  2. A working BASE1 installation, or download the BASE1 plug-in
823 26 Nov 08 jari 236     development kit.
71 14 Feb 06 jari 237
823 26 Nov 08 jari 238 == Preparing WeNNI build for BASE1 ==
71 14 Feb 06 jari 239
823 26 Nov 08 jari 240  1. Download and unpack WeNNI. `cd` to the root directory of the
854 01 Dec 08 jari 241     distribution.
69 11 Feb 06 jari 242
823 26 Nov 08 jari 243  2. If you do not have access to a working BASE1 installation do the
823 26 Nov 08 jari 244     following steps; Download the BASE1 plug-in development kit from
823 26 Nov 08 jari 245     http://baseplugins.thep.lu.se/wiki/PluginDownload, unpack the
823 26 Nov 08 jari 246     package in the WeNNI root directory, compile the package, and then
823 26 Nov 08 jari 247     create a symbolic link to this directory. Basically, after
823 26 Nov 08 jari 248     download, issue the following sequence of commands in to prepare
823 26 Nov 08 jari 249     the devkit for WeNNI:
854 01 Dec 08 jari 250     {{{
823 26 Nov 08 jari 251     $ tar zxpf BASE-plugindevkit-1.2.17.tar.gz
823 26 Nov 08 jari 252     $ cd BASE-plugindevkit-1.2.17/bogus_base
823 26 Nov 08 jari 253     $ ./bootstrap
823 26 Nov 08 jari 254     $ ./configure
823 26 Nov 08 jari 255     $ make
823 26 Nov 08 jari 256     $ cd ../..
823 26 Nov 08 jari 257     $ ln -s BASE-plugindevkit-1.2.17 BASE-plugindevkit
854 01 Dec 08 jari 258     }}}
86 04 Apr 06 jari 259
838 29 Nov 08 peter 260 == Building and installing the plug-in (WeNNI with support) ==
69 11 Feb 06 jari 261
823 26 Nov 08 jari 262  1. You should already have downloaded WeNNI above if not please
854 01 Dec 08 jari 263     return to the previous section. `cd` to the root directory of the
854 01 Dec 08 jari 264     distribution.
69 11 Feb 06 jari 265
823 26 Nov 08 jari 266  2. Run configure script with 
854 01 Dec 08 jari 267     {{{
854 01 Dec 08 jari 268     $ ./configure --enable-state=base1 --with-basedir=BASEDIR
854 01 Dec 08 jari 269     }}}
854 01 Dec 08 jari 270     where <BASEDIR> is the absolute path to the root directory of your
854 01 Dec 08 jari 271     working BASE1 installation, or if you are using the developer kit,
854 01 Dec 08 jari 272     the absolute path to the bogus_base directory created above:
854 01 Dec 08 jari 273     `/path/to/wenni/BASE-plugindevkit/bogus-base`
854 01 Dec 08 jari 274     [[br]] [[br]]
887 05 Dec 08 jari 275     ''Some notes on configure options:''
887 05 Dec 08 jari 276     [[br]] [[br]]
887 05 Dec 08 jari 277     The configure script accepts
854 01 Dec 08 jari 278     a few options that may be of interest. You generally must provide
854 01 Dec 08 jari 279     `./configure` with BASE1 location information with
854 01 Dec 08 jari 280     `--with-basedir=BASEDIR`. This information is used to find BASE1
854 01 Dec 08 jari 281     API (program libraries and header files). Header file `basefile.h`
854 01 Dec 08 jari 282     is expected to reside in `<BASEDIR>/include/cxx/`. `<BASEDIR>`
854 01 Dec 08 jari 283     must be an absolute path. The plug-in installation directory can
854 01 Dec 08 jari 284     be changed using `./configure` option
854 01 Dec 08 jari 285     `with-plugindir=DIR`. Default `DIR` is set to
823 26 Nov 08 jari 286     `<BASEDIR>/plugins/bin/wenni/`. You may use `with-gsl=DIR` to
823 26 Nov 08 jari 287     provide information on GSL location. The option `enable-debug`
823 26 Nov 08 jari 288     turns on debug options on the compilation of binary `nni`
823 26 Nov 08 jari 289     (e.g. enables assertions).
69 11 Feb 06 jari 290
823 26 Nov 08 jari 291  3. Now build using 
854 01 Dec 08 jari 292     {{{
854 01 Dec 08 jari 293     $ make
854 01 Dec 08 jari 294     }}}
69 11 Feb 06 jari 295
823 26 Nov 08 jari 296  4. Optionally, run the test programs
854 01 Dec 08 jari 297     {{{
854 01 Dec 08 jari 298     $ make check
854 01 Dec 08 jari 299     }}}
69 11 Feb 06 jari 300
823 26 Nov 08 jari 301  5. Install files using 
854 01 Dec 08 jari 302     {{{
854 01 Dec 08 jari 303     $ make install-plugin
854 01 Dec 08 jari 304     }}}
853 01 Dec 08 jari 305     Note! `make install` will install in location `${exec_prefix}/bin`
853 01 Dec 08 jari 306     which maybe something else than the BASE plugin directory.
853 01 Dec 08 jari 307
854 01 Dec 08 jari 308  6. ''Make BASE1 aware of the plugin.''  Make sure that the settings
854 01 Dec 08 jari 309     in the plug-in definitions file are set appropriately when
854 01 Dec 08 jari 310     importing the plug-in definitions file
854 01 Dec 08 jari 311     (`base/base1/base_plugin_script/plugin_WeNNI.base`) into
854 01 Dec 08 jari 312     BASE1. More explicitly make sure that the entry in the web GUI:
854 01 Dec 08 jari 313     'Name of executable' is set according to the wenni.pl install
854 01 Dec 08 jari 314     location. If you prefer to make the change in the file you should
854 01 Dec 08 jari 315     manipulate the line starting with `execName`.
854 01 Dec 08 jari 316     [[br]] [[br]]
854 01 Dec 08 jari 317     If you want use other than the default fields for intensity1,
854 01 Dec 08 jari 318     intensity2, BCh1SD, and BCh2SD, you need to indicate this in the
854 01 Dec 08 jari 319     WeNNIParams section of the plug-in definition file. Change the 5th
854 01 Dec 08 jari 320     column of parameters 4 through 7 appropriately, i.e., if the
854 01 Dec 08 jari 321     standard deviation is defined in another column than the default
854 01 Dec 08 jari 322     change lines 6 and 7:
854 01 Dec 08 jari 323     ≈ß©{{{
854 01 Dec 08 jari 324     6  h  BCh1SD    30  _xc_BCh1SD    0
854 01 Dec 08 jari 325     7  h  BCh2SD    30  _xc_BCh2SD    0
854 01 Dec 08 jari 326     }}}
69 11 Feb 06 jari 327
69 11 Feb 06 jari 328
86 04 Apr 06 jari 329
823 26 Nov 08 jari 330 = Stand alone mode =
86 04 Apr 06 jari 331
823 26 Nov 08 jari 332 The core WeNNI algorithms are implemented in C++ whereas the test
823 26 Nov 08 jari 333 script is written in Perl.
86 04 Apr 06 jari 334
844 01 Dec 08 jari 335 == Short instructions ==
844 01 Dec 08 jari 336
844 01 Dec 08 jari 337 It can be this easy:
844 01 Dec 08 jari 338
844 01 Dec 08 jari 339  1. Download and unpack WeNNI and `cd` to the root directory of the
844 01 Dec 08 jari 340     distribution.
844 01 Dec 08 jari 341
844 01 Dec 08 jari 342  2. Do
854 01 Dec 08 jari 343     {{{
854 01 Dec 08 jari 344     $ ./configure --enable-state=stand-alone
854 01 Dec 08 jari 345     $ make
854 01 Dec 08 jari 346     $ make check
854 01 Dec 08 jari 347     $ make install
854 01 Dec 08 jari 348     }}}
844 01 Dec 08 jari 349
823 26 Nov 08 jari 350 == Pre-requisite ==
89 04 Apr 06 jari 351
823 26 Nov 08 jari 352  Optionally, for testing, Perl (http://www.cpan.org/). The test
823 26 Nov 08 jari 353  programs can be run manually, see README for details.
69 11 Feb 06 jari 354
823 26 Nov 08 jari 355 == Building and installing WeNNI ==
69 11 Feb 06 jari 356
823 26 Nov 08 jari 357  1. Download and unpack WeNNI and `cd` to the root directory of the
823 26 Nov 08 jari 358     distribution.
89 04 Apr 06 jari 359
823 26 Nov 08 jari 360  2. If you haven't access to a BASE installation or prefer to use the
823 26 Nov 08 jari 361     standard compilation components, run the configure script with
854 01 Dec 08 jari 362     {{{
854 01 Dec 08 jari 363     $ ./configure  --enable-state=stand-alone
854 01 Dec 08 jari 364     }}}
887 05 Dec 08 jari 365     ''Some notes on configure options:''
887 05 Dec 08 jari 366     [[br]] [[br]]
887 05 Dec 08 jari 367     Do `./configure --help` for
854 01 Dec 08 jari 368     details in available options. You may use `with-gsl=DIR` to
854 01 Dec 08 jari 369     provide information on GSL location. The option `enable-debug`
854 01 Dec 08 jari 370     turns on debug options on the compilation of binary `nni`
854 01 Dec 08 jari 371     (e.g. enables assertions).
665 16 Apr 08 jari 372
823 26 Nov 08 jari 373  3. Now build using
854 01 Dec 08 jari 374     {{{
854 01 Dec 08 jari 375     $ make
854 01 Dec 08 jari 376     }}}
823 26 Nov 08 jari 377     If the package was successfully compiled two binaries are created;
823 26 Nov 08 jari 378     `NNIFileConverter` and `nni`.
823 26 Nov 08 jari 379
823 26 Nov 08 jari 380  4. Optionally, run the test programs
854 01 Dec 08 jari 381     {{{
854 01 Dec 08 jari 382     $ make check
854 01 Dec 08 jari 383     }}}
823 26 Nov 08 jari 384
823 26 Nov 08 jari 385  5. Install with
854 01 Dec 08 jari 386     {{{
854 01 Dec 08 jari 387     $ make install
854 01 Dec 08 jari 388     }}}
854 01 Dec 08 jari 389     Note! `make install-plugin` will do the same thing as `make install`.
823 26 Nov 08 jari 390
823 26 Nov 08 jari 391
854 01 Dec 08 jari 392 = Test program fails =
823 26 Nov 08 jari 393
854 01 Dec 08 jari 394 The numerical checks are very restrictive, if 'make check' fails this
823 26 Nov 08 jari 395 may be due to rounding errors. You can loosen the error bound in the
823 26 Nov 08 jari 396 tests by changing the default value in test/wenni_test.cc. Search for:
823 26 Nov 08 jari 397 {{{
823 26 Nov 08 jari 398 bool compare(const std::string&, const std::string&, double error_bound=1e-20);
823 26 Nov 08 jari 399 }}}

Generated on Tue Nov 21 03:42:34 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)