Package slepc4py

[hide private]
[frames] | no frames]

# Package slepc4py

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.

Version: 3.12.0

Author: Lisandro Dalcin

Submodules | [hide private]

- slepc4py.SLEPc: Scalable Library for Eigenvalue Problem Computations.
- slepc4py.lib: Extension modules for different SLEPc configurations.

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@upv.es>``'``
| __package__ = `None`

Function Details | [hide private]

### init(args=None, arch=None)

Initialize SLEPc.

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

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

### 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(),])