WebSVN - slepc-dev - Blame - Rev 2370

Rev	Author	Line No.	Line
6	dsic.upv.es!jroman	1
		2
		3	SLEPc: Scalable Library for Eigenvalue Problem Computations
		4	===========================================================
		5
2113	jroman	6	Developers:
6	dsic.upv.es!jroman	7	Jose E. Roman
1668	slepc	8	Eloy Romero
237	dsic.upv.es!jroman	9	Andres Tomas
2113	jroman	10
		11	Former collaborators:
		12	Vicente Hernandez
6	dsic.upv.es!jroman	13	Vicent Vidal
		14
		15	GRyCAP - Grupo de Redes y Computacion de Altas Prestaciones
		16	Universidad Politecnica de Valencia, Spain
		17
2113	jroman	18	VERSION: 3.1
6	dsic.upv.es!jroman	19
1395	slepc	20
6	dsic.upv.es!jroman	21	Overview
		22	--------
		23
		24	SLEPc, the Scalable Library for Eigenvalue Problem Computations, is a software
		25	package for the solution of large sparse eigenvalue problems on parallel
		26	computers. It can be used for the solution of problems formulated in either
		27	standard or generalized form, as well as other related problems such as the
		28	singular value decomposition.
		29
		30	The emphasis of the software is on methods and techniques appropriate for
		31	problems in which the associated matrices are sparse, for example, those
		32	arising after the discretization of partial differential equations. Therefore,
		33	most of the methods offered by the library are projection methods or other
2113	jroman	34	methods with similar properties. Some of these methods are Krylov-Schur and
		35	Jacobi-Davidson, to name a few. SLEPc implements these basic methods as well
		36	as more sophisticated algorithms. It also provides built-in support for
6	dsic.upv.es!jroman	37	spectral transformations such as shift-and-invert.
		38
		39	SLEPc is a general library in the sense that it covers standard and genralized
		40	eigenvalue problems, both Hermitian and non-Hermitian, with either real or
		41	complex arithmetic.
		42
		43	SLEPc is built on top of PETSc, the Portable Extensible Toolkit for Scientific
		44	Computation (http://www.mcs.anl.gov/petsc). It can be considered an extension
		45	of PETSc providing all the functionality necessary for the solution of
		46	eigenvalue problems. This means that PETSc must be previously installed in
		47	order to use SLEPc. PETSc users will find SLEPc very easy to use, since it
		48	enforces the same programming paradigm. For those users which are not familiar
		49	with PETSc yet, our recommendation is to fully understand its basic concepts
		50	before proceeding with SLEPc.
		51
		52
		53	Documentation
		54	-------------
		55
		56	The Users Manual is included in the SLEPc distribution file. It can be found
		57	in directory 'docs' and it contains a general description of the capabilities
		58	of the software. The manual does not include detailed reference information
		59	about individual SLEPc routines. This information is provided in the form of
955	dsic.upv.es!jroman	60	man pages in HTML format (see 'docs/manual.htm').
6	dsic.upv.es!jroman	61
1668	slepc	62	The following journal article provides a general description of SLEPc:
6	dsic.upv.es!jroman	63
1668	slepc	64	[1] V. Hernandez, J. E. Roman and V. Vidal (2005), SLEPc: A Scalable and
		65	Flexible Toolkit for the Solution of Eigenvalue Problems, ACM Trans. Math.
		66	Softw. 31(3), 351-362.
		67
		68
6	dsic.upv.es!jroman	69	Installation
		70	------------
		71
		72	The installation procedure of SLEPc is very similar to that of PETSc. Briefly,
1668	slepc	73	the environment variable $SLEPC_DIR must be set, then the script 'configure'
955	dsic.upv.es!jroman	74	is executed and finally the libraries are built with the command 'make'. For
1388	slepc	75	this to work correctly, variable $PETSC_DIR must also be set appropriately.
6	dsic.upv.es!jroman	76
		77	More detailed information about installation can be found in the Users Manual
		78	or in the SLEPc home page, including instructions for configuring SLEPc to use
		79	external libraries such as ARPACK.
		80
		81
		82	More Information
		83	----------------
		84
		85	Additional information can be found in the SLEPc home page at the following
		86	address:
		87
		88	http://www.grycap.upv.es/slepc
		89
		90	Among other things, this site includes information about:
		91
		92	- How to contact the authors for support.
1668	slepc	93	- Software download.
6	dsic.upv.es!jroman	94	- On-line documentation.
		95	- Mailing list for announcement of new releases.
		96
		97	All questions/comments should be directed to slepc-maint@grycap.upv.es.
		98
		99
		100	Acknowledgements
		101	----------------
		102
		103	The development of SLEPc has been partially supported by the following grants:
		104
1215	slepc	105	- Oficina de Ciencia i Tecnologia, Generalitat Valenciana, CTIDB/2002/54.
		106	- Direccio General d'Investigacio i Transferencia de Tecnologia, Generalitat
		107	Valenciana, GV06/091.
2113	jroman	108	- Ministerio de Ciencia e Innovacion, TIN2009-07519.
6	dsic.upv.es!jroman	109
1668	slepc	110
1215	slepc	111	Conditions of Use
6	dsic.upv.es!jroman	112	-----------------
		113
2113	jroman	114	Copyright (c) 2002-2010, Universidad Politecnica de Valencia, Spain
6	dsic.upv.es!jroman	115
1668	slepc	116	SLEPc is free software: you can redistribute it and/or modify it under the
		117	terms of version 3 of the GNU Lesser General Public License as published by
		118	the Free Software Foundation.
6	dsic.upv.es!jroman	119
1668	slepc	120	SLEPc is distributed in the hope that it will be useful, but WITHOUT ANY
		121	WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
		122	FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
		123	more details.
6	dsic.upv.es!jroman	124
1668	slepc	125	You should have received a copy of the GNU Lesser General Public License
		126	along with SLEPc. If not, see <http://www.gnu.org/licenses/>.
6	dsic.upv.es!jroman	127

Subversion Repositories slepc-dev

(root)/trunk/README - Rev 2370