← Back to branch summary

~ubuntu-branches/ubuntu/vivid/atlas/vivid

« back to all changes in this revision

Viewing changes to doc/DirStruct.txt

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2002-04-13 10:07:52 UTC
  • Revision ID: james.westby@ubuntu.com-20020413100752-va9zm0rd4gpurdkq
Tags: upstream-3.2.1ln
Import upstream version 3.2.1ln

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/DirStruct.txt
 
1
***************************** DIRECTORY STRUCTURE ******************************
 
2
The directory structure of ATLAS can be summarized by the following graphic:
 
3
      ---------------------------------------------------------
 
4
      |       |        |                |          |          |
 
5
     bin  interfaces  tune             lib      include      src
 
6
              |        |                                      |
 
7
              |   -----------------------       ----------------------------
 
8
              |   |                     |       |       |     |            |
 
9
              |   |                    blas   auxil  testing  |          lapack
 
10
              |   |                     |                     |
 
11
              |   |      ------------------------------     blas
 
12
              |sysinfo   |           |        |       |       |
 
13
              |          gemm       gemv     ger     level3   |
 
14
              |                                               |
 
15
        ----------------------           -----------------------------------
 
16
        |                    |           |       |       |      |     |    |
 
17
      blas                 lapack      level1  level2  level3  gemm  ger  gemv
 
18
        |                    |
 
19
    ---------            ---------
 
20
    |       |            |       |
 
21
   src    testing       src    testing
 
22
 
 
23
At each leaf, there are sub-directories corresponding to the installed
 
24
architectures which hold the compiled object files, libraries, or executables.
 
25
 
 
26
A summary of each of the main directories is given below:
 
27
 
 
28
** interfaces : The official C and Fortran77 interfaces that ATLAS supplies.
 
29
                Users needing to examine the API can go to the appropriate
 
30
                src subdirectory.  If it exists, the official API tester is
 
31
                available in the appropriate testing subdirectory.
 
32
** bin        : ATLAS's user-runnable testers & timers are built here
 
33
** lib        : Libraries are compiled by default into this directory
 
34
** tune       : The code generators and timing programs that allow ATLAS to
 
35
                tune itself to specific architectures are here
 
36
** include    : All of atlas's include files.  Architecture-dependent include
 
37
                files appear in the appropriate <arch> subdirectory.
 
38
** src        : Stores the routines supported by atlas; once optimal cases have
 
39
                been found, this is also where the generated code is stored.
 
40
 
 
41
In addition to those shown above, the user should be aware of the directories:
 
42
   ATLAS/doc                    : ATLAS documentation
 
43
   ATLAS/bin/<arch>/INSTALL_LOG : Log of the config & install steps for each
 
44
                                  architecture