|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
<html> |
|
|
<head> |
|
|
|
|
|
|
|
|
<meta name="Description" content="KLayout layout viewer and editor project page" /> |
|
|
<meta name="Keywords" content="KLayout OASIS GDS2 viewer editor layout semiconductor mask chip design" /> |
|
|
<meta name="abstract" content="KLayout is a free layout viewer and editor for several formats commonly used in the semiconductor industry to transfer layout data" /> |
|
|
<meta name="URL" content="https://www.klayout.de/" /> |
|
|
<meta name="Author" content="Matthias Koefferlein" /> |
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
|
|
<meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|
|
|
|
|
<title>KLayout Layout Viewer And Editor</title> |
|
|
|
|
|
|
|
|
<link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.klayout.de/news.xml"/> |
|
|
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/format.css?v2.0"/> |
|
|
<link rel="shortcut icon" href="https://www.klayout.de/favicon.ico"/> |
|
|
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="https://www.klayout.de/fonts.css"/> |
|
|
|
|
|
|
|
|
<script src="https://www.klayout.de/jquery-3.4.1.min.js"></script> |
|
|
|
|
|
|
|
|
<link href="https://www.klayout.de/bootstrap-4.3.1-dist/css/bootstrap.min.css" rel="stylesheet"> |
|
|
<script src="https://www.klayout.de/bootstrap-4.3.1-dist/js/bootstrap.min.js"></script> |
|
|
|
|
|
<link href="/generated-doc.css" rel="stylesheet"> |
|
|
<link href="/search.css" rel="stylesheet"> |
|
|
<script src="/klayout-search.js"></script> |
|
|
|
|
|
</head> |
|
|
|
|
|
<body> |
|
|
|
|
|
<div class="klayout-header"> |
|
|
|
|
|
<div class="container mb-5"> |
|
|
|
|
|
<nav class="navbar navbar-dark navbar-expand-lg"> |
|
|
|
|
|
<a class="navbar-brand" href="https://www.klayout.de"><img src="https://www.klayout.de/klayout.png" srcset="https://www.klayout.de/klayout-x2.png 2x" alt="KLayout"></a> |
|
|
|
|
|
<div class="collapse navbar-collapse" id="navbarToggleExternalContent"> |
|
|
|
|
|
<ul class="navbar-nav ml-auto mr-auto"> |
|
|
|
|
|
<li class="nav-item dropdown active mr-4"> |
|
|
<a class="nav-link dropdown-toggle klayout-menu" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> |
|
|
About |
|
|
</a> |
|
|
<div class="dropdown-menu" aria-labelledby="navbarDropdown"> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/intro.html">KLayout Project</a> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/doc.html">Documentation</a> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/galleries.html">Galleries</a> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/credits.html">Credits</a> |
|
|
<div class="dropdown-divider"></div> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/contact.html">Contact</a> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/impressum.html">Impressum / Imprint</a> |
|
|
<a class="dropdown-item" href="https://www.klayout.de/privacy_policy.html">Datenschutz / Privacy Policy</a> |
|
|
</div> |
|
|
</li> |
|
|
<li class="nav-item active mr-4"> |
|
|
<a class="nav-link klayout-menu" href="https://www.klayout.de/build.html">Get KLayout</a> |
|
|
</li> |
|
|
<li class="nav-item active mr-4"> |
|
|
<a class="nav-link klayout-menu" href="https://sami.klayout.org">Package Index</a> |
|
|
</li> |
|
|
<li class="nav-item active mr-5"> |
|
|
<a class="nav-link klayout-menu" href="https://www.klayout.de/forum">Forum</a> |
|
|
</li> |
|
|
<li class="nav-item active"> |
|
|
<span class="nav-link klayout-menu"> |
|
|
<a href="https://f-si.org"><img src="https://www.klayout.de/f-si_logo_32h_w.png" border="0" title="Free Silicon Foundation" alt="F-Si"/></a> |
|
|
<a class="ml-4" href="https://github.com/KLayout"><img src="https://www.klayout.de/GitHub-Mark-32px-white.png" border="0" title="KLayout on GitHub" alt="GitHub"/></a> |
|
|
</span> |
|
|
</li> |
|
|
|
|
|
</ul> |
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
|
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation"> |
|
|
<span class="navbar-toggler-icon"></span> |
|
|
</button> |
|
|
|
|
|
</nav> |
|
|
|
|
|
</div> |
|
|
|
|
|
</div> |
|
|
|
|
|
<div class="container"> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<form class="search"> |
|
|
<div class="input-group"> |
|
|
<input id="search-text" class="form-control" type="text" onkeydown="klayoutSearchTextChanged()"> |
|
|
<div class="input-group-append"> |
|
|
<button class="btn btn-secondary" type="submit" id="search-button" onclick="klayoutSearchClicked(5); event.returnValue = false; return false">Search</button> |
|
|
</div> |
|
|
</div> |
|
|
</form> |
|
|
|
|
|
<div id="search-result"> |
|
|
<div class="search-results-close-box" onclick="klayoutSearchCloseClicked()"></div> |
|
|
<div id="search-results-container"> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<div class='klayout-generated-doc'><p class="navigator"><b>KLayout Documentation (Qt 5): </b><a href="../index.html">Main Index</a> » <a href="index.html">Various Topics</a> » About Packages</p><h1>About Packages</h1><a name="k_1"></a><a name="k_2"></a><a name="k_3"></a><p> |
|
|
"Salt" is KLayout's package manager which allows selecting and installing packages from a global repository. |
|
|
Packages make KLayout more tasty. Packages (the "grains") may cover a variety of features: |
|
|
</p><ul><li>Ruby or Python macros</li><li>DRC runsets</li><li>Technologies</li><li>Fonts for the Basic.TEXT PCell</li><li>Static layout libraries</li><li>PCell libraries</li><li>Code libraries for Ruby and Python</li><li>Binary extensions</li></ul><p> |
|
|
Packages can depend on other packages - these are installed automatically if a package requires them and they are not installed yet. |
|
|
</p><p> |
|
|
Packages are identified by name. A package name needs to be unique in the package universe. |
|
|
You can use a prefixed name like <tt>www.mydomain.org/nameofpackage</tt> to create a non-ambiguous name. |
|
|
Use a slash to separate the prefix from the actual package name. |
|
|
The choice of the prefix is entirely up to you as long as it contains letters, digits, underscores, hypthens or dots. |
|
|
You can use a domain name that is owned by |
|
|
yourself for example. You can use multiple prefixes to further differentiate the packages |
|
|
inside your namespace. |
|
|
</p><p> |
|
|
Packages also come with version information, so KLayout can check for updates and install |
|
|
them if required. KLayout will assume strict upward compatibility. This specifically |
|
|
applies to packages that other packages are depending on (such as code libraries). |
|
|
If you need to change them in a non-backward compatible way, you'd need to provide |
|
|
a new package with a different name. |
|
|
</p><p> |
|
|
Packages come with some meta data such as authoring information, an optional icon and |
|
|
screen shot image, license information and more. The more information you provide, the |
|
|
more useful a package will become. |
|
|
</p><p> |
|
|
The key component for public package deployment is the "Salt.Mine" package repository |
|
|
service. This is a web service that maintains a package index. It |
|
|
does not host the packages, but stores links to the actual hosting site. In order |
|
|
to author a package, you need to upload the package to one of the supported host |
|
|
sites and register your package on the Salt.Mine page. Registration is a simple |
|
|
process and the only information required is the link to your host site and a mail |
|
|
account for confirmation. |
|
|
</p><a name="h2-65"></a><h2>Installing Packages</h2><p> |
|
|
To install external packages, open the package manager with "Tools/Manage Packages". |
|
|
On the "Install New Packages" page, a list of available packages is shown. Select |
|
|
the desired packages and mark them using the check mark button. Marked packages will |
|
|
be downloaded and installed with the "Apply" button. |
|
|
</p><p> |
|
|
A filter above the package list allows selecting packages by name. |
|
|
The right panel shows details about the package currently selected. |
|
|
</p><a name="h2-79"></a><h2>Updating Packages</h2><p> |
|
|
To check for updates, use the "Update Packages" tab of the package manager. |
|
|
In the list, those packages for which updates are available are shown. |
|
|
Mark packages for update using the check mark button. Click "Apply" to |
|
|
apply the selected updates. |
|
|
</p><a name="h2-88"></a><h2>Uninstalling Packages</h2><p> |
|
|
To uninstall packages, open the package manager using "Tools/Manage Packages". |
|
|
Go to the "Current Packages" tab. Select a package and use the "Remove Package" |
|
|
button to uninstall the package. |
|
|
</p><a name="h2-96"></a><h2>Creating Packages</h2><p> |
|
|
For package development you can utilize KLayout to initialize and edit the files inside |
|
|
the package folder or populate the folder manually. |
|
|
</p><p> |
|
|
KLayout offers initialization of new packages from templates. You can modify that package |
|
|
according to your requirements afterwards. |
|
|
To create a package from a template, open the package manager using "Tools/Manage Packages", |
|
|
go to the "Current Packages" tab and push the "Create (Edit) Package" button. |
|
|
Chose a template from the list that opens and enter a package name (with prefix, if |
|
|
desired). Select "Ok" to let KLayout create a new package based on the template you |
|
|
selected. |
|
|
</p><p> |
|
|
The package details can be edited with the "pen" button at the top right of the |
|
|
right details panel. Please specify at least some author information, a license |
|
|
model and a version. If the package needs other packages, the dependencies can be |
|
|
listed in the "Depends on" table. Those packages will be automatically installed |
|
|
together with the new package. The showcase image can be a screen shot that gives |
|
|
some idea what the package will do. |
|
|
The package details are kept in a file called "grain.xml" inside the package |
|
|
folder. You can also edit this file manually. The "grain.xml" is the basic description |
|
|
file for the package. |
|
|
</p><p> |
|
|
If the package is a macro or static library package, the macro editor can be used |
|
|
to edit the package files. If the package is a tech package, the technology manager |
|
|
can be used to edit the technology inside the package. To populate the package |
|
|
folder with other files use your favorite editor of KLayout itself for layout files. |
|
|
</p><a name="h2-132"></a><h2>Deployment inside your organisation</h2><p> |
|
|
Once a package is finished, it needs to be deployed to make it available to other |
|
|
users. Deployment basically means to put it on some public place where others |
|
|
can download the package. For local deployment inside an organisation, |
|
|
this can be a web server or a folder on |
|
|
a file server. KLayout talks WebDAV, so the web server needs to offer WebDAV |
|
|
access. A subversion (SVN) server provides WebDAV by default, so this is a good |
|
|
choice. For the packages themselves, Git or WebDAV/Subversion can be used. You |
|
|
need to specify the protocol in the package URL (see below). |
|
|
</p><p> |
|
|
After a package has been made available for download, it needs to be entered |
|
|
in the package index. For local deployment, the index can be a file hosted |
|
|
on a web server or on the file system. The package index location needs to be |
|
|
specified by the <tt>KLAYOUT_SALT_MINE</tt> environment variable which contains the |
|
|
download URL of the package index file. |
|
|
</p><p> |
|
|
For public deployment, the Salt.Mine service (<tt>http://sami.klayout.org</tt>) is used to register |
|
|
new packages in the package index. By default, KLayout loads the package index from that service, so |
|
|
once your package is registered there, everyone using KLayout will see it. |
|
|
</p><a name="h2-159"></a><h2>The Package Index</h2><p> |
|
|
Public Packages are published on the Salt.Mine server. This is a web service that delivers a |
|
|
packages index with some meta data such as current version, the icon |
|
|
and a brief description. KLayout uses this list to inform users of packages available |
|
|
for installation and available updates. For local deployment, the package index can be served by other |
|
|
ways too. The only requirement is to be accessible by a http, https or file URL. |
|
|
</p><p> |
|
|
The basic format of the index is XML with this structure: |
|
|
</p><pre><salt-mine> |
|
|
<salt-grain> |
|
|
<name>name</name> |
|
|
<version>Version</version> |
|
|
<title>Title of the package</title> |
|
|
<doc>A brief description</doc> |
|
|
<doc-url>Documentation URL</doc-url> |
|
|
<url>Download URL</url> |
|
|
<license>License model</license> |
|
|
<icon>Icon image: base64-encoded, 64x64 max, PNG preferred</icon> |
|
|
</salt-grain> |
|
|
... |
|
|
<include>URL to include other index files into this one</include> |
|
|
... |
|
|
</salt-mine></pre><p> |
|
|
You can include other repositories - specifically the default one - into a |
|
|
custom XML file. This allows extending the public index with local packages. |
|
|
</p><p> |
|
|
When the package manager is opened, KLayout will download the index from |
|
|
<tt>http://sami.klayout.org/repository.xml</tt>. You can set the <tt>KLAYOUT_SALT_MINE</tt> |
|
|
environment variable to a different URL which makes KLayout use another dictionary |
|
|
service, i.e. one inside your own organisation. This service can be any HTTP server |
|
|
that delivers a package list in the same format than the Salt.Mine package service. |
|
|
The URL can also be a "file:" scheme URL. In this case, KLayout will download the |
|
|
list from the given file location. |
|
|
</p><p> |
|
|
When installing a package, KLayout will simply download the files from the URL given |
|
|
in the package list. KLayout employs the WebDAV protocol to download the files. |
|
|
This protocol is spoken by Subversion and GitHub with the subversion bridge. The |
|
|
latter requires a simple translation of the original Git URL's to obtain the |
|
|
subversion equivalent. |
|
|
</p><a name="h2-212"></a><h2>Generic package URLs</h2><p> |
|
|
Package URLs are the locations from where KLayout will download the package |
|
|
files. The package data is a hierarchy of files. The package description file |
|
|
("grain.xml") needs to be located at the root of this hierarchy. |
|
|
</p><p> |
|
|
A plain package URL will instruct KLayout to download the package file from |
|
|
the given hierarchy using the WebDAV protocol. You can add "svn+" at the front |
|
|
of the URL to make this specification a little more explicit. These are |
|
|
WebDAV/Subversion URLs: |
|
|
</p><pre>https://www.klayout.org/example-package |
|
|
svn+https://www.klayout.org/example-package</pre><p> |
|
|
Git is another option to host packages. In order to use the Git protocol, |
|
|
add "git+" at the front of the URL: |
|
|
</p><pre>git+https://github.com/klayout/example-package.git</pre><p> |
|
|
This will make KLayout clone the "example-package" repository and use the default |
|
|
branch for checking out the files. It will expect a file named "grain.xml" at the |
|
|
root of the package file hierarchy. |
|
|
</p><p> |
|
|
To use a different branch or tag, specify the tag or branch name in square |
|
|
brackes. For example: |
|
|
</p><pre>git+https://github.com/klayout/example-package.git[v1.0]</pre><p> |
|
|
This will use the "v1.0" tag or branch for checking out the files. |
|
|
</p><p> |
|
|
It is also possible to have packages in the a subfolder of the repository. |
|
|
To specify the subfolder, separate the subfolder path from the repository |
|
|
URL using "+", like this: |
|
|
</p><pre>git+https://github.com/klayout/repository.git+klayout/package-data[v1.0]</pre><p> |
|
|
This will clone the "repository" project and in this project, KLayout will checkout |
|
|
files from "klayout/package-data" and below. This is also the place, where KLayout expects |
|
|
the "grain.xml" file. |
|
|
</p><a name="h2-268"></a><h2>Installation Hooks</h2><p> |
|
|
Scripts can register an event through <a href="../code/class_Application.html#m_on_salt_changed">Application#on_salt_changed</a> which |
|
|
indicates that packages have been installed or uninstalled. |
|
|
</p><p> |
|
|
Packages itself can supply special scripts which are executed after a package was installed |
|
|
or before a package is uninstalled: |
|
|
</p><ul><li><tt>_install.lym</tt>: if present, this script is executed after the package is installed.</li><li><tt>_uninstall.lym</tt>: if present, this script is executed before the package is uninstalled.</li></ul><p> |
|
|
Both scripts need to be stored in the same location as "grain.xml" and have to use |
|
|
"lym" format. This is the generic XML script format KLayout employs as an interpreter-agnostic |
|
|
script representation. |
|
|
</p></div> |
|
|
</div> |
|
|
</body> |
|
|
</html> |
|
|
|
|
|
|
