Instructions to install and run Favago TPI 4.5

  Copyright (C) 2009-2015 Peter Rakyta, Ph.D.

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

System requirements

Favago TPI v4.5 is compatible with MATLAB R2011b (7.13.0.564) or higher. Unfortunatelly, Favago TPI v4.5 is not compatible with Octave 3.8.2.

Download

Download the Favago TPI v4.5 from the list of provided stable packages. Altrenatively the Favago TPI v4.5 package can be downloaded by the shell command

wget http://itl88.elte.hu/favago/Download/Favago_TPI_v4.5.tar.gz

Unpack

Unpack the downloaded package into the directory "/path/to/favago" the commands

mkdir /path/to/favago

and

tar -xzf Favago_TPI_v4.5.tar.gz -C /path/to/favago

to create the output directory and unpack the package respectively.

Install

Add the following lines to the "startup.m" file located at the search path of MATLAB:

addpath('/path/to/favago');
addpath('/path/to/favago/utils');

Alternatively add the directories "/path/to/favago" and "/path/to/favago/utils" to the search path of MATLAB. To this end open the file pathdef.m and add the following lines:

'/path/to/favago:', ...
'/path/to/favago/utils:', ...

Now the Favago TPI v4.5 package is successfully installed.

The structure of Favago TPI v4.5

Favago TPI v4.5 is organized into interfaces. Each interface has a separated workspace consisting of related variables (e.g., the surface Greens function, the propagating and evanescent modes, the group velocities are grouped into one workspace if they belong to the same lead.). The interfaces also provide several methods to run specific calculations on the variables of the workspace. The interfaces form two levels of abstraction. The members of the 1st level (/root) are responsible for specific elementary tasks, while the interfaces of the 2nd level (/root/utils) combine the functionalities of the 1st level interfaces, and can be used as the building blocks of the studied structure.

Run the Favago TPI v4.5

Favago TPI v4.5 can be run by small MATLAB scripts that initialize the interfaces and combine their functionalities. Physical and other running parameters (intended not to be changed during the calculations) are read in from an xml structure. Within the Favago TPI v4.5 package (see the directory "/path/to/favago/Examples") there are provided several executable examples demostrating the usage of the package. These examples are also invoked by the built-in automatic test procedure (automatic_test.m) of Favago TPI v4.5.

Introduction

Interfaces

Data structures

Examples

Instructions to install and run Favago TPI 4.5