File	Date	Author	Commit
code	2013-10-30	ides	[e46672] Cleanups and rewrites
doc	2013-01-01	Ides	[d18a3f] Enhanced guide. Took out MPI from RCS_MLFMA.py.
geo	2011-04-13	ides	[770b38] Renamed yagi_antenna into log_antenna.
installScripts	2013-10-30	ides	[69e892] Updated Ubuntu install.
unused_code	2011-10-28	ides	[fd4e6f] Suppressed target_mesh in distribute_Z_cubes.cpp
.gitignore	2013-10-28	ides	[89bc6c] Preliminary support for C++ cubes computation
COPYING	2009-05-16	ides	[c9bc5c] the initial commit
MLFMA_parameters.py	2012-02-04	ides	[1a0cb3] Increased Znear/SAI_precond default block size
README	2012-01-09	ides	[2669ce] Corrected a bug in FMM_precond.py
config_mpi.sh	2009-05-16	ides	[c9bc5c] the initial commit
install.sh	2013-10-30	ides	[69e892] Updated Ubuntu install.
makefile	2013-10-28	ides	[89bc6c] Preliminary support for C++ cubes computation
makefile.inc	2013-05-09	ides	[a1a0b8] Updated GMSH
my_hostfile	2009-05-16	ides	[c9bc5c] the initial commit
run.sh	2013-10-21	ides	[2c8dbe] Finishing re-factoring of setup code
simulation_parameters.py	2013-01-04	ides	[a937fd] Reverted to original parameters

Read Me

SHORT - parallel unified multipole algorithm for Electromagnetics (Puma-EM). 
Aim is providing surface Method of Moments for Electromagnetics, enhanced 
by using the Multilevel Fast Multipole Method. Code is parallelized and runs on 
Desktops and clusters.


1. Introduction
---------------

This is Puma-EM, a Parallel Unified Multipole Algorithm for Electromagnetics.

The aim of Puma-EM is to solve surface integral equations that arise in 
Computational Electromagnetics, by using boundary elements methods, namely 
the Method of Moments. The method is enhanced by the use of the Multilevel 
Fast Multipole Method, which expedites the matrix-vector multiplication 
required by the iterative algorithm.

The term "Unified" refers to the fact that the Multipole Engine could be 
used for acoustics or mechanics. "Unified" should therefore be seen as a 
goal to reach. Hopefully the Open-Sourcing of the code is a step towards 
that goal.

Puma-EM is distributed under the terms of the GNU General Public License v3. 
See COPYING for more information.

For any questions/bugs/requirements, mail <vandenbosch.idesbald@gmail.com>.


2. Capabilities
---------------

This code is currently capable of computing the bistatic Radar Cross Section (RCS),
monostatic RCS and monostatic (Sythetic Aperture Radar) SAR of PEC targets. 
These targets can include junctions (i.e. plates that intersect volumes for example),
therefore the code can solve complex geometries.

Puma-EM has already solved problems containing more than 40 million of variables on
a "modest" cluster (2 HP proliant ML350 machines, quad core and 16 GB RAM each), but 
it is able to solve around 1-2 million on a Desktop/laptop having 2 GBytes of RAM.

Please note that Puma-EM has been developed and used only on Linux machines. 
Windows (R) is not supported (yet). For running Puma-EM on Windows machines,
you should consider installing a virtual linux machine through VMware or any
other virtualization solution.

Puma-EM should work on *NIX/*BSD systems, including MacOS (R) 10.x, although
it has not been tested yet.


3. Install Puma-EM
------------------

First, extract the *.tar.gz file that you downloaded in your home directory.

Second, cd into Puma-EM, then type:

  $ ./install.sh

Follow the instructions for the installation.

This process will issue a lot of output at the terminal, and the code will run on
a small example in order to compile the interfaces between Python and C++.

For more details, or if you have to install Puma-EM locally, see the guide.pdf.


4. Ready to Go
--------------

You are now ready to rock'n'roll!! 

Choose a master node, open a terminal, and simply type:

  $ ./run.sh

See the doc/EXAMPLES file for other examples, then play around with the
simulation_parameters.py file.


5. Code documentation
---------------------

If you want to generate the documentation of the code itself, type 
(doxygen and LaTeX required):

  $ make documentation