Reduced matrix sizes in examples.
[dense-linear-algebra-libraries/linalg.git] / readme.txt
2 ========== Run applications with LINALG libraries: ==========
3 1. include following headers files located at /usr/include after MCSDK-HPC installation:
4    - BLAS:   cblas.h
5    - LAPACK: f2c.h, blaswrap.h, clapack.h 
6    - Note: fc2.h has a complex type which is different from the complex type in
7            C99 complex.h. If f2c.h is included, C99 complex.h should not be used. 
8 2. link following LINALG libraries located at /usr/lib after MCSDK-HPC installation:
9    - BLAS:   libblis.a, libcblas_armplusdsp.a
10    - LAPACK: libcblaswr.a, liblapack.a, libf2c.a
11    - Note: cblas calls are not thread safe
12 3. setup environment variables:
13    - BLIS_IC_NT for number of ARM threads: 1 through 4     
14    - TI_CBLAS_OFFLOAD for BLAS offloading (level 1, 2, or 3) configuration:
15            - set to xyz, where x,y,z correspond to level 1, level 2, and level 3 and
16          can take any of 3 values:
17                - 0: no offloading to DSP, ie. always running on ARM
18                    - 1: forced offloading to DSP, ie. always running on DSP
19                    - 2: conditional offloading to DSP based on matrix sizes
20            - example: TI_CBLAS_OFFLOAD=001 means level 1&2 functions will always run 
21                       on ARM, and level 3 functions will always run on DSP. 
22        - default offloading configuration if TI_CBLAS_OFFLOAD is not set: 
23                - 002 (level 1&2 no offloading, level 3 offloading based on sizes)                
24        - Note: in this release, conditional offloading (value 2) is not available 
25                    for level 1 and level 2. If this option is configured for level 1
26                            and level 2, functions will be offloaded to DSP. 
27    
28 ========== Rebuild LINALG libraries: ==========
29 1. rebuild ARM without rebuilding DSP code: make ARMonly
30 2. rebuild both DSP and ARM code: make ARMplusDSP
32 ========== Install LINALG libraries: ==========
33 1. install libraries to /usr/lib: make install
34 2. install libraries to another directory: make install DESTDIR=<directory name>