GitHub for SiEPIC Tools and PDK Developers

Instructions for SiEPIC-Tools and PDK Developers using KLayout

Installing SiEPIC-Tools using GitHub for version control

Rather than installing using Packages (which makes it read-only), download the files using GitHub Desktop, and create symbolic links to the appropriate folders:

• Install GitHub desktop
• log-in with your user account
• File | Clone Repository: SiEPIC-Tools
• File | Clone Repository: any other PDKs
• Select the branches (master)

KLayout - for PDK Developers:

Create symbolic links from (a) the source: the GitHub local repository folder (GitHub Desktop | Menu | Show in Finder) to (b) destination: the KLayout user configuration folders, as follows:

• Identify the folders for: a) the GitHub files (source) and b) KLayout config folder (destination).

• Script that creates the links:

  • For Windows, you can run the SiEPIC_Devs_Installer.bat script to create the symbolic links; this assumes the directories of kLayout and cloned GitHub repositories (SiEPIC-Tools and SiEPIC_AMF_PDK) are as shown below.
  • For Mac OSX and Linux, you can run the symbolic_links_from_GitHub_to_KLayout.sh script to create the symbolic links; this assumes the directories of KLayout and cloned GitHub repositories (SiEPIC_AMF_PDK) are as shown below. There is similar script for SiEPIC-Tools in that repository.

• Create symbolic links.

  • On Windows, run "command" (right-click, as administrator): "mklink /d destination source", example:
    • cd \Users%username%\KLayout
    • mkdir tech
    • mklink /d C:\Users%username%\KLayout\tech\AMF C:\Users%username%\Documents\GitHub\SiEPIC_AMF_PDK\SiEPIC_AMF_KLayout_Library\tech\AMF
  • On Linux or OSX, in terminal, use: "ln -s", example:
    • ln -s $HOME/Documents/GitHub/SiEPIC_AMF_PDK/SiEPIC_AMF_KLayout_Library/tech/AMF $HOME/.klayout/tech/AMF

• You will also need a clone of the repository SiEPIC-Tools

  • https://github.com/lukasc-ubc/SiEPIC-Tools
  • Make a fork (unless you are a collaborator on the SiEPIC-Tools project, in which case you can contribute directly)
  • It will then show up in the GitHub Desktop list of repositories
  • Follow the (SiEPIC-Tools installation instructions)