File	Date	Author	Commit
application	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
build	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
cmake	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
doc	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
examples	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
external	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
tests	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
viennacl	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
viennadata	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
viennagrid	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
viennashe	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
CMakeLists.txt	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
LICENSE	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
README	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0
changelog	2012-10-16	Karl Rupp	[e74d8d] Release 1.1.0

Read Me

************************************************
****           ViennaSHE Readme             ****
************************************************
  
Table of Contents
------------------
1. Requirements
2. Installation
3. Project Layout
4. Authors and Contact
A. License


(for detailed informations, have a look into the doc/ folder containing a PDF manual and doxygen-created reference documentation)



1. Requirements
-----------------
ViennaSHE requires only a not too dated C++ compiler (e.g. gcc 4.x.x), the C++ Standard Template Library, 
ViennaData http://viennadata.sourceforge.net, 
ViennaGrid http://viennagrid.sourceforge.net, 
ViennaCL http://viennacl.sourceforge.net and 
Boost http://www.boost.org . 
For building the examples, CMake can be used.


2. Installation
-----------------

The first step is to extract the file:

Unix-based OS:
$> gunzip ViennaSHE-1.1.0.tar.gz
$> tar -xf ViennaSHE-1.1.0.tar
$> cd ViennaSHE-1.1.0

ViennaSHE is a header-only library (although shipped with an application), therefore it is sufficient to copy the subfolder viennashe/ (holding the header files) into your project directory or your system include directory. For instructions on how to set the include paths correctly, please refer to the documentation of your compiler.

For building and running the examples, proceed as follows:

Unix-based clients:
 * change to the build directory:
   $> cd build
 * call cmake
   $> cmake ..
 * Use 'make' to build all examples, tests and the main application:
   $> make
   (alternatively, you can build them individually via 'make example1', 'make example2', etc.
 * Execute them via
   $> ./examples/nin-diode-2d
   $> ./application/vshe
   etc.


3. Project Layout
-----------------

---- ViennaSHE-1.X.X
   |
   |-- build/ - Build folder for the examples
   | 
   |-- doc/ - Documentation (LaTeX and doxygen)
   | 
   |-- examples/ - Tutorial and benchmarking applications
        | 
        |-- data/ - Test meshes for the tutorials
        | 
   | 
   |-- tests/ - Automated test suite
   | 
   |-- viennashe/ - The library source code


4. Authors and Contact
------------------------

Karl Rupp (rupp@iue.tuwien.ac.at)
Markus Bina (bina@iue.tuwien.ac.at)
Peter Lagger

ViennaSHE was developed under the aegis of the 'Institute for Microelectronics' and the 'Institute for Analysis and Scientific Computing' at the 'Vienna University of Technology'.


A. License
------------
ViennaSHE is distributed under the MIT (X11) License. See file LICENSE.