|
2 months ago | |
---|---|---|
examples | 1 year ago | |
meanas | 2 months ago | |
pdoc_templates | 11 months ago | |
.flake8 | 3 months ago | |
.gitignore | 7 months ago | |
LICENSE.md | 4 years ago | |
MANIFEST.in | 1 year ago | |
README.md | 11 months ago | |
make_docs.sh | 11 months ago | |
setup.py | 2 months ago |
meanas is a python package for electromagnetic simulations
** UNSTABLE / WORK IN PROGRESS **
Formerly known as fdfd_tools.
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
This package does not provide a fast matrix solver, though by default
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) FDFD problems, I recommend a GPU-based iterative solver, such as opencl_fdfd or those included in MAGMA. Your solver will need the ability to solve complex symmetric (non-Hermitian) linear systems, ideally with double precision.
Requirements:
Install from PyPI with pip:
pip3 install 'meanas[test,examples]'
Install python3.7, virtualenv, and git:
# This is for Debian/Ubuntu/other-apt-based systems; you may need an alternative command
sudo apt install python3.7 virtualenv build-essential python3.7-dev git
If python 3.7 is not your default python3 version, create a virtualenv:
# Check python3 version:
python3 --version
# output on my system: Python 3.7.5rc1
# If this indicates a version >= 3.7, you can skip all
# the steps involving virtualenv or referencing the venv/ directory
# Create a virtual environment using python3.7 and place it in the directory `venv/`
virtualenv -p python3.7 venv
In-place development install:
# Download using git
#git clone https://mpxd.net/code/jan/meanas.git
# If you are using a virtualenv, activate it
source venv/bin/activate
# Install in-place (-e, editable) from ./meanas, including testing and example dependencies ([test, examples])
pip3 install --user -e './meanas[test,examples]'
# Run tests
cd meanas
python3 -m pytest -rsxX | tee test_results.txt
See examples/
for some simple examples; you may need additional
packages such as gridlock
to run the examples.