Skip to content

Installation

Lukas Chrostowski edited this page May 20, 2024 · 20 revisions

SiEPIC-Tools – Installation Instructions

Install KLayout version 0.28.15 or greater

SiEPIC-Tools - Option 1: Using the KLayout Package Manager (requires internet access)

The Tools are distributed using KLayout's Package Manager.

Open KLayout, then menu item Tools | Manage Packages

  • Install the 'siepic_tools' package

  • Restart KLayout

  • You should see a new menu item, "SiEPIC" with the version number

  • Check back periodically in the Package Manager for updates

SiEPIC-Tools - Option 2: using GitHub Desktop

In case there are errors with KLayout's Package Manager, an alternative means to install SiEPIC-Tools downloads it directly from GitHub, using GitHub Desktop:

  • Install GitHub Desktop https://desktop.github.com/ (for Windows and Mac OSX users; Linux users need to use git)
  • Install this repository using GitHub Desktop: go to the main page (https://github.com/SiEPIC/SiEPIC-Tools), then click on the green button Code > Open in GitHub Desktop
  • Follow instructions in GitHub Desktop. The installation script assumes the default install folders.
  • in GitHub, menu Repository > {Show in Explorer, or Show in Finder}, then go to folder Documentation / Developers
  • Then run the installation script (creates symbolic links), either:
    • SiEPIC_Devs_Installer.bat (for Windows)
      • to run it, right-click on the file, and choose "Run as Administrator"
    • symbolic_links_from_GitHub_to_KLayout.sh (for Mac OSX)
  • Restart KLayout
  • You should see a new menu item, "SiEPIC" with the version number
  • Check back periodically in GitHub Desktop for updates ("Fetch Origin") button

SiEPIC-Tools - Option 3: as a contributor

If you are interested in contributing, or getting more instance updates, we have a different method for installing the tools, by linking the GitHub project to KLayout.