Installation

Required dependencies

Python (>= 3.6)
numpy (>= 1.16,<2.0.0)
scipy (>= 1.2.1)
matplotlib (>= 3.0.3)

Optional dependencies

autograd (>= 1.2): For computing gradients
gdspy (>= 1.5): For GDS structure export
scikit-image (>= 0.15): For GDS structure export via rasterization
rich (>= 12.5): For displaying more readable verbose output

Instructions

To install the latest version of Legume from PyPi:

pip install legume-gme

Alternatively, you can git clone Legume from the Fan group GitHub, manually install all of the required dependencies, and add the path to the Legume in your python path environment variable:

git clone https://github.com/fancompute/legume.git
export PYTHONPATH=$PYTHONPATH:/path/to/the/location/of/legume