Package: gdstk
GDSTKGdstk (GDSII Tool Kit) is a C++ library for creation and manipulation of GDSII and OASIS files.
It is also available as a Python module meant to be a successor toGdspy.Key features for the creation of complex CAD layouts are included:Boolean operations on polygons (AND, OR, NOT, XOR) based on clipping algorithmPolygon offset (inward and outward rescaling of polygons)Efficient point-in-polygon solutions for large array setsTypical applications of Gdstk are in the fields of electronic chip design, planar lightwave circuit design, and mechanical engineering.DocumentationThe complete documentation is availablehere.The source files can be found in thedocsdirectory.InstallationC++ library onlyThe C++ library is meant to be used by including it in your own source code.If you prefer to install a static library, the includedCMakeLists.txtshould be a good starting option (use-DCMAKE_INSTALL_PREFIX=pathto control the installation path):cmake-S.-Bbuild
cmake--buildbuild--targetinstallThe library depends onzlib.Python wrapperThe Python module can be installed via pip, Conda or compiled directly from source.
It depends on:zlibqhullCMakePythonNumpySphinx,Read the Docs Theme, andSphinx Inline Tabs(to build thedocumentation)From PyPISimply run the following to install the package for the current user:pipinstall--usergdstkOr download and install the available wheels manually.CondaWindows users are suggested to install viaCondausing the availableconda-forge recipe.
The recipe works on MacOS and Linux as well.To install in a new Conda environment:# Create a new conda environment named gdstkcondacreate-ngdstk-cconda-forge--strict-channel-priority# Activate the new environmentcondaactivategdstk# Install gdstkcondainstallgdstkTo use an existing environment, make sure it is configured to prioritize the conda-forge channel:# Configure the conda-forge channelcondaconfig--env--addchannelsconda-forge
condaconfig--env--setchannel_prioritystrict# Install gdstkcondainstallgdstkFrom sourceThe module must be linked against zlib.
The included CMakeLists.txt file can be used as a guide.Installation from source should follow the usual method (there is no need to compile the static library beforehand):pythonsetup.pyinstallSupportHelp support Gdstk development bydonating via PayPalorsponsoring me on GitHub.BenchmarksThebenchmarksdirectory contains a few tests to compare the performance gain of the Python interface versus Gdspy.
They are only for reference; the real improvement is heavily dependent on the type of layout and features used.
If maximal performance is important, the library should be used directly from C++, without the Python interface.Timing results were obtained with Python 3.11 on an Intel Core i7-9750H @ 2.60 GHz
They represent the best average time to run each function out of 16 sets of 8 runs each.BenchmarkGdspy 1.6.13Gdstk 0.9.41Gain10k_rectangles80.2 ms4.87 ms16.51k_circles312 ms239 ms1.3boolean-offset187 μs44.7 μs4.19bounding_box36.7 ms170 μs216curves1.52 ms30.9 μs49.3flatten465 μs8.17 μs56.9flexpath2.88 ms16.1 μs178flexpath-param2.8 ms585 μs4.78fracture929 μs616 μs1.51inside161 μs33 μs4.88read_gds2.68 ms94 μs28.5read_rawcells363 μs52.4 μs6.94robustpath171 μs8.68 μs19.7Memory usage per object for 100000 objects:ObjectGdspy 1.6.13Gdstk 0.9.41ReductionRectangle601 B232 B61%Circle (r = 10)1.68 kB1.27 kB24%FlexPath segment1.48 kB439 B71%FlexPath arc2.26 kB1.49 kB34%RobustPath segment2.89 kB920 B69%RobustPath arc2.66 kB920 B66%Label407 B215 B47%Reference160 B179 B-12%Reference (array)189 B181 B4%Cell430 B229 B47%