Skip to content
KLayout Main Sources
C++ Ruby QMake Python Shell C
Branch: master
Clone or download
klayoutmatthias Merge pull request #469 from KLayout/issue-464
Fixed #464 (problems building a layer node tree with 'add_child')
Latest commit 80b0eae Jan 4, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci-scripts increasing linux ccache size to 5G Apr 4, 2019
etc Updated CONTRIB file, preparations for RPM building. Sep 10, 2017
macbuild Set the right Ruby environment for Mojave. Jan 1, 2020
samples/lvs Some refactoring, better templates Jul 13, 2019
scripts Updated copyright notice to 2020 Jan 4, 2020
src Merge pull request #469 from KLayout/issue-464 Jan 5, 2020
testdata
.gitignore Updated .gitignore. Sep 9, 2018
.travis.yml update homebrew in cp27-cp27m-macosx_10_13_x86_64.whl Jul 24, 2019
CONTRIB Updated CONTRIB file, preparations for RPM building. Sep 10, 2017
COPYRIGHT Updated changelog, copyright file. Jan 5, 2020
Changelog Updated Changelog Jan 4, 2020
Changelog.Debian Updated changelog, copyright file. Jan 5, 2020
Jenkinsfile Enabled CI builds (added Jenkinsfiles) Jun 25, 2018
Jenkinsfile-publish-doc Enabled CI builds (added Jenkinsfiles) Jun 25, 2018
Jenkinsfile-publish-sources Enabled CI builds (added Jenkinsfiles) Jun 25, 2018
LICENSE Initial commit Feb 12, 2017
MANIFEST.in bugfix for setup.py sdist Oct 9, 2018
Makefile fixing ut_runner by adding DYLD_LIBRARY_PATH to env varas Oct 5, 2018
README.md Windows build script and setup.py for Anaconda (install needs testing). Sep 12, 2018
azure-pipelines.yml pymod 0.26.0.dev15 - included basic.lib Apr 4, 2019
build.bat Fixed build.bat - wasn't properly exiting and did not really perform … Sep 27, 2018
build.sh Updated copyright notice to 2020 Jan 4, 2020
build4mac.py adding symlinks to build4mac scripts Mar 16, 2018
dropbox-deployment.yml Deploying tarballs Jul 11, 2018
makeDMG4mac.py adding symlinks to build4mac scripts Mar 16, 2018
setup.py Updated copyright notice to 2020 Jan 4, 2020
test-pylib-script.py Manual merge of remaining files from lightwave-lab:pymod-test to pymod Oct 2, 2018
travis-build.sh minor edit in logging Apr 5, 2019
version.sh Update version to 0.26.3 Jan 4, 2020

README.md

klayout

This repository will hold the main sources for the KLayout project.

Plugins can be included into the "plugins" directory from external sources.

For more details see http://www.klayout.org.

Building requirements

Building on Linux:

  • Qt 4.7 or later (4.6 with some restrictions) or Qt 5
  • gcc 4.6 or later or clang 3.8 or later

Building on Windows with MSYS2:

  • MSYS2 with gcc, Qt4 or 5, zlib, ruby and python packages installed

Building on Windows with MSVC 2017:

  • MSVC 2017
  • Build requisites from klayout-kit

For more build instructions see http://www.klayout.de/build.html.

Build options

  • Ruby: with this option, Ruby scripts can be executed and developped within KLayout. Ruby support is detected automatically by the build script.
  • Python: with this option, Python scripts can be executed and developped within KLayout. Python support is detected automatically by the build script.
  • Qt binding: with this option, Qt objects are made available to Ruby and Python scripts. Qt bindings are enabled by default. Qt binding offers an option to create custom user interfaces from scripts and to interact with KLayout's main GUI. On the other hand, they provide a considerable overhead when building and running the application.
  • 64 bit coordinate support: with this option, the coordinate type used internally is extended to 64bit as compared to 32bit in the standard version. This will duplicate memory requirements for coordinate lists, but allow a larger design space. 64bit coordinate support is experimental and disabled by default.

Building instructions (Linux)

Plain building for Qt4

./build.sh

Plain building for Qt5

./build.sh -qt5

Building without Qt binding

./build.sh -without-qtbinding

Debug build

./build.sh -debug

Building with a particular Ruby version

./build.sh -ruby <path-to-ruby>

(path-to-ruby is the full path of the particular ruby interpreter)

Building with a particular Python version

./build.sh -python <path-to-python>

(path-to-python is the full path of the particular python interpreter)

Building with a particular Qt version

./build.sh -qmake <path-to-qmake>

(path-to-qmake is the full path of the particular qmake installation)

Building with 64bit coordinate support (experimental)

./build.sh -with-64bit-coord

Pass make options

./build.sh -j4

(for running 4 jobs in parallel)

More options

For more options use

./build.sh -h

Running the Test Suite (Linux)

Go to the build directory (i.e. "bin-release") and enter

export TESTTMP=testtmp    # path to a directory that will hold temporary data (will be created)
export TESTSRC=..         # path to the source directory
./ut_runner

For more options use

./ut_runner -h

Build instructions (Windows, MSYS2)

From the MSYS2 MinGW bash (32 bit or 64 bit) use the same commands as for Linux to build the binaries.

Build instructions (Windows, MSVC 2017)

The combination supported and tested was Qt 5.11/MSVC 2017 64bit. It's sufficient to install the build tools from MSVC's community edition.

A build script similar to build.sh is provided for Windows (build.bat).

For details about this build script use

build.bat -h

For MSVC builds a number of third party libraries are required:

  • Ruby
  • Python
  • zlib
  • expat
  • curl
  • pthread-win

The "klayout-bits4msvc2017" project (https://github.com/klayoutmatthias/klayout_bits4msvc2017) targets towards providing a binary distribution for this purpose. See the release notes there for download links. Download the .zip archive from there and unpack it to some folder, e.g. "c:\klayout-bits".

The build script needs the path to this package. "qmake" and (for obtaining the build version) "git" should be in the path. If qmake is not in the path, you can use "build.bat -qmake ..." to specify qmake's path.

Here is an example for the build.bat call:

build.bat -bits c:\klayout-bits

The 3rd party bits kit can also be used to build the Python standalone package on setuptools. Specify the full path to the 3rd party package up to the compiler and architecture. On 64bit with the bits package installed in "c:\klayout-bits" the build call is this:

set KLAYOUT_BITS=c:\klayout-bits\msvc2017\x64
python setup.py build
You can’t perform that action at this time.