diff options
-rw-r--r-- | INSTALL | 40 | ||||
-rw-r--r-- | INSTALL.md (renamed from install.txt) | 71 | ||||
-rw-r--r-- | THANKS | 2 |
3 files changed, 36 insertions, 77 deletions
diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 2d292b2..0000000 --- a/INSTALL +++ /dev/null | |||
@@ -1,40 +0,0 @@ | |||
1 | INSTALLATION | ||
2 | |||
3 | Recommended method (tested on Ubuntu/Debian systems): | ||
4 | $ sudo apt-get install libgsl0-dev liblapack-dev | ||
5 | $ cabal install hmatrix | ||
6 | |||
7 | Detailed installation instructions: | ||
8 | http://code.haskell.org/hmatrix/install.html | ||
9 | |||
10 | INSTALLATION ON WINDOWS | ||
11 | |||
12 | 1) Install the Haskell Platform (tested on 2011.2.0.1) | ||
13 | |||
14 | > cabal update | ||
15 | |||
16 | 2) Download and unzip the following file into a stable folder %GSL% | ||
17 | |||
18 | http://perception.inf.um.es/hmatrix/gsl-lapack-windows.zip | ||
19 | |||
20 | 3.a) In a msys shell installation should be fully automatic: | ||
21 | |||
22 | $ cabal install hmatrix --extra-lib-dir=${GSL} --extra-include-dir=${GSL} | ||
23 | |||
24 | 3.b) Alternatively, in a normal windows cmd: | ||
25 | |||
26 | > cabal unpack hmatrix | ||
27 | |||
28 | Edit hmatrix.cabal, in line 28 change build-type to "Simple", and then | ||
29 | |||
30 | > cabal install --extra-lib-dir=%GSL% --extra-include-dir=%GSL% | ||
31 | |||
32 | It may be necessary to put the dlls in the search path. | ||
33 | |||
34 | 4) If everything is ok we can run the tests: | ||
35 | |||
36 | > ghci | ||
37 | Prelude> Numeric.LinearAlgebra.Tests.runTests 20 | ||
38 | |||
39 | NOTE: The examples using graphics do not yet work in windows. | ||
40 | |||
@@ -1,22 +1,13 @@ | |||
1 | <HEAD> | ||
2 | <TITLE>hmatrix installation</TITLE> | ||
3 | <STYLE> <!-- body{width: 600px; margin:50px auto;font-family:arial} --> </STYLE> | ||
4 | </HEAD> | ||
5 | 1 | ||
2 | # [hmatrix][hmatrix2] installation | ||
3 | |||
4 | This package requires the [Glasgow Haskell Compiler](http://www.haskell.org/ghc/index.html) ghc >= 6.10, and [cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install), conveniently available in the [Haskell Platform](http://hackage.haskell.org/platform), and the development packages for [GSL](http://www.gnu.org/software/gsl) and BLAS/[LAPACK](http://www.netlib.org/lapack). (The graphical functions also require **gnuplot** and **imagemagick**.) | ||
6 | 5 | ||
7 | [hmatrix]: http://code.haskell.org/hmatrix | 6 | [hmatrix]: http://code.haskell.org/hmatrix |
8 | [hmatrix2]: http://perception.inf.um.es/hmatrix | 7 | [hmatrix2]: http://perception.inf.um.es/hmatrix |
9 | 8 | ||
10 | 9 | ||
11 | [hmatrix][hmatrix2] installation | 10 | ## Linux ################################################## |
12 | ------------------------------------------------------- | ||
13 | |||
14 | This package requires the [Glasgow Haskell Compiler](http://www.haskell.org/ghc/index.html) ghc >= 6.10, and [cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install), conveniently available in the [Haskell Platform](http://hackage.haskell.org/platform). | ||
15 | |||
16 | We also need the development packages for [GSL](http://www.gnu.org/software/gsl) and BLAS/[LAPACK](http://www.netlib.org/lapack). (The graphical functions also require **gnuplot** and **imagemagick**.) | ||
17 | |||
18 | |||
19 | ### Linux ################################################## | ||
20 | 11 | ||
21 | 12 | ||
22 | Ubuntu/Debian: | 13 | Ubuntu/Debian: |
@@ -28,7 +19,7 @@ Arch Linux: If the automatic installation from Hackage fails, install atlas-lapa | |||
28 | 19 | ||
29 | Other distributions may require additional libraries. They can be given in a **--configure-option**. | 20 | Other distributions may require additional libraries. They can be given in a **--configure-option**. |
30 | 21 | ||
31 | ### Mac OS/X ############################################### | 22 | ## Mac OS/X ############################################### |
32 | 23 | ||
33 | 24 | ||
34 | GSL must be installed via MacPorts: | 25 | GSL must be installed via MacPorts: |
@@ -38,10 +29,35 @@ GSL must be installed via MacPorts: | |||
38 | 29 | ||
39 | (Contributed by Heinrich Apfelmus and Torsten Kemps-Benedix). | 30 | (Contributed by Heinrich Apfelmus and Torsten Kemps-Benedix). |
40 | 31 | ||
41 | ### Windows ############################################### | 32 | ## Windows ############################################### |
33 | |||
34 | We use this [GSL binary](http://www.miscdebris.net/blog/2009/04/20/mingw-345-binaries-of-gnu-scientific-library-112-for-use-with-mingw-and-visual-c/), and blas/lapack dlls built with g77 (contributed by Gilberto Camara). All required files are in [gsl-lapack-windows.zip][winpack]. | ||
35 | |||
36 | |||
37 | 1) Install the Haskell Platform (tested on 2011.2.0.1) | ||
38 | |||
39 | > cabal update | ||
40 | |||
41 | 2) Download and unzip the following file into a stable folder %GSL% | ||
42 | |||
43 | http://perception.inf.um.es/hmatrix/gsl-lapack-windows.zip | ||
44 | |||
45 | 3.a) In a msys shell the installation should be fully automatic: | ||
46 | |||
47 | $ cabal install hmatrix --extra-lib-dir=${GSL} --extra-include-dir=${GSL} | ||
48 | |||
49 | 3.b) Alternatively, in a normal windows cmd: | ||
42 | 50 | ||
51 | > cabal unpack hmatrix | ||
43 | 52 | ||
44 | See the [INSTALL file][install2] included in the distribution. We use this [GSL binary](http://www.miscdebris.net/blog/2009/04/20/mingw-345-binaries-of-gnu-scientific-library-112-for-use-with-mingw-and-visual-c/), and blas/lapack dlls built with g77 (contributed by Gilberto Camara). All required files are in [gsl-lapack-windows.zip][winpack]. | 53 | Edit hmatrix.cabal, in line 28 change build-type to "Simple", and then |
54 | |||
55 | > cabal install --extra-lib-dir=%GSL% --extra-include-dir=%GSL% | ||
56 | |||
57 | It may be necessary to put the dlls in the search path. | ||
58 | |||
59 | |||
60 | NOTE: The examples using graphics do not yet work in windows. | ||
45 | 61 | ||
46 | [install]: http://code.haskell.org/hmatrix/INSTALL | 62 | [install]: http://code.haskell.org/hmatrix/INSTALL |
47 | [install2]: http://patch-tag.com/r/aruiz/hmatrix/snapshot/current/content/pretty/INSTALL | 63 | [install2]: http://patch-tag.com/r/aruiz/hmatrix/snapshot/current/content/pretty/INSTALL |
@@ -49,10 +65,11 @@ See the [INSTALL file][install2] included in the distribution. We use this [GSL | |||
49 | 65 | ||
50 | - - - | 66 | - - - |
51 | 67 | ||
52 | ### Tests ############################################### | 68 | ## Tests ############################################### |
53 | 69 | ||
54 | After installation we must verify that the library works as expected: | 70 | After installation we must verify that the library works as expected: |
55 | 71 | ||
72 | $ cabal install hmatrix-tests --enable-tests | ||
56 | $ ghci | 73 | $ ghci |
57 | > Numeric.LinearAlgebra.Tests.runTests 20 | 74 | > Numeric.LinearAlgebra.Tests.runTests 20 |
58 | OK, passed 100 tests. | 75 | OK, passed 100 tests. |
@@ -61,13 +78,9 @@ After installation we must verify that the library works as expected: | |||
61 | 78 | ||
62 | If you get any failure please run lapack's own tests to confirm that your version is not broken. For instance, in ubuntu 9.04, **libatlas-sse2** does not work (see this [bug report](https://bugs.launchpad.net/ubuntu/+source/atlas/+bug/368478)). If your lapack library is ok but hmatrix's tests fail please send a bug report! | 79 | If you get any failure please run lapack's own tests to confirm that your version is not broken. For instance, in ubuntu 9.04, **libatlas-sse2** does not work (see this [bug report](https://bugs.launchpad.net/ubuntu/+source/atlas/+bug/368478)). If your lapack library is ok but hmatrix's tests fail please send a bug report! |
63 | 80 | ||
64 | If everything is ok you can reinstall the library with minimal dependencies: | ||
65 | |||
66 | $ cabal install --reinstall hmatrix -f-tests [-f-vector] [-f-binary] | ||
67 | |||
68 | - - - | 81 | - - - |
69 | 82 | ||
70 | ### Optimized BLAS/LAPACK ########################################## | 83 | ## Optimized BLAS/LAPACK ########################################## |
71 | 84 | ||
72 | I have successfully tested ATLAS and MKL on Linux. | 85 | I have successfully tested ATLAS and MKL on Linux. |
73 | 86 | ||
@@ -96,18 +109,4 @@ The library must be installed with the -fmkl flag: | |||
96 | 109 | ||
97 | $ cabal install hmatrix -fmkl | 110 | $ cabal install hmatrix -fmkl |
98 | 111 | ||
99 | - - - | ||
100 | |||
101 | ### Known problems ############################################### | ||
102 | |||
103 | - libatlas-sse2-dev in Ubuntu 9.04 is broken (see this | ||
104 | [bug report](https://bugs.launchpad.net/ubuntu/+source/atlas/+bug/368478)). Alternatively we can use libatlas-base-dev. | ||
105 | |||
106 | - On **64-bit** machines the example "minimize.hs", when run from ghci, produces a segmentation fault. It happens in the call to gsl\_multimin\_fdfminimizer_alloc, inside the C wrapper. If the program is called by runhaskell, it just terminates prematurely, producing no results. Curiously, in compiled mode the program seems to work perfectly well. | ||
107 | |||
108 | - **catch** does not work if the error is produced by a Haskell function when it is called from inside C function. | ||
109 | |||
110 | - - - | ||
111 | |||
112 | [Alberto Ruiz](http://dis.um.es/profesores/alberto) | ||
113 | 112 | ||
@@ -98,7 +98,7 @@ module reorganization, monadic mapVectorM, and many other improvements. | |||
98 | - Mark Wright fixed the import of vector >= 0.8. | 98 | - Mark Wright fixed the import of vector >= 0.8. |
99 | 99 | ||
100 | - Bas van Dijk fixed the import of vector >= 0.8, got rid of some | 100 | - Bas van Dijk fixed the import of vector >= 0.8, got rid of some |
101 | deprecation warnings and used more explicit imports. | 101 | deprecation warnings, used more explicit imports, and updated to ghc-7.4. |
102 | 102 | ||
103 | - Tom Nielsen discovered a problem in Config.hs, exposed by link problems | 103 | - Tom Nielsen discovered a problem in Config.hs, exposed by link problems |
104 | in Ubuntu 11.10 beta. | 104 | in Ubuntu 11.10 beta. |