Welcome to EMUstack!

EMUstack is an open-source simulation package for calculating light propagation through multi-layered stacks of dispersive, lossy, nanostructured, optical media. It implements a generalised scattering matrix method, which extends the physical intuition of thin film optics to complex structures.


ORIGIN
------

EMUstack is the product of many years research, and is designed primarily as a research tool.
The underpinnings of EMUstack were majoritively developed within CUDOS (the ARC Centre of Excellence for Ultra-high bandwidth Devices for Optical Systems), at its University of Technology Sydney (UTS) and University of Sydney (USyd) nodes.

The scattering matrix method formalism was developed by Lindsay Botten, Ara Asatryan, and Kokou Dossou at UTS. The FEM routine was developed by Kokou Dossou while at the Université du Québec en Outaouais, Université Laval and UTS.

EMUstack was written by Björn Sturmberg during his Ph.D. at USyd, which was supported by the Australian Renewable Energy Agency. THE FEM routine was written by Kokou Dossou, and Felix Lawrence created the smooth f2py interface of Fortran and Python while at UTS.


LICENSE
-------

EMUstack 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 in the EMUstack_docs/ directory. If not, see http://www.gnu.org/copyleft/gpl.html


OFFICIALLY SUPPORTED PLATFORMS
------------------------------

EMUstack has been developed for use on Linux and Unix-like operating systems. It may be easily ported to other operating systems, but there are no current plans for doing so. If you are willing and able to do so, please get in contact!


TESTING
-------

EMUstack comes with a range of tests to ensure it is running correctly. These are found in the EMUstack_tests directories.


HELP!
-----

The growing human-readable documentation for EMUstack lives in EMUstack_docs/

Limited community support is available on the GitHub site: <https://github.com/EMUstack/EMUstack_stable>, and via the EMUstack mailing list <https://groups.google.com/forum/#!forum/emustack>. Feel free to ask questions.


CONTRIBUTING
------------

If you make an improvement to EMUstack, please share it with others by contributing back to the project, via the GitHub site.