More INSTALL.md changes
This commit is contained in:
Rob Falgout
parent
4f89af9c84
commit
9f5d51f3c7
92
INSTALL
92
INSTALL
@ -1,92 +0,0 @@
|
||||
#BHEADER**********************************************************************
|
||||
# Copyright (c) 2008, Lawrence Livermore National Security, LLC.
|
||||
# Produced at the Lawrence Livermore National Laboratory.
|
||||
# This file is part of HYPRE. See file COPYRIGHT for details.
|
||||
#
|
||||
# HYPRE is free software; you can redistribute it and/or modify it under the
|
||||
# terms of the GNU Lesser General Public License (as published by the Free
|
||||
# Software Foundation) version 2.1 dated February 1999.
|
||||
#
|
||||
# $Revision$
|
||||
#EHEADER**********************************************************************
|
||||
|
||||
|
||||
=====================================================
|
||||
HYPRE Installation Information for Unix-based systems
|
||||
=====================================================
|
||||
|
||||
The simplest way to build HYPRE is:
|
||||
|
||||
1. From within the 'src' directory, type 'configure' to configure the package
|
||||
for your system.
|
||||
|
||||
While configure runs, it prints messages indicating which features it is
|
||||
checking for. Two output files are created: config.status and config.log.
|
||||
The config.status file can be run to recreate the current configuration, and
|
||||
config.log is useful for debugging configure. Upon successful completion,
|
||||
the file 'config/Makefile.config' is created from its template
|
||||
'Makefile.config.in' and HYPRE is ready to be made.
|
||||
|
||||
2. Type 'make install' to compile and install HYPRE.
|
||||
|
||||
3. You can remove the program binaries and object files from the source code by
|
||||
typing 'make clean'. To remove additional files created by configure, type
|
||||
'make distclean'.
|
||||
|
||||
Optional Features:
|
||||
|
||||
Configure has many options to allow the user to override and refine the defaults
|
||||
of any system. To display the available options, type 'configure --help'.
|
||||
|
||||
The make step in building HYPRE is where the compiling, loading and creation of
|
||||
libraries occurs. Make has several options called targets, which can be listed
|
||||
by running 'make help'.
|
||||
|
||||
When building HYPRE without the install target, the libraries and include files
|
||||
are copied into the directories, 'src/hypre/lib' and 'src/hypre/include'.
|
||||
|
||||
When building with the install target, the libraries and files are copied into
|
||||
the directories specified by the configure option, --prefix=/usr/apps. If none
|
||||
were specified, the default directories are used, hypre/lib and hypre/include.
|
||||
|
||||
|
||||
==========================================
|
||||
HYPRE Installation Information using CMake
|
||||
==========================================
|
||||
|
||||
CMake is another way to build HYPRE that is particularly useful for building the
|
||||
code on Windows machines. CMake provides a uniform interface for setting
|
||||
configuration options on different platforms. It does not actually build the
|
||||
code, but generates input for other "native" build systems such as Make (Unix
|
||||
platforms) or Visual Studio (Windows). Here are the basic steps:
|
||||
|
||||
1. First, ensure that CMake version 2.8.8 or later is installed on the system.
|
||||
|
||||
2. To build the library, run CMake on the top-level HYPRE source directory to
|
||||
generate files appropriate for the native build system. To prevent writing
|
||||
over the Makefiles in HYPRE's configure/make system above, only out-of-source
|
||||
builds are currently allowed with CMake. Directories 'src/cmbuild' and
|
||||
'src/test/cmbuild' are provided in the release for convenience, but
|
||||
alternative build directories may be created by the user:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'cmake ..'.
|
||||
|
||||
- Windows: Set the source and build directories to 'src' and 'src/cmbuild',
|
||||
then click on 'Configure' following by 'Generate'.
|
||||
|
||||
3. To complete the build of the library, compile with the native build system:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'make install'.
|
||||
|
||||
- Windows Visual Studio: Open the 'hypre' VS solution file generated by CMake
|
||||
and build the 'ALL_BUILD' target, then the 'INSTALL' target.
|
||||
|
||||
Optional Features:
|
||||
|
||||
Various configuration options can be set from within CMake. Change these as
|
||||
appropriate, then reconfigure/generate:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'ccmake ..', change options, then
|
||||
type 'c' then 'q'.
|
||||
|
||||
- Windows VS: Change options, then click on 'Configure' then 'Generate'.
|
||||
35
INSTALL.md
35
INSTALL.md
@ -8,46 +8,45 @@
|
||||
- Software Foundation) version 2.1 dated February 1999.
|
||||
- EHEADER-->
|
||||
|
||||
=====================================================
|
||||
|
||||
HYPRE Installation Information for Unix-based systems
|
||||
=====================================================
|
||||
|
||||
The simplest way to build HYPRE is:
|
||||
|
||||
1. From within the 'src' directory, type 'configure' to configure the package
|
||||
1. From within the `src` directory, type `configure` to configure the package
|
||||
for your system.
|
||||
|
||||
While configure runs, it prints messages indicating which features it is
|
||||
checking for. Two output files are created: config.status and config.log.
|
||||
The config.status file can be run to recreate the current configuration, and
|
||||
config.log is useful for debugging configure. Upon successful completion,
|
||||
the file 'config/Makefile.config' is created from its template
|
||||
'Makefile.config.in' and HYPRE is ready to be made.
|
||||
the file `config/Makefile.config` is created from its template
|
||||
`Makefile.config.in` and HYPRE is ready to be made.
|
||||
|
||||
2. Type 'make install' to compile and install HYPRE.
|
||||
2. Type `make install` to compile and install HYPRE.
|
||||
|
||||
3. You can remove the program binaries and object files from the source code by
|
||||
typing 'make clean'. To remove additional files created by configure, type
|
||||
'make distclean'.
|
||||
typing `make clean`. To remove additional files created by configure, type
|
||||
`make distclean`.
|
||||
|
||||
Optional Features:
|
||||
|
||||
Configure has many options to allow the user to override and refine the defaults
|
||||
of any system. To display the available options, type 'configure --help'.
|
||||
of any system. To display the available options, type `configure --help`.
|
||||
|
||||
The make step in building HYPRE is where the compiling, loading and creation of
|
||||
libraries occurs. Make has several options called targets, which can be listed
|
||||
by running 'make help'.
|
||||
by running `make help`.
|
||||
|
||||
When building HYPRE without the install target, the libraries and include files
|
||||
are copied into the directories, 'src/hypre/lib' and 'src/hypre/include'.
|
||||
are copied into the directories, `src/hypre/lib` and `src/hypre/include`.
|
||||
|
||||
When building with the install target, the libraries and files are copied into
|
||||
the directories specified by the configure option, --prefix=/usr/apps. If none
|
||||
were specified, the default directories are used, hypre/lib and hypre/include.
|
||||
|
||||
|
||||
==========================================
|
||||
HYPRE Installation Information using CMake
|
||||
==========================================
|
||||
|
||||
@ -62,18 +61,18 @@ platforms) or Visual Studio (Windows). Here are the basic steps:
|
||||
2. To build the library, run CMake on the top-level HYPRE source directory to
|
||||
generate files appropriate for the native build system. To prevent writing
|
||||
over the Makefiles in HYPRE's configure/make system above, only out-of-source
|
||||
builds are currently allowed with CMake. Directories 'src/cmbuild' and
|
||||
'src/test/cmbuild' are provided in the release for convenience, but
|
||||
builds are currently allowed with CMake. Directories `src/cmbuild` and
|
||||
`src/test/cmbuild` are provided in the release for convenience, but
|
||||
alternative build directories may be created by the user:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'cmake ..'.
|
||||
- Unix: From the `src/cmbuild` directory, type `cmake ..`.
|
||||
|
||||
- Windows: Set the source and build directories to 'src' and 'src/cmbuild',
|
||||
- Windows: Set the source and build directories to `src` and `src/cmbuild`,
|
||||
then click on 'Configure' following by 'Generate'.
|
||||
|
||||
3. To complete the build of the library, compile with the native build system:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'make install'.
|
||||
- Unix: From the `src/cmbuild` directory, type `make install`.
|
||||
|
||||
- Windows Visual Studio: Open the 'hypre' VS solution file generated by CMake
|
||||
and build the 'ALL_BUILD' target, then the 'INSTALL' target.
|
||||
@ -83,7 +82,7 @@ Optional Features:
|
||||
Various configuration options can be set from within CMake. Change these as
|
||||
appropriate, then reconfigure/generate:
|
||||
|
||||
- Unix: From the 'src/cmbuild' directory, type 'ccmake ..', change options, then
|
||||
type 'c' then 'q'.
|
||||
- Unix: From the `src/cmbuild` directory, type `ccmake ..`, change options, then
|
||||
type `c` then `q`.
|
||||
|
||||
- Windows VS: Change options, then click on 'Configure' then 'Generate'.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user