thanks and new install file

author: Alberto Ruiz <aruiz@um.es> 2011-12-26 11:40:04 +0100
committer: Alberto Ruiz <aruiz@um.es> 2011-12-26 11:40:04 +0100
commit: b421e2393c5a40eba4465b285a259a46409152e9 (patch)
tree: 6578ce81d298e600f8df8927efe20f73ee79e5e9
parent: 66b17bce538f573fc37090ac1428d7fee8c8b959 (diff)
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 @@
-INSTALLATION
-Recommended method (tested on Ubuntu/Debian systems):
-    $ sudo apt-get install libgsl0-dev liblapack-dev
-    $ cabal install hmatrix
-Detailed installation instructions:
-    http://code.haskell.org/hmatrix/install.html
-INSTALLATION ON WINDOWS
-1) Install the Haskell Platform (tested on 2011.2.0.1)
-   > cabal update
-2) Download and unzip the following file into a stable folder %GSL%
-   http://perception.inf.um.es/hmatrix/gsl-lapack-windows.zip
-3.a) In a msys shell installation should be fully automatic:
-   $ cabal install hmatrix --extra-lib-dir=${GSL} --extra-include-dir=${GSL}
-3.b) Alternatively, in a normal windows cmd:
-    > cabal unpack hmatrix
-    Edit hmatrix.cabal, in line 28 change build-type to "Simple", and then
-    > cabal install --extra-lib-dir=%GSL% --extra-include-dir=%GSL%
-    It may be necessary to put the dlls in the search path.
-4) If everything is ok we can run the tests:
-   > ghci
-   Prelude> Numeric.LinearAlgebra.Tests.runTests 20
-NOTE: The examples using graphics do not yet work in windows.
diff --git a/install.txt b/INSTALL.md
index fbcc051..666bdc8 100644
--- a/install.txt
+++ b/INSTALL.md
@@ -1,22 +1,13 @@
-<HEAD>
-    <TITLE>hmatrix installation</TITLE>
-    <STYLE> <!-- body{width: 600px; margin:50px auto;font-family:arial} --> </STYLE>
-</HEAD>
+# [hmatrix][hmatrix2] installation
+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**.)
 [hmatrix]: http://code.haskell.org/hmatrix
 [hmatrix2]: http://perception.inf.um.es/hmatrix
-[hmatrix][hmatrix2] installation
+## Linux ##################################################
-------------------------------------------------------
-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).
-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**.)
-### Linux ##################################################
 Ubuntu/Debian:
@@ -28,7 +19,7 @@ Arch Linux: If the automatic installation from Hackage fails, install atlas-lapa
 Other distributions may require additional libraries. They can be given in a **--configure-option**.
-### Mac OS/X ###############################################
+## Mac OS/X ###############################################
 GSL must be installed via MacPorts:
@@ -38,10 +29,35 @@ GSL must be installed via MacPorts:
 (Contributed by Heinrich Apfelmus and Torsten Kemps-Benedix).
-### Windows ###############################################
+## Windows ###############################################
+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].
+1) Install the Haskell Platform (tested on 2011.2.0.1)
+    > cabal update
+2) Download and unzip the following file into a stable folder %GSL%
+    http://perception.inf.um.es/hmatrix/gsl-lapack-windows.zip
+3.a) In a msys shell the installation should be fully automatic:
+    $ cabal install hmatrix --extra-lib-dir=${GSL} --extra-include-dir=${GSL}
+3.b) Alternatively, in a normal windows cmd:
+     > cabal unpack hmatrix
-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].
+   Edit hmatrix.cabal, in line 28 change build-type to "Simple", and then
+     > cabal install --extra-lib-dir=%GSL% --extra-include-dir=%GSL%
+   It may be necessary to put the dlls in the search path.
+NOTE: The examples using graphics do not yet work in windows.
 [install]: http://code.haskell.org/hmatrix/INSTALL
 [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
 - - -
-### Tests ###############################################
+## Tests ###############################################
 After installation we must verify that the library works as expected:
+    $ cabal install hmatrix-tests --enable-tests
    $ ghci
    > Numeric.LinearAlgebra.Tests.runTests 20
    OK, passed 100 tests. 
@@ -61,13 +78,9 @@ After installation we must verify that the library works as expected:
 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!
-If everything is ok you can reinstall the library with minimal dependencies:
-    $ cabal install --reinstall hmatrix -f-tests [-f-vector] [-f-binary]
 - - -
-### Optimized BLAS/LAPACK ##########################################
+## Optimized BLAS/LAPACK ##########################################
 I have successfully tested ATLAS and MKL on Linux.
@@ -96,18 +109,4 @@ The library must be installed with the -fmkl flag:
    $ cabal install hmatrix -fmkl
- - -
-### Known problems  ###############################################
- libatlas-sse2-dev in Ubuntu 9.04 is broken (see this 
-[bug report](https://bugs.launchpad.net/ubuntu/+source/atlas/+bug/368478)). Alternatively we can use libatlas-base-dev.
- 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.
- **catch** does not work if the error is produced by a Haskell function when it is called from inside C function.
- - -
-[Alberto Ruiz](http://dis.um.es/profesores/alberto)
diff --git a/THANKS b/THANKS
index f3fb949..3182cad 100644
--- a/THANKS
+++ b/THANKS
@@ -98,7 +98,7 @@ module reorganization, monadic mapVectorM, and many other improvements.
 - Mark Wright fixed the import of vector >= 0.8.
 - Bas van Dijk fixed the import of vector >= 0.8, got rid of some
-  deprecation warnings and used more explicit imports.
+  deprecation warnings, used more explicit imports, and updated to ghc-7.4.
 - Tom Nielsen discovered a problem in Config.hs, exposed by link problems
  in Ubuntu 11.10 beta.
author	Alberto Ruiz <aruiz@um.es>	2011-12-26 11:40:04 +0100
committer	Alberto Ruiz <aruiz@um.es>	2011-12-26 11:40:04 +0100
commit	b421e2393c5a40eba4465b285a259a46409152e9 (patch)
tree	6578ce81d298e600f8df8927efe20f73ee79e5e9
parent	66b17bce538f573fc37090ac1428d7fee8c8b959 (diff)