Package slepc4py
[hide private]
[frames] | no frames]

Package slepc4py

SLEPc for Python

This package is an interface to SLEPc_ libraries.

SLEPc_ (the Scalable Library for Eigenvalue Problem Computations) is a software library for the solution of large scale sparse eigenvalue problems on parallel computers. It is an extension of PETSc_ and can be used for either standard or generalized eigenproblems, with real or complex arithmetic. It can also be used for computing a partial SVD of a large, sparse, rectangular matrix.

.. _SLEPc: http://www.grycap.upv.es/slepc .. _PETSc: http://www.mcs.anl.gov/petsc


Version: 3.5.1

Author: Lisandro Dalcin

Submodules [hide private]

Functions [hide private]
 
init(args=None, arch=None)
Initialize SLEPc.
 
get_include()
Return the directory in the package that contains header files.
Variables [hide private]
  __credits__ = 'SLEPc Team <slepc-maint@grycap.upv.es>'
Function Details [hide private]

init(args=None, arch=None)

 

Initialize SLEPc.

:Parameters:
  - `args`: command-line arguments, usually the 'sys.argv' list.
  - `arch`: specific configuration to use.

.. note:: This function should be called only once, typically at
   the very beginning of the bootstrap script of an application.

get_include()

 

Return the directory in the package that contains header files.

Extension modules that need to compile against slepc4py should use this function to locate the appropriate include directory. Using Python distutils (or perhaps NumPy distutils):

 import petscc4py, slepc4py
 Extension('extension_name', ...
           include_dirs=[...,
                         petsc4py.get_include(),
                         slepc4py.get_include(),])