rename to meanas and split fdtd/fdfd

README.md

@@ -1,46 +1,56 @@
-# fdfd_tools
+# meanas
 
-**fdfd_tools** is a python package containing utilities for
-creating and analyzing 2D and 3D finite-difference frequency-domain (FDFD)
-electromagnetic simulations.
+**meanas** is a python package for electromagnetic simulations
+
+This package is intended for building simulation inputs, analyzing
+simulation outputs, and running short simulations on unspecialized hardware.
+It is designed to provide tooling and a baseline for other, high-performance
+purpose- and hardware-specific solvers.
 
 
 **Contents**
-* Library of sparse matrices for representing the electromagnetic wave
- equation in 3D, as well as auxiliary matrices for conversion between fields
-* Waveguide mode solver and waveguide mode operators
-* Stretched-coordinate PML boundaries (SCPML)
-* Functional versions of most operators
-* Anisotropic media (eps_xx, eps_yy, eps_zz, mu_xx, ...)
-* Arbitrary distributions of perfect electric and magnetic conductors (PEC / PMC)
+- Finite difference frequency domain (FDFD)
+    * Library of sparse matrices for representing the electromagnetic wave
+    equation in 3D, as well as auxiliary matrices for conversion between fields
+    * Waveguide mode operators
+    * Waveguide mode eigensolver
+    * Stretched-coordinate PML boundaries (SCPML)
+    * Functional versions of most operators
+    * Anisotropic media (limited to diagonal elements eps_xx, eps_yy, eps_zz, mu_xx, ...)
+    * Arbitrary distributions of perfect electric and magnetic conductors (PEC / PMC)
+- Finite difference time domain (FDTD)
+    * Basic Maxwell time-steps
+    * Poynting vector and energy calculation
+    * Convolutional PMLs
 
 This package does *not* provide a fast matrix solver, though by default
-```fdfd_tools.solvers.generic(...)``` will call
-```scipy.sparse.linalg.qmr(...)``` to perform a solve.
-For 2D problems this should be fine; likewise,  the waveguide mode
+`meanas.fdfd.solvers.generic(...)` will call
+`scipy.sparse.linalg.qmr(...)` to perform a solve.
+For 2D FDFD problems this should be fine; likewise, the waveguide mode
 solver uses scipy's eigenvalue solver, with reasonable results.
 
-For solving large (or 3D) problems, I recommend a GPU-based iterative
-solver, such as [opencl_fdfd](https://mpxd.net/gogs/jan/opencl_fdfd) or
+For solving large (or 3D) FDFD problems, I recommend a GPU-based iterative
+solver, such as [opencl_fdfd](https://mpxd.net/code/jan/opencl_fdfd) or
 those included in [MAGMA](http://icl.cs.utk.edu/magma/index.html)). Your
 solver will need the ability to solve complex symmetric (non-Hermitian)
 linear systems, ideally with double precision.
 
+
 ## Installation
 
 **Requirements:**
-* python 3 (written and tested with 3.5)
+* python 3 (tests require 3.7)
 * numpy
 * scipy
 
 
 Install with pip, via git:
 ```bash
-pip install git+https://mpxd.net/gogs/jan/fdfd_tools.git@release
+pip install git+https://mpxd.net/code/jan/meanas.git@release
 ```
 
 ## Use
 
-See examples/test.py for some simple examples; you may need additional
-packages such as [gridlock](https://mpxd.net/gogs/jan/gridlock)
+See `examples/` for some simple examples; you may need additional
+packages such as [gridlock](https://mpxd.net/code/jan/gridlock)
 to run the examples.