zeroheliumkit 0.5.5

--

ZeroHeliumKit

ZeroHeliumKit is a Python module for planar geometry creation and manipulations designed for building microfabricated chips, and integrated electric field calculations. ZeroHeliumKit allows to create complex structure designs from simple geometries and assemble them in an intuitive Lego-style level. Geometry creation and assembly part is based on Shapely python package, which provides fast boolean operations on geometrical objects. ZeroHeliumKit enables simple integration with Gmsh (mesh generation toolkit) and FreeFEM++ (finite element solver for partial differential equations) to perform electric field calculations on designed geometrical structures.

Documentation

The complete documentation (with examples) is available here.

Installing

After cloning repository, cd into the new directory and install neseccary packages:

pip install -r requirements.txt

Note, if you are on Windows or Mac and don’t already have gdspy installed, you will need a C++ compiler (in case if you have an error in installing this package):

• for Windows + Python 3, install the Microsoft “Build Tools for Visual Studio”
• For Mac, install “Xcode” from the App Store, then run the command xcode-select --install in the terminal

Next, install zeroheliumkit into your environment:

pip install -e .

You can now open your python and run import zeroheliumkit. The final step is to install the latest FreeFEM++ software, which can be found here.

Usage

The easiest way to learn is through examples

Creating anchors and routes basics:

Creating mesh and Caculating electrostatic potential distribution fem: