Installation

SiPANN is distributed on PyPI and can be installed with pip:

pip install SiPANN

Developmental Build

If you want a developmental build, it can be had by executing

git clone https://github.com/contagon/SiPANN.git
pip install -e SiPANN/

This development version allows you to make changes to this code directly (or pull changes from GitHub) without having to reinstall SiPANN each time.

You should then be able to run the examples and tutorials in the examples folder, and call SiPANN from any other python file.

Note

If installing on Windows, one of SiPANN’s dependencies, gdspy, requires a C compiler for installation. This can be bypassed by first installing the gdspy wheel. This is done by downloading the wheel from gdspy, navigating to the location of the wheel, and executing

pip install gds*.whl

After this simply install SiPANN using your desired method.