/
api.html
106 lines (97 loc) · 5.19 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>skidl 0.0.21 documentation</title>
<link rel="stylesheet" href="static/classic.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.0.21',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html#document-index">skidl 0.0.21 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="skidl-api">
<h1>SKiDL API<a class="headerlink" href="#skidl-api" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<span id="document-api"></span><p><strong>This is a really, really bad API document.</strong> I’m working to make Sphinx generate a better one
but, right now, the description on the homepage about how to use SKiDL is much better than this.</p>
<span class="target" id="module-skidl.skidl"></span><p>SKiDL: A Python-Based Schematic Design Language</p>
<p>This module extends Python with the ability to design electronic
circuits. It provides classes for working with</p>
<p><strong>1)</strong> electronic parts (<code class="docutils literal"><span class="pre">Part</span></code>),
<strong>2)</strong> collections of part terminals (<code class="docutils literal"><span class="pre">Pin</span></code>) connected via wires (<code class="docutils literal"><span class="pre">Net</span></code>), and
<strong>3)</strong> groups of related nets (<code class="docutils literal"><span class="pre">Bus</span></code>).</p>
<p>Using these classes, you can
concisely describe the interconnection of components using a linear
and/or hierarchical structure. It also provides the capability to
check the resulting circuitry for the violation of electrical rules.
The output of a SKiDL-enabled Python script is a netlist that can be
imported into a PCB layout tool.</p>
<dl class="function">
<dt id="skidl.skidl.set_backup_lib">
<code class="descclassname">skidl.skidl.</code><code class="descname">set_backup_lib</code><span class="sig-paren">(</span><em>lib</em><span class="sig-paren">)</span><a class="headerlink" href="#skidl.skidl.set_backup_lib" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the backup library.</p>
</dd></dl>
<dl class="function">
<dt id="skidl.skidl.set_default_tool">
<code class="descclassname">skidl.skidl.</code><code class="descname">set_default_tool</code><span class="sig-paren">(</span><em>tool</em><span class="sig-paren">)</span><a class="headerlink" href="#skidl.skidl.set_default_tool" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the ECAD tool that will be used by default.</p>
</dd></dl>
<dl class="function">
<dt id="skidl.skidl.set_query_backup_lib">
<code class="descclassname">skidl.skidl.</code><code class="descname">set_query_backup_lib</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#skidl.skidl.set_query_backup_lib" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the boolean that controls searching for the backup library.</p>
</dd></dl>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="index.html#document-index">skidl 0.0.21 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
</div>
</body>
</html>