Docs:  Installation

Example Usages:

  • Other examples may be found in config/*.py
  • Using the bash shell, assuming BLAS, LAPACK, MPICH are not currently installed ./config/configure.py will download & install BLAS, LAPACK, MPICH if they are not already installed on the system) :
            export PETSC_DIR=/home/petsc/petsc-2.3.0
            cd $PETSC_DIR
            ./config/configure.py --download-f-blas-lapack=1 --download-mpich=1
            make
            make test
  • Same as above - but build Complex version of PETSc:
            export PETSC_DIR=/home/petsc/petsc-2.3.0
            cd $PETSC_DIR
            ./config/configure.py --download-f-blas-lapack=1 --download-mpich=1 --with-scalar-type=complex
            make
            make test
  • Using the bash shell, assuming BLAS, LAPACK, MPICH software are installed at the specified locations:
            export PETSC_DIR=/home/petsc/petsc-2.3.0
            cd $PETSC_DIR
            ./config/configure.py --with-blas-lapack-dir=/usr/local/lib --with-mpi-dir=/usr/local/mpich
            make
            make test
  • Using tcsh shell, install PETSc with default BLAS and LAPACK and no MPI:
            setenv PETSC_DIR /home/petsc/petsc-2.3.0
            cd $PETSC_DIR
            ./config/configure.py --with-mpi=0
            make
            make test
  • Install PETSc with default BLAS, LAPACK and MPI using the GNU compilers, build the optimized version of the libraries:
            ./config/configure.py --with-vendor-compilers=0
            make
            make test
  • Using csh shell, install PETSc on Linux with two different sets of compilers:
            setenv PETSC_ARCH linux-gnu
            ./config/configure.py --with-vendor-compilers=0 --with-mpi-dir=/usr/local/mpich-gnu
            make
            make test
            setenv PETSC_ARCH linux-gnu-intel
            ./config/configure.py --with-vendor-compilers=intel --with-gnu-compilers=0 --with-blas-lapack-dir=/usr/local/mkl --with-mpi-dir=/usr/local/mpich-intel
            make
            make test

Several variables control the configuration and build process of PETSc. They can either be given as arguments to make or be set as environment variables.

PETSC_DIR: - this environment/make variable should point to the location of the PETSc installation that is used. You can add export PETSC_DIR=value in your .profile or .sh file or setenv PETSC_DIR value in your .cshrc or .tcshrc file. Multiple PETSc versions can coexist on the same file-system. By changing PETSC_DIR one can switch between the versions

PETSC_ARCH: this environment/make variable is used to specify the configuration that should currently be used. It corresponds to the configuration files in bmake/${PETSC_ARCH}. Multiple variants of PETSc libraries can be installed - each variant corresponding to a different PETSC_ARCH. One can switch between using these variants - by changing the value of PETSC_ARCH. If PETSC_ARCH is not set, the configuration from the last time you ran ./config/configure.py will be used.

Return to Installation Instructions     


Cygwin  provides UNIX tools on Microsoft Windows. When installing Cygwin make sure you install the following additional packages

  • make
  • patch
  • python
  • rebase
Run /bin/rebaseall after install and use bash as the working shell.

Cygwin also has GNU compilers ( gcc, g++, g77) which can be used  if Microsoft, Intel, or Borland Group compilers are not available

Note: To insure success of rebaseall - make sure there are no other cygwin processes (except bash) are running like ssh or sshd etc.

 Cygwin  http://www.cygwin.com

Return to Installation Instructions    


BLAS/LAPACK: these packages provide some basic numeric kernels used by PETSc.

  • If ./config/configure.py cannot locate BLAS and LAPACK you can use the options --with-blas-lapack-dir=directory or --with-blas-lib=library and --with-lapack-lib=library or --with-blas-lapack-lib=library to indicate the location of the libraries.
    • on Microsoft Windows and Linux, one can use Intel MKL
    • On AIX (IBM) ESSL, on OSF (Compaq/alpha) DXML, on Solaris Sunperf, on SGI libcomplib.sgimath.
    • On some Linux boxes, blas/lapack is installed [/usr/lib/liblapack.a /usr/lib/libblas.a ]
    • Alternatively download the source distribution fblaslapack or cblaslapack from PETSc downloadpage
  • Use the ./config/configure.py options --download-f-blas-lapack=yes, --download-f-blas-lapack=ifneeded, then PETSc will download and install a BLAS and LAPACK for you.
  • Use --download-c-blas-lapack (as opposed to --download-f-blas-lapack) only if there is no fortran compiler.
 Intel MKL  http://www.intel.com/software/products/mkl
 fblaslapack  ftp://ftp.mcs.anl.gov/pub/petsc/fblaslapack.tar.gz
 cblaslapack  ftp://ftp.mcs.anl.gov/pub/petsc/f2cblaslapack.tar.gz

Return to Installation Instructions    


MPI: This software provides the parallel functionality for PETSc.

  • If ./config/configure.py cannot locate MPI you can indicate its location with --with-mpi-dir=directory or --with-mpi-include=directory --with-mpi-lib=libraryname --with-mpirun=pathofmpirun
    • On parallel machines, Vendor provided MPI might already be installed.  IBM, SGI, Cray etc provide their own. 
    • If vendor provided MPI is not available, it can be installed from sources. We recommend MPICH
  • Use the ./config/configure.py option --download-mpich=yes then PETSc will download and install MPICH for you.
 MPI     http://www.mpi-forum.org
 MPICH  http://www.mcs.anl.gov/mpi/mpich
 LAM  http://www.lam-mpi.org
 MPICH-NT (Microsoft Windows)  http://www-unix.mcs.anl.gov/~ashton/mpich.nt
 MPI/Pro (Microsoft Windows)  http://www.mpi-softtech.com/products/mpi_pro
 HPVM (Microsoft Windows)  http://www-csag.ucsd.edu/projects/hpvm.html
 WMPI (Microsoft Windows)  http://www.criticalsoftware.com/hpc

Return to Installation Instructions    


I don't want to use MPI: You can build (sequential) PETSc without an MPI.

Run ./config/configure.py --with-mpi=0 ....

Return to Installation Instructions    


Additional Microsoft Windows Notes:

Project Files: We provide default project files that work with Microsoft Visual Studio. They are located at ${PETSC_DIR}/projects. Be sure to build the libraries that correspond to the project configuration you are using.

Debugger:  Running PETSc probrams with -start_in_debugger is not supported on this platform, so debuggers will need to be initiated manually. Make sure your environment is properly configured to use the appropriate debugger for your compiler. The debuggers can be initiated using Microsoft Visual Studio 6: msdev ex1.exe, Microsoft Visual Studio .NET: devenv ex1.exe, Intel Enhanced Debugger: edb ex1.exe, or GNU Debugger gdb ex1.exe.

PETSc Win32 front end - win32fe:  This tool is used as a wrapper to Microsoft/ Borland/ Intel compilers and associated tools - to enable building PETSc libraries using make and other UNIX tools. For additional info, run ${PETSC_DIR}/bin/win32/win32fe without any options.

Return to Installation Instructions       


Installing with TAU Instrumentation package:

TAU package and the prerequisite PDT packages need to be installed separately. PETSc provides a wrapper compiler for TAU. This needs to be invoked with the correct information for the installed TAU and PDT packages. For eg:

 ./config/configure.py --with-mpi-dir=/home/petsc/soft/linux-rh73/mpich-1.2.4 --with-fc=0 --with-cxx=0 -PETSC_ARCH=linux-tau -with-cpp=cpp --with-cc="`pwd`/bin/taucc.py -cc=gcc -pdt_parse=/homes/petsc/soft/linux-rh73/pdtoolkit-2.2b1/linux/bin/cxxparse -tau_instr=/homes/petsc/soft/linux-rh73/tau-2.11.18/i386_linux/bin/tau_instrumentor -tau_include_dir=/homes/petsc/soft/linux-rh73/tau-2.11.18/include -tau_lib_dir=/homes/petsc/soft/linux-rh73/tau-2.11.18/i386_linux/lib"

Return to Installation Instructions