Changeset 6212


Ignore:
Timestamp:
12/14/08 18:52:58 (5 years ago)
Author:
wehart
Message:

Update of top-level documentation

Location:
acro/trunk
Files:
1 deleted
1 copied

Legend:

Unmodified
Added
Removed
  • acro/trunk/README.txt

    r5119 r6212  
    1 ------------------------------------------------------------------------------ 
    2 acro VOTD 
     1Acro 2.0 
     2======== 
    33 
    44Acro integrates a rich variety of optimization libraries and solvers 
     
    1515are integrated into Acro:  http://software.sandia.gov/Acro 
    1616 
    17 ------------------------------------------------------------------------------ 
    18 Acro Lead Developer. 
     17INSTALLATION 
     18============ 
    1919 
    20 William E. Hart 
    21 Sandia National Laboratories 
    22 wehart@sandia.gov  
     20See the doc/INSTALL.txt file. 
    2321 
    24 ------------------------------------------------------------------------------ 
    25 License. 
    2622 
    27 Acro is distributed under the GNU Lesser General Public License. 
    28 However, packages integrated into Acro may used different licesnse. 
    29 See the Acro home page:  http://software.sandia.gov/Acro 
     23LICENSE 
     24======= 
    3025 
    31 ------------------------------------------------------------------------------ 
    32 Installation. 
     26See the doc/LICENSE.txt file. 
    3327 
    34 Details for the Acro installation process is described in 
    35 acro/doc/INSTALL.  The command 
    3628 
    37   cd acro 
    38   ./setup configure build 
     29GETTING STARTED 
     30=============== 
    3931 
    40 will work for a simple build that does not rely on external software packages. 
     32Directories 
    4133 
    42 ------------------------------------------------------------------------------ 
    43 Dependencies. 
     34   admin        - Administrative scripts 
     35   bin          - Scripts and executables 
     36   bootstrap    - Config/makefile fragments shared between Acro projects 
     37   config       - A configuration directory for building with autoconf 
     38   doc          - Documentation and makefiles for applying doxygen 
     39   lib          - Installation directory for Acro libraries 
     40   mvs          - MSVS project files 
     41   packages     - The main Acro source 
     42   test         - A directory for configuration and build logfiles. 
     43   tpl          - Third-party libraries bundled with Acro. 
     44   useraps      - Top-level examples of Acro functionality 
    4445 
    45 Acro integrates third-party libraries that are used to support 
    46 optimization and other analyses (e.g. open-source linear programming 
    47 solvers).  Acro is not strictly dependent on any other external software 
    48 packages.  The parallel solvers are dependent on MPI (using the mpich 
    49 library). 
    5046 
    51 ------------------------------------------------------------------------------ 
    52 Platforms. 
     47Documentation and Bug Tracking 
    5348 
    54 This package is quite generic and thus it should compile on a wide range 
    55 of platforms.  Acro is actively supported with nightly build verifications 
    56 on a variety of platforms.  See 
     49    The Acro Trac wiki supports documentation, issue tracking, 
     50    and browsing of the Acro subversion repository: 
    5751 
    58   http://software.sandia.gov/Acro 
     52        https://software.sandia.gov/trac/acro 
    5953 
    60 for links to the latest nightly build test report. 
     54Authors 
    6155 
    62 ------------------------------------------------------------------------------ 
    63 Further Information and Help. 
     56   See the https://software.sandia.gov/trac/acro Trac pages 
    6457 
    65 Send email to acro-help@software.sandia.gov to address specific issues 
    66 in the use of Acro.  Online documentation is available at 
     58Project Managers 
    6759 
    68   http://software.sandia.gov/Acro 
     60   William E. Hart, wehart@sandia.gov 
    6961 
    70 The 'Documentation' link provides information on Acro as well as several 
    71 Acro projects. 
     62Mailing Lists 
    7263 
    73 ------------------------------------------------------------------------------ 
    74 WARNING. 
     64   acro-developers@software.sandia.gov 
     65   acro-users@software.sandia.gov 
    7566 
    76 Many packages in Acro are "research" codes, and thus Acro is 
    77 the subject of continuing active development.  Bug reports, suggestions 
    78 for improvement, and required changes for other machines/compilers 
    79 are welcome.  Direct all messages to acro-help@software.sandia.gov. 
     67 
     68THIRD PARTY SOFTARE 
     69=================== 
     70 
     71Acro relies on a variety of third-party software libraries that are bundled with the software.  Additionall, Acro can integrate the following external libraries: 
     72 
     73 * mpich - MPI communication 
     74 * cplex - Linear programming 
     75 
Note: See TracChangeset for help on using the changeset viewer.