15 KiB
Relevant KLayout version: 0.28.15
Author: Kazzz-S
Last modified: 2024-01-05
1. Introduction
This directory macbuild contains various files required for building KLayout (http://www.klayout.de/) version 0.28.13 or later for different 64-bit macOS, including:
- Monterey (12.x) : the primary development environment
- Ventura (13.x) : experimental
- Sonoma (14.x) : -- ditto --
Building KLayout for the previous operating systems listed below has been discontinued.
Pre-built DMG packages are also not provided.
- Big Sur (11.7.10)
- Catalina (10.15.7)
- Mojave (10.14)
- High Sierra (10.13)
- Sierra (10.12)
- El Capitan (10.11)
Throughout this document, the primary target machine is Intel x86_64 with macOS Monterey.
All Apple (M1|M2|M3) chips are still untested, as the author does not own an (M1|M2|M3) Mac.
2. Qt Frameworks
The default Qt framework is "Qt5" from Homebrew (https://brew.sh/), which is usually located under:
/usr/local/opt/qt@5/
If you prefer MacPorts (https://www.macports.org/), "Qt5" is usually located under:
/opt/local/libexec/qt5/
You can also choose "Qt5" from Anaconda3 (https://www.anaconda.com/), which is usually located under:
$HOME/opt/anaconda3/pkgs/qt-{version}
If you have installed Anaconda3 under $HOME/opt/anaconda3/, make a symbolic link:
/Applications/anaconda3/ ---> $HOME/opt/anaconda3/
The migration work to "Qt6" is ongoing. You can try to use it; however, you will encounter some build and runtime errors.
3. Script language support: Ruby and Python
The build script build4mac.py provides several possible combinations of Qt5, Ruby, and Python modules to suit the user's needs and preferences.
Some typical use cases are described in Section 6.
4. Prerequisites
You need to have the followings:
- The latest Xcode and command-line tool kit compliant with each OS
- Qt5 package from Homebrew, MacPorts, or Anaconda3
- Optionally, Ruby and Python packages from Homebrew, MacPorts, or Anaconda3
For matching versions of Ruby and Python, please also refer to build4mac_env.py.
5. Command-line options of build4mac.py
build4mac.py is the top level Python script for for building KLayout for a macOS.
The operating system type is detected automatically.
---------------------------------------------------------------------------------------------------------
<< Usage of 'build4mac.py' >>
for building KLayout 0.28.13 or later on different Apple macOS platforms.
$ [python] ./build4mac.py
option & argument : descriptions (refer to 'macbuild/build4mac_env.py' for details)| default value
--------------------------------------------------------------------------------------+---------------
[-q|--qt <type>] : case-insensitive type=['Qt5MacPorts', 'Qt5Brew', 'Qt5Ana3', | qt5brew
: 'Qt6MacPorts', 'Qt6Brew'] |
: Qt5MacPorts: use Qt5 from MacPorts |
: Qt5Brew: use Qt5 from Homebrew |
: Qt5Ana3: use Qt5 from Anaconda3 |
: Qt6MacPorts: use Qt6 from MacPorts (*) |
: Qt6Brew: use Qt6 from Homebrew (*) |
: (*) migration to Qt6 is ongoing |
[-r|--ruby <type>] : case-insensitive type=['nil', 'Sys', 'MP32', 'HB32', 'Ana3'] | hb32
: nil: don't bind Ruby |
: Sys: use [Sonoma|Ventura|Monterey]-bundled Ruby 2.6 |
: MP32: use Ruby 3.2 from MacPorts |
: HB32: use Ruby 3.2 from Homebrew |
: Ana3: use Ruby 3.2 from Anaconda3 |
[-p|--python <type>] : case-insensitive type=['nil', 'MP311', 'HB311', 'Ana3', | hb311
: 'MP39', 'hb311', 'HBAuto'] |
: nil: don't bind Python |
: MP311: use Python 3.11 from MacPorts |
: HB311: use Python 3.11 from Homebrew |
: Ana3: use Python 3.11 from Anaconda3 |
: MP39: use Python 3.9 from MacPorts (+) |
: hb311: use Python 3.9 from Homebrew (+) |
: (+) for the backward compatibility tests |
: HBAuto: use the latest Python 3.x auto-detected from Homebrew |
[-P|--buildPymod] : build and deploy Pymod (*.whl) for LW-*.dmg | disabled
[-n|--noqtbinding] : don't create Qt bindings for ruby scripts | disabled
[-u|--noqtuitools] : don't include uitools in Qt binding | disabled
[-g|--nolibgit2] : don't include libgit2 for Git package support | disabled
[-m|--make <option>] : option passed to 'make' | '--jobs=4'
[-d|--debug] : enable debug mode build | disabled
[-c|--checkcom] : check command-line and exit without building | disabled
[-y|--deploy] : deploy executables and dylibs, including Qt's Frameworks | disabled
[-Y|--DEPLOY] : deploy executables and dylibs for those who built KLayout | disabled
: from the source code and use the tools in the same machine |
: ! After confirmation of the successful build of 'klayout.app', |
: rerun this script with BOTH: |
: 1) the same options used for building AND |
: 2) <-y|--deploy> OR <-Y|--DEPLOY> |
: optionally with [-v|--verbose <0-3>] |
[-v|--verbose <0-3>] : verbose level of `macdeployqt' (effective with -y only) | 1
: 0 = no output, 1 = error/warning (default), |
: 2 = normal, 3 = debug |
[-?|--?] : print this usage and exit; in zsh, quote like '-?' or '--?' | disabled
-----------------------------------------------------------------------------------------+---------------
6. Use-cases
In this section, the actual file and directory names are those obtained on macOS Monterey.
On different OS, those names differ accordingly.
6A. Standard build using the OS-bundled Ruby and Python with MacPorts
This build has been discontinued.
6B. Fully Homebrew-flavored build with Homebrew Ruby 3.2 and Homebrew Python 3.11
- Install Homebrew, then install Qt5, Ruby 3.2, Python 3.11, and libgit2 by
$ brew install qt@5
$ brew install ruby@3.2
$ brew install python@3.11
$ brew install libgit2
$ cd /where/'build.sh'/exists
$ cd macbuild
$ ./python3HB.py -v 3.11
- Invoke
build4mac.pywith the following options: ((Notes)) These options are the default values for Monterey, Ventura, and Sonoma.
$ cd /where/'build.sh'/exists
$ ./build4mac.py -q qt5brew -r hb32 -p hb311
- Confirm successful build (it will take about one hour, depending on your machine spec).
- Rerun
build4mac.pywith the same options used in 1. PLUS "-Y" to deploy executables and libraries underklayout.appbundle.
The buddy command-line tools (strm*) will also be deployed under klayout.app/Contents/Buddy/ in this step.
If you use--buildPymodoption in Step-1 and Step-3, the KLayout Python Module (*.whl) will be built and deployed under klayout.app/Contents/pymod-dist/.
$ ./build4mac.py -q qt5brew -r hb32 -p hb311 -Y
The application bundle klayout.app is located under:
LW-qt5Brew.pkg.macos-Monterey-release-Rhb32Phb311 directory, where
- "LW-" means this is a lightweight package.
- "qt5Brew" means that Qt5 from Homebrew is used.
- "Rhb32Phb311" means that Ruby is 3.2 from Homebrew; Python is 3.11 from Homebrew.
- Copy/move the generated application bundle
klayout.appto your/Applicationsdirectory for installation.
6C. Partially Homebrew-flavored build with System Ruby and Homebrew Python 3.11
- Install Homebrew, then install Qt5, Python 3.11, and libgit2 by
$ brew install qt@5
$ brew install python@3.11
$ brew install libgit2
$ cd /where/'build.sh'/exists
$ cd macbuild
$ ./python3HB.py -v 3.11
- Invoke
build4mac.pywith the following options:
$ cd /where/'build.sh'/exists
$ ./build4mac.py -q qt5brew -r sys -p hb311
- Confirm successful build (it will take about one hour, depending on your machine spec).
- Rerun
build4mac.pywith the same options used in 1. PLUS "-y" to deploy executables and libraries (including Qt and Python frameworks) under theklayout.appbundle.
The buddy command-line tools (strm*) will also be deployed under klayout.app/Contents/Buddy/ in this step.
$ ./build4mac.py -q qt5brew -r sys -p hb311 -y
The application bundle klayout.app is located under:
HW-qt5Brew.pkg.macos-Monterey-release-RsysPhb311 directory, where
- "HW-" means this is a heavyweight package because both Qt5 and Python Frameworks are deployed.
- "qt5Brew" means that Qt5 from Homebrew is used.
- "RsysPhb311" means that Ruby is OS-bundled; Python is 3.11 from Homebrew.
- Copy/move the generated application bundle
klayout.appto your/Applicationsdirectory for installation.
Important
So far, the deployment of Homebrew Ruby is not supported.
Therefore, if you intend to use the "-y" option for deployment, you need to use the "-r sys" option for building.
6D. Fully MacPorts-flavored build with MacPorts Ruby 3.2 and MacPorts Python 3.11
- Install MacPorts, then install Qt5, Ruby 3.2, Python 3.11, and libgit2 by
$ sudo port install coreutils
$ sudo port install findutils
$ sudo port install qt5
$ sudo port install ruby32
$ sudo port install python311
$ sudo port install py311-pip
$ sudo port install libgit2
- Invoke
build4mac.pywith the following options:
$ cd /where/'build.sh'/exists
$ ./build4mac.py -q qt5macports -r mp32 -p mp311
- Confirm successful build (it will take about one hour, depending on your machine spec).
- Rerun
build4mac.pywith the same options used in 1. PLUS "-Y" to deploy executables and libraries underklayout.appbundle.
The buddy command-line tools (strm*) will also be deployed under klayout.app/Contents/Buddy/ in this step.
If you use--buildPymodoption in Step-1 and Step-3, the KLayout Python Module (*.whl) will be built and deployed under klayout.app/Contents/pymod-dist/.
$ ./build4mac.py -q qt5macports -r mp32 -p mp311 -Y
The application bundle klayout.app is located under:
LW-qt5MP.pkg.macos-Monterey-release-Rmp32Pmp311 directory, where
- "LW-" means this is a lightweight package.
- "qt5MP" means that Qt5 from MacPorts is used.
- "Rmp32Pmp311" means that Ruby is 3.2 from MacPorts; Python is 3.11 from MacPorts.
- Copy/move the generated application bundle
klayout.appto your/Applicationsdirectory for installation.
6E. Fully Anaconda3-flavored build with Anaconda3 Ruby 3.2 and Anaconda3 Python 3.11
- Install Anaconda3 (Anaconda3-2023.09-0-MacOSX-x86_64.pkg), then install Ruby 3.2 and libgit2 by
$ conda install ruby=3.2.2
$ conda install -c conda-forge libgit2
- Invoke
build4mac.pywith the following options:
$ cd /where/'build.sh'/exists
$ ./build4mac.py -q qt5ana3 -r ana3 -p ana3
- Confirm successful build (it will take about one hour, depending on your machine spec).
- Rerun
build4mac.pywith the same options used in 1. PLUS "-Y" to deploy executables and libraries underklayout.appbundle.
The buddy command-line tools (strm*) will also be deployed under klayout.app/Contents/Buddy/ in this step.
If you use--buildPymodoption in Step-1 and Step-3, the KLayout Python Module (*.whl) will be built and deployed under klayout.app/Contents/pymod-dist/.
$ ./build4mac.py -q qt5ana3 -r ana3 -p ana3 -Y
The application bundle klayout.app is located under:
LW-qt5Ana3.pkg.macos-Monterey-release-Rana3Pana3 directory, where
- "LW-" means this is a lightweight package.
- "qt5Ana3" means that Qt5 from Anaconda3 is used.
- "Rana3Pana3" means that Ruby (3.2) is from Anaconda3; Python (3.11) is from Anaconda3.
- Copy/move the generated application bundle
klayout.appto your/Applicationsdirectory for installation. - You may have to set the
PYTHONHOMEenvironment variable like:
export PYTHONHOME=$HOME/opt/anaconda3
6F. Other combinations
Logically, several module combinations other than 6B through 6E are possible, including nil choice.
The resultant package directory name will begin with EX- (exceptional) if you choose such a combination.
6G. Using the git-based Salt Package Manager through a proxy server
If you use the git-based Salt Package Manager through a proxy server, you need to set the KLAYOUT_GIT_HTTP_PROXY environment variable. For example,
$ export KLAYOUT_GIT_HTTP_PROXY="http://111.222.333.444:5678"
Ask your system administrator for the actual IP address and port number of your proxy server.
It is highly recommended that this setting is included in a launching service script bundle.
A sample content (*.app.Bash) of the script bundle can be found in Resources/script-bundle-[A|B|H|P].zip.
7. Making a DMG installer
You can make a DMG installer using another Python script makeDMG4mac.py.
This script requires a directory generated by build4mac.py with the [-y|-Y] option (refer to 6B through 6E).
- Make a symbolic link (if it does not exist) from the parent directory (where
build.shexists) tomakeDMG4mac.py, that is,
makeDMG4mac.py -> macbuild/makeDMG4mac.py
- Invoke
makeDMG4mac.pywith -p and -m options, for example,
$ cd /where/'build.sh'/exists
$ ./makeDMG4mac.py -p LW-qt5MP.pkg.macos-Monterey-release-Rmp32Pmp311 -m
This command will generate the two files below:
LW-klayout-0.28.13-macOS-Monterey-1-qt5MP-Rmp32Pmp311.dmg---(1) the main DMG fileLW-klayout-0.28.13-macOS-Monterey-1-qt5MP-Rmp32Pmp311.dmg.md5---(2) MD5-value text file
Known issues
Because we assume some specific versions of non-OS-standard Ruby and Python, updating Homebrew, MacPorts, or Anaconda3 may cause build- and link errors.
In such cases, you need to update the dictionary contents of build4mac_env.py.
Final comments
No need to say KLayout is a great tool!
With the object-oriented script language (both Ruby and Python) support, our error-prone layout jobs can be significantly simplified and sped up.
Building KLayout from its source code is not difficult. Try it with your favorite environment!
[End of File]