README.html

<h1 align="center">
layout2svg
</h1>
<div data-align="justify">
<p>
This is a simple tool to convert an integrated circuit layout saved in
OASIS / GDSII file format to a .SVG image file. The tool supports direct
export of the SVG file into the Inkscape desktop app. This tool was
written with the goal of rendering any layout in a desktop or web
application.
</p>
</div>
<h2 align="center">
Installation
</h2>
<h3 align="center">
MacOS, Linux, Windows
</h3>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install layout2svg</span></code></pre></div>
<h2 align="center">
Usage - Command Line Interface
</h2>
<div class="sourceCode" id="cb2"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">layout2svg</span> <span class="at">-i</span> <span class="op">&lt;</span>input_file_path [.gds/.oas]<span class="op">&gt;</span> -o <span class="op">&lt;</span>output_file_path [.svg]<span class="op">&gt;</span></span></code></pre></div>
<h2 align="center">
Examples
</h2>
<p>
Running the example with the mock layerstack file and layout provided in
the <a href="./examples">examples</a> directory, by running the
following command:
</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">layout2svg</span> <span class="at">-i</span> examples/crossed_metal.gds <span class="at">-t</span> examples/mock_layers.lys.yml <span class="at">-o</span> examples/crossed_metal.svg</span></code></pre></div>
<p>
can generate the following SVG image:
</p>
<p align="center">
<img src="./tests/data/crossed_metal.svg" width=400/>
</p>