Installation

Getting started

You may use pip to install dphox the usual way:

pip install dphox

To install all of the dependencies for visualizations as in the above demo, instead run:

pip install dphox[all]

Development

When developing, install in your python environment using:

git clone git@github.com:solgaardlab/dphox.git
pip install -e dphox

You can then change dphox if necessary. When importing dphox, you can now treat it as any other module. No filepath setting necessary because dphox will be in your environment’s site-packages directory.

Requirements

You will need python>=3.9 as well as the following (note these requirements are automatically installed):

numpy==1.21.2
scipy==1.7.1
shapely==1.7.0
klamath>=1.2

These will be installed via pip automatically if not already installed.

Optional requirements

The following modules are nice-to-have but optional, and are not included in default installation:

bokeh==2.2.3
holoviews==1.14.6
trimesh==3.9.30
triangle==20200424
matplotlib==3.4.3
networkx

You can also install libraries such as nazca and gdspy, which can be converted to dphox objects.