Installation

Required dependencies

• Python (>= 3.7)

• numpy (>= 1.16.2)

• 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 and install it locally with pip:

git clone https://github.com/fancompute/legume.git
cd legume
pip install .

To install the optional autograd dependency as well:

pip install '.[autodiff]'