From 2b7b6ba37f8517a5690179deed6a5625963dcaea Mon Sep 17 00:00:00 2001
From: Guillaume Demesy <guillaume.demesy@fresnel.fr>
Date: Wed, 25 Sep 2019 23:44:32 +0200
Subject: [PATCH] Update README.md
---
ElectromagneticScattering/README.md | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/ElectromagneticScattering/README.md b/ElectromagneticScattering/README.md
index bd92b17..1ecbb5f 100644
--- a/ElectromagneticScattering/README.md
+++ b/ElectromagneticScattering/README.md
@@ -2,11 +2,19 @@ A Onelab model for 3D scattering problems in nanophotonics.
## Synopsis
-This project contains a [Onelab](http://onelab.info/wiki/ONELAB) model for solving various 3D electromagnetic problems on an isolated arbitrary object :
-* T-matrix computation: See https://arxiv.org/abs/1802.00596 for details
+This project contains a [Onelab](http://onelab.info/wiki/ONELAB) model for solving various 3D electromagnetic problems on an isolated arbitrary object:
+* T-matrix computation [1]
* Quasi-normal modes
* Plane wave response
-* Green's function
+* Green's function (e.g. to compute the Local Density Of States)
+
+It contains various usefull features in electromag:
+* Vector partial waves (AKA vector spherical harmonics)
+* Total field formuation with a point source illumination ("an oriented delta")
+* Linear eigenvalue problems
+* Scattered field formulation
+* Spherical PMLs
+
## Installation
@@ -18,18 +26,23 @@ This model requires the following programs:
## Running the model
Open `scattering.pro` with Gmsh.
+The default parameters are set to compute the T-matrix of a sphere. It retrieves the results from [1].
## Authors
Guillaume Demésy and Brian Stout
-## Installation Note
+## References
+[1] https://arxiv.org/abs/1802.00596 for details
+
+## Installation notes
To enable python support (Python[] function) in GetDP, follow [these instructions](https://gitlab.onelab.info/getdp/getdp/wikis/GetDP-compilation) (complex arithmetic) and add to the final cmake line:
`-DENABLE_PYTHON=ON -DPYTHON_LIBRARY=/path/to/pythonlib -DPYTHON_INCLUDE_DIR=/path/to/pythoninclude`
* On Debian/Ubuntu systems, for python3.6 installed with apt-get,
* `/path/to/pythonlib` is `/usr/lib/x86_64-linux-gnu/libpython3.6m.so`
* `/path/to/python/include` is `/usr/include/python3.6m`
-* For python versions installed through anaconda in some an environement (e.g. py36 below), a common location is:
+* For python versions installed through anaconda in some environment (e.g. env py36 below), a common location is:
* `/somepath/anaconda3/envs/py36/lib/libpython3.6m.so`
* `/somepath/anaconda3/envs/py36/include/python3.6m`
+
--
GitLab