Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.46 KB

README.md

File metadata and controls

106 lines (74 loc) · 3.46 KB

klayout_pyxs

This is a python port of the XSection project (https://github.com/klayoutmatthias/xsection).

The goal of this project is to provide an add-on to KLayout (www.klayout.de) to create and visualize a realistic cross-section view for VLSI designs supporting a wide range of technology options.

User Documentation

For the project description see klayout_pyxs Project Home Page.

For an introduction into writing PYXS files, see Writing PYXS Files - an Introduction.

For a reference of the elements of the PYXS scripts, see PYXS File Reference.

Project Files

The basic structure is:

  • docs The documentation
  • klayout_pyxs The python package sources
  • pymacros The python .lym macros files for KLayout
  • samples Some sample files
  • tests Test sources and golden data
  • xs2pyxs xs to pyxs conversion scripts

The docs folder contains the .rst files and images for the documentation pages. See rendered version here.

The klayout_pyxs folder contains the python package which includes the cross-section generation engine.

The pymacros folder contains with the actual KLayout macros code, pyxs.lym.

The samples folder holds a few files for playing around.

The tests folder contains some regression tests for the package. To run the tests, make sure "klayout" or "klayout_app" (in Windows) is in your path and use

$ cd tests
$ ./run_tests.sh

or (from e.g. git bash console on Windows)

$ cd tests
$ bash run_tests_windows.sh

The xs2pyxs folder contains a shell script which helps converting Ruby-based .xs scripts to .pyxs scripts. It performs necessary but not sufficient string replacements. Depending on the .xs script complexity, more changes are likely to be needed.

Installation

Windows

To run .pyxs scripts from the KLayout menu, klayout_pyxs package and python macros file have to be installed to the KLayout folders. According to KLayout documentation, they should go to the "pymacros" and "python" folders in KLayout's user specific application folder. In Windows, it is $USERPROFILE/KLayout.

In Windows, do the following (the commands should be run from e.g. git bash console) Tested on KLayout 0.25.3 and 0.25.7.

  1. Check if $USERPROFILE/KLayout exists and is used by the KLayout to store macros. Run

    $ ls $USERPROFILE/KLayout

    If no error reported, continue with 1. If there is an error, you need to find a location of KLayout's user specific application folder with pymacros, python folders and use it in further commands.

  2. Clone klayout_pyxs repository into any source folder:

    $ git clone https://github.com/dimapu/klayout_pyxs.git klayout_pyxs_repo

  3. Copy klayout_pyxs_repo/pymacros/pyxs.lym to $USERPROFILE/KLayout/pymacros/pyxs.lym

    $ cp klayout_pyxs_repo/pymacros/pyxs.lym $USERPROFILE/KLayout/pymacros/pyxs.lym

  4. Copy klayout_pyxs_repo/klayout_pyxs/. to $USERPROFILE/KLayout/python/klayout_pyxs

    $ mkdir $USERPROFILE/KLayout/python/klayout_pyxs
$ cp klayout_pyxs_repo/klayout_pyxs/*.py $USERPROFILE/KLayout/python/klayout_pyxs

Now, run Klayout. In the Tools menu, you should see pyxs > Load pyxs script.