README.md

   1 # LAPACK
   2
   3 [![Build Status](https://travis-ci.org/Reference-LAPACK/lapack.svg?branch=master)](https://travis-ci.org/Reference-LAPACK/lapack)
   4 [![Appveyor](https://ci.appveyor.com/api/projects/status/bh38iin398msrbtr?svg=true)](https://ci.appveyor.com/project/langou/lapack/)
   5 [![codecov](https://codecov.io/gh/Reference-LAPACK/lapack/branch/master/graph/badge.svg)](https://codecov.io/gh/Reference-LAPACK/lapack)
   6
   7
   8 * VERSION 1.0   :  February 29, 1992
   9 * VERSION 1.0a  :  June 30, 1992
  10 * VERSION 1.0b  :  October 31, 1992
  11 * VERSION 1.1   :  March 31, 1993
  12 * VERSION 2.0   :  September 30, 1994
  13 * VERSION 3.0   :  June 30, 1999
  14 * VERSION 3.0 + update :  October 31, 1999
  15 * VERSION 3.0 + update :  May 31, 2000
  16 * VERSION 3.1   : November 2006
  17 * VERSION 3.1.1 : February 2007
  18 * VERSION 3.2   : November 2008
  19 * VERSION 3.2.1 : April 2009
  20 * VERSION 3.2.2 : June 2010
  21 * VERSION 3.3.0 : November 2010
  22 * VERSION 3.3.1 : April 2011
  23 * VERSION 3.4.0 : November 2011
  24 * VERSION 3.4.1 : April 2012
  25 * VERSION 3.4.2 : September 2012
  26 * VERSION 3.5.0 : November 2013
  27 * VERSION 3.6.0 : November 2015
  28 * VERSION 3.6.1 : June 2016
  29 * VERSION 3.7.0 : December 2016
  30
  31 LAPACK is a library of Fortran subroutines for solving the most commonly
  32 occurring problems in numerical linear algebra.
  33
  34 LAPACK is a freely-available software package. It can be included in commercial
  35 software packages (and has been). We only ask that that proper credit be given
  36 to the authors, for example by citing the LAPACK Users' Guide. The license used
  37 for the software is the modified BSD license, see:
  38 https://github.com/Reference-LAPACK/lapack/blob/master/LICENSE
  39
  40 Like all software, it is copyrighted. It is not trademarked, but we do ask the
  41 following: if you modify the source for these routines we ask that you change
  42 the name of the routine and comment the changes made to the original.
  43
  44 We will gladly answer any questions regarding the software. If a modification
  45 is done, however, it is the responsibility of the person who modified the
  46 routine to provide support.
  47
  48 LAPACK is available from github at:
  49 https://github.com/reference-lapack/lapack
  50
  51 LAPACK releases are also available on netlib at:
  52 http://www.netlib.org/lapack/
  53
  54 The distribution contains (1) the Fortran source for LAPACK, and (2) its
  55 testing programs.  It also contains (3) the Fortran reference implementation of
  56 the Basic Linear Algebra Subprograms (the Level 1, 2, and 3 BLAS) needed by
  57 LAPACK.  However this code is intended for use only if there is no other
  58 implementation of the BLAS already available on your machine; the efficiency of
  59 LAPACK depends very much on the efficiency of the BLAS.  It also contains (4)
  60 CBLAS, a C interface to the BLAS, and (5) LAPACKE, a C interface to LAPACK.
  61
  62 ## Installation
  63
  64  - LAPACK can be installed with `make`. The configuration have to be set in the
  65    `make.inc` file. A `make.inc.example` for a Linux machine running GNU compilers
  66    is given in the main directory. Some specific `make.inc` are also available in
  67    the `INSTALL` directory.
  68  - LAPACK includes also the CMake build. You will need to have CMake installed
  69    on your machine (CMake is available at http://www.cmake.org/). CMake will
  70    allow an easy installation on a Windows Machine.
  71  - Specific information to run LAPACK under Windows is available at
  72    http://icl.cs.utk.edu/lapack-for-windows/lapack/.
  73
  74
  75 ## User Support
  76
  77 LAPACK has been thoroughly tested, on many different types of computers. The
  78 LAPACK project supports the package in the sense that reports of errors or poor
  79 performance will gain immediate attention from the developers. Such reports,
  80 descriptions of interesting applications, and other comments should be sent by
  81 electronic mail to lapack@icl.utk.edu.
  82
  83 For further information on LAPACK please read our FAQ at
  84 http://www.netlib.org/lapack/#_faq.
  85
  86 A list of known problems, bugs, and compiler errors for LAPACK is
  87 maintained on netlib
  88 http://www.netlib.org/lapack/release_notes.html.
  89 Please see as well
  90 https://github.com/Reference-LAPACK/lapack/issues.
  91
  92 A User forum is also available to help you with the LAPACK library at
  93 http://icl.cs.utk.edu/lapack-forum/.
  94 You can also contact directly the LAPACK team at lapack@icl.utk.edu.
  95
  96
  97 ## Testing
  98
  99 LAPACK includes a thorough test suite. We recommend that, after compilation,
 100 you run the test suite.
 101
 102 For complete information on the LAPACK Testing please consult LAPACK Working
 103 Note 41 "Installation Guide for LAPACK".
 104
 105 ## User Guide
 106
 107 To view an HTML version of the Users' Guide please refer to the URL
 108   http://www.netlib.org/lapack/lug/lapack_lug.html.
 109
 110 ## LAPACKE
 111
 112 LAPACK now includes the LAPACKE package.  LAPACKE is a Standard C language API
 113 for LAPACK This was born from a collaboration of the LAPACK and INTEL Math
 114 Kernel Library teams. See:
 115 http://www.netlib.org/lapack/#_standard_c_language_apis_for_lapack.
 116