121 lines
6.3 KiB
HTML
121 lines
6.3 KiB
HTML
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0//EN'>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
<title>VLSI SAPD Documentation</title>
|
|
<link href="stylesheet.css" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h1 id="pagetop" class="header">VLSI SAPD Documentation</h1>
|
|
<center class="header">
|
|
<table class="header">
|
|
<tr>
|
|
<td><a href="index.html">Presentation</a></td>
|
|
<td><a href="agds.html">AGDS</a></td>
|
|
<td><a href="cif.html">CIF</a></td>
|
|
<td><a href="dtr.html">DTR</a></td>
|
|
<td><a href="openchams.html">OPENCHAMS</a></td>
|
|
<td><a href="spice.html">SPICE</a></td>
|
|
<td><a href="contact.html">Links & Contact</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
<br>
|
|
<hr>
|
|
<body>
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">OPENCHAMS Format </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="anchor" id="openChamsPres"></a>
|
|
Presentation</h1>
|
|
<p>The <b>OpenCHAMS</b> format was developped as a part of the Chams Project (<a href="http://www-soc.lip6.fr/recherche/cian/chams/">http://www-soc.lip6.fr/recherche/cian/chams/</a>). It aims at offering a convenient way to describe analogic circuits' netlists and is based on XML. Some CHAMS specific informations, such as schematic properties, layout properties or sizing procedure, can be described in this format.<br />
|
|
</p>
|
|
<h2><a class="anchor" id="openChamsAutrhos"></a>
|
|
Author</h2>
|
|
<p>Damien Dupuis: damien.dupuis(at)lip6(.)fr</p>
|
|
<h1><a class="anchor" id="openChamsDB"></a>
|
|
Stand alone database structure</h1>
|
|
<p>The database has many objects that can be arranged in five categories:</p><ul>
|
|
<li>General<ul>
|
|
<li>OpenChams::Circuit</li>
|
|
<li>OpenChams::Name</li>
|
|
<li>OpenChams::OpenChamsException</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="el" href="class_netlist.html">Netlist</a><ul>
|
|
<li>OpenChams::Netlist</li>
|
|
<li>OpenChams::Instance</li>
|
|
<li>OpenChams::Device</li>
|
|
<li>OpenChams::Transistor</li>
|
|
<li>OpenChams::Parameters</li>
|
|
<li>OpenChams::Net</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="el" href="class_sizing.html">Sizing</a><ul>
|
|
<li>OpenChams::Sizing</li>
|
|
<li>OpenChams::Operator</li>
|
|
<li>OpenChams::SimulModel</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="el" href="class_schematic.html">Schematic</a><ul>
|
|
<li>OpenChams::Schematic</li>
|
|
<li>OpenChams::Port</li>
|
|
<li>OpenChams::Wire</li>
|
|
<li>OpenChams::WirePoint</li>
|
|
<li>OpenChams::InstancePoint</li>
|
|
<li>OpenChams::PortPoint</li>
|
|
<li>OpenChams::IntermediatePoint</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="el" href="class_layout.html">Layout</a><ul>
|
|
<li>OpenChams::Layout</li>
|
|
<li>OpenChams::Node</li>
|
|
<li>OpenChams::Bloc</li>
|
|
<li>OpenChams::Group</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="openChamsParser"></a>
|
|
Using the parser</h2>
|
|
<p>Simply load an OPENCHAMS file using the static function OpenChams::Circuit::readFromFile() and then get the netlist object (OpenChams::Circuit::getNetlist()) or the sizing procedure (OpenChams::Circuit::getSizing(), might be NULL) or any other useful information (see OpenChams::Circuit).</p>
|
|
<h2><a class="anchor" id="openChamsDriver"></a>
|
|
Using the driver</h2>
|
|
<p>Using the driver is very simple, user has to create an OpenChams::Circuit object and simply add OpenChams::Netlist (mandatory) and OpenChams::Sizing (optionnal) or OpenChams::Schematic (optionnal) or OpenChams::Layout (optinnal) to it. Finally use the OpenChams::Circuit::writeToFile() method to dump the database to file.</p>
|
|
<h1><a class="anchor" id="openChamsExamples"></a>
|
|
Examples</h1>
|
|
<p>As said is the global presentation, VLSI SAPD project provides C++ libraries and Python modules for each supported format. In this section we present simple code examples to parse and drive a OPENCHAMS file using C++ or Python. The OPENCHAMS files considered are the same for all examples: <code>inverter.xml</code> and <code>buffer.xml</code> </p><div class="fragment"></div><!-- fragment --> <div class="fragment"></div><!-- fragment --><p>All source codes are available in the <code>examples</code> directory.</p>
|
|
<h2><a class="anchor" id="openChamsC"></a>
|
|
C++</h2>
|
|
<h3><a class="anchor" id="openChamsParseC"></a>
|
|
Parser</h3>
|
|
<p>The following code (<code>parseOpenChams.cpp</code>) is an example of how to parse a OPENCHAMS file using C++ library. </p><div class="fragment"></div><!-- fragment --><h3><a class="anchor" id="openChamsDriveC"></a>
|
|
Driver</h3>
|
|
<p>This C++ code (<code>driveOpenChams.cpp</code>) generates an inverter.xml file equivalent to the included one. </p><div class="fragment"></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In order to compile these codes, a CMakeLists.txt file is provided. User must set the $VLSISAPD_TOP variable before running these commands in the directory containing the CMakeLists.txt file: <div class="fragment"><div class="line">%> mkdir build; cd build</div><div class="line">%> cmake ..</div><div class="line">%> make</div></div><!-- fragment --></dd></dl>
|
|
<h2><a class="anchor" id="openChamsPython"></a>
|
|
Python</h2>
|
|
<h3><a class="anchor" id="openChamsParsePython"></a>
|
|
Parser</h3>
|
|
<p>The following python script (<code>parseOpenChams.py</code>) is an example of how to parse a OPENCHAMS file using python module. </p><div class="fragment"></div><!-- fragment --><h3><a class="anchor" id="openChamsDrivePython"></a>
|
|
Driver</h3>
|
|
<p>This python script (<code>driveOpenChams.py</code>) generates an inverter.xml file equivalent to the included one. </p><div class="fragment"></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>In order to run these two scripts (<code>parseOpenChams.py</code> & driveOpenChams.py), user must ensure that $PYTHONPATH variable points to the directory containing OPENCHAMS.so module. </dd></dl>
|
|
</div></div><!-- contents -->
|
|
<br>
|
|
<hr>
|
|
<table class="footer1">
|
|
<tr>
|
|
<td class="LFooter"><small>Generated by doxygen 1.8.14 on Mon Apr 27 2020</small></td>
|
|
<td class="RFooter"><a href='#pagetop'><small>Return to top of page</small></a></td>
|
|
</tr>
|
|
</table>
|
|
<table class="footer2">
|
|
<tr>
|
|
<td class="LFooter">VLSI SAPD Documentation</td>
|
|
<td class="RFooter"><small>Copyright © 2010 - 2011 <a href="http://www.upmc.fr">UPMC</a> All rights reserved</small></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|