README.md

   1 # OpenBLAS
   2
   3 ## Introduction
   4 OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version. OpenBLAS is an open source project supported by Lab of Parallel Software and Computational Science, ISCAS <http://www.rdcps.ac.cn>.
   5
   6 Please read the documents on OpenBLAS wiki pages <http://github.com/xianyi/OpenBLAS/wiki>.
   7
   8 ## Intallation
   9 Download from project homepage. http://xianyi.github.com/OpenBLAS/
  10
  11 Or, check out codes from git://github.com/xianyi/OpenBLAS.git
  12 ### Normal compile
  13   * type "make" to detect the CPU automatically.
  14   or
  15   * type "make TARGET=xxx" to set target CPU, e.g. "make TARGET=NEHALEM". The full target list is in file TargetList.txt.
  16
  17 ### Cross compile
  18 Please set CC and FC with the cross toolchains. Then, set HOSTCC with your host C compiler. At last, set TARGET explicitly.
  19
  20 Examples:
  21
  22 On X86 box, compile this library for loongson3a CPU.
  23
  24     make BINARY=64 CC=mips64el-unknown-linux-gnu-gcc FC=mips64el-unknown-linux-gnu-gfortran HOSTCC=gcc TARGET=LOONGSON3A
  25
  26 ### Debug version
  27
  28     make DEBUG=1
  29
  30 ### Intall to the directory (Optional)
  31
  32 Example:
  33
  34     make install PREFIX=your_installation_directory
  35
  36 The default directory is /opt/OpenBLAS
  37
  38 ## Support CPU & OS
  39 Please read GotoBLAS_01Readme.txt
  40
  41 ### Additional support CPU:
  42
  43 #### x86/x86-64:
  44 - **Intel Xeon 56xx (Westmere)**: Used GotoBLAS2 Nehalem codes.
  45 - **Intel Sandy Bridge**: Optimized Level-3 BLAS with AVX on x86-64.
  46 - **AMD Bobcat**: Used GotoBLAS2 Barcelona codes.
  47
  48 #### MIPS64:
  49 - **ICT Loongson 3A**: Optimized Level-3 BLAS and the part of Level-1,2.
  50 - **ICT Loongson 3B**: Experimental
  51
  52 ### Support OS:
  53 - **GNU/Linux**
  54 - **MingWin/Windows**: Please read <https://github.com/xianyi/OpenBLAS/wiki/How-to-use-OpenBLAS-in-Microsoft-Visual-Studio>.
  55 - **Darwin/Mac OS X**: Experimental. Although GotoBLAS2 supports Darwin, we are the beginner on Mac OS X.
  56 - **FreeBSD**: Supportted by community. We didn't test the library on this OS.
  57
  58 ## Usages
  59 Link with libopenblas.a or -lopenblas for shared library.
  60
  61 ### Set the number of threads with environment variables.
  62
  63 Examples:
  64
  65     export OPENBLAS_NUM_THREADS=4
  66
  67  or
  68
  69     export GOTO_NUM_THREADS=4
  70
  71  or
  72
  73     export OMP_NUM_THREADS=4
  74
  75 The priorities are OPENBLAS_NUM_THREADS > GOTO_NUM_THREADS > OMP_NUM_THREADS.
  76
  77 If you compile this lib with USE_OPENMP=1, you should set OMP_NUM_THREADS environment variable. OpenBLAS ignores OPENBLAS_NUM_THREADS and GOTO_NUM_THREADS with USE_OPENMP=1.
  78
  79 ### Set the number of threads with calling functions.
  80
  81 Examples:
  82
  83     void goto_set_num_threads(int num_threads);
  84
  85     void openblas_set_num_threads(int num_threads);
  86
  87 If you compile this lib with USE_OPENMP=1, you should use the above functions, too.
  88
  89 ## Report Bugs
  90 Please add a issue in https://github.com/xianyi/OpenBLAS/issues
  91
  92 ## Contact
  93 OpenBLAS users mailing list: http://list.rdcps.ac.cn/mailman/listinfo/openblas
  94
  95 ## ChangeLog
  96 Please see Changelog.txt to obtain the differences between GotoBLAS2 1.13 BSD version.
  97
  98 ## Troubleshooting
  99 * Please use gcc version 4.6 and above to compile Sandy Bridge AVX kernels on Linux/MingW/BSD.
 100 * Please use Clang version 3.1 and above to compile the library on Sandy Bridge microarchitecture. The Clang 3.0 will generate the wrong AVX binary code.
 101 * The number of CPUs/Cores should less than or equal to 256.
 102 * On Loongson 3A. make test would be failed because of pthread_create error. The error code is EAGAIN. However, it will be OK when you run the same testcase on shell.
 103
 104 ## Specification of Git Branches
 105 We used the git branching model in this article (http://nvie.com/posts/a-successful-git-branching-model/).
 106 Now, there are 4 branches in github.com.
 107   * The master branch. This a main branch to reflect a production-ready state.
 108   * The develop branch. This a main branch to reflect a state with the latest delivered development changes for the next release.
 109   * The loongson3a branch. This is a feature branch. We develop Loongson3A codes on this branch. We will merge this feature to develop branch in future.
 110   * The gh-pages branch. This is for web pages