riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/documentation/output/pages/documentation.html

227 lines
11 KiB
HTML
Raw Normal View History

Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
Documentation cleanup & rebuild. * Change: In documentation/build.py, more PEP8 & Python 3 future compliance. Correct copy of the tools HTML docs on my laptop, to have a full offline copy of the doc. * New: In documentation/contents/pages/check-toolkit, duplicate the doc from alliance-check-toolkit README. Seems it has been inadvertently removed at some point (?). Have to be careful to maintain in synch with the toolkit. * Change: <tool>/doc/*/SoC.css, use Roboto fonts when availables. * Update: Commit the whole pre-generated docs (Doxygen, Pelican).
2020-11-12 07:22:31 -06:00
<meta name="description" content="Alliance Documentation Alliance Installation How to get, build &amp; install Alliance alongside Coriolis Alliance Check Toolkit Regression tests &amp; examples Coriolis Documentation Coriolis User&#39;s Guide ...">
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
<title>Documentation - Coriolis VLSI CAD Tools [offline]</title>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<!-- Stylesheets -->
<link href="../theme/css/bootstrap.css" rel="stylesheet">
<link href="../theme/css/fonts.css" rel="stylesheet">
<link href="../theme/css/nest.css" rel="stylesheet">
<link href="../theme/css/pygment.css" rel="stylesheet">
<link href="../theme/css/coriolis.css" rel="stylesheet">
<!-- /Stylesheets -->
<script src="../theme/js/jquery.min.js"></script>
<script src="../theme/js/bootstrap.min.js"></script>
<!-- RSS Feeds -->
<!-- /RSS Feeds -->
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<!-- Header -->
<div class="header-container" style="background: linear-gradient(rgba(0, 0, 0, 0.2), rgba(0, 0, 0, 0.2)), url('../images/common/layout-motif-faded-4.png'); background-position: center; ">
<!--
<div class="container">
<nav class="navbar navbar-default">
<div class="container-fluid">
<div class="navbar-header">
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
<a class="navbar-brand" href="../"><img class="mr20" src="../images/common/Coriolis-logo-white-4-small.png" alt="logo">Coriolis VLSI CAD Tools [offline]</a>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
</div>
<ul class="nav navbar-nav">
<li><a href="../pages/gitlab.html">Git</a></li>
<li><a href="../pages/documentation.html">Documentation</a></li>
<li class="dropdown">
<button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
<span class="caret"></span>Topics
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item " href="../pages/homepage.html">Coriolis <span class="sc">vlsi</span> Backend Tools</a></li>
<li><a class="dropdown-item " href="../pages/symbolic-layout.html">Symbolic Layout</a></li>
</ul>
</li>
</ul>
</div>
</nav>
</div> <!-- navbar container -->
-->
<!-- Static navbar -->
<div class="container">
<div class="header-nav">
<div class="header-logo">
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
<a class="pull-left" href="../"><img class="mr20" src="../images/common/Coriolis-logo-white-4-small.png" alt="logo">Coriolis VLSI CAD Tools [offline]</a>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
</div>
<div class="nav pull-right">
<a href="../pages/gitlab.html">Git</a>
<a href="../pages/documentation.html">Documentation</a>
</div>
<div class="nav pull-right">
<div class="dropdown">
<button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
<span class="caret"></span>Topics
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item " href="../pages/homepage.html">Coriolis <span class="sc">vlsi</span> Backend Tools</a></li>
<li><a class="dropdown-item " href="../pages/symbolic-layout.html">Symbolic Layout</a></li>
</ul>
</div>
</div>
</div>
</div>
<!-- /Static navbar -->
<!-- Header -->
<div class="container header-wrapper">
<div class="row">
<div class="col-lg-12">
<div class="header-content">
<a href="https://www.lip6.fr/"><img class="mr20" height="60px" src="../images/common/LogoLIP6Blanc.png" alt="LIP6"></a>
<a href="https://www.sorbonne-universite.fr/"><img class="mr20" height="60px" src="../images/common/logo-SU-blanc-700px.png" alt="Sorbonne Universite"></a>
<a href="https://www.cnrs.fr/"><img class="mr20" height="60px" src="../images/common/LOGO-cnrs-white-large.png" alt="CNRS"></a>
<h1 class="header-title text-uppercase">Documentation</h1>
<div class="header-underline"></div>
</div>
</div>
</div>
</div>
<!-- /Header -->
</div>
<!-- /Header -->
<!-- Content -->
<div class="container content">
<!-- -*- Mode: rst -*- -->
<!-- -*- Mode: rst; explicit-buffer-name: "definition.rst<documentation/etc>" -*- -->
<!-- HTML/LaTeX backends mixed macros. -->
<!-- Acronyms & names. -->
<!-- URLs -->
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
<div class="section" id="alliance-documentation">
<h2>Alliance Documentation</h2>
<div class="row">
<div class="col-md-5 col-md-offset-1">
<a class="reference external" href="../pages/alliance.html">Alliance Installation</a> <span class="raw-html"><br/></span>
How to get, build &amp; install Alliance alongside Coriolis</div>
Forgotten some pages of the generated documentation.
2020-08-02 11:22:28 -05:00
<div class="col-md-5">
<div class="row">
Documentation cleanup & rebuild. * Change: In documentation/build.py, more PEP8 & Python 3 future compliance. Correct copy of the tools HTML docs on my laptop, to have a full offline copy of the doc. * New: In documentation/contents/pages/check-toolkit, duplicate the doc from alliance-check-toolkit README. Seems it has been inadvertently removed at some point (?). Have to be careful to maintain in synch with the toolkit. * Change: <tool>/doc/*/SoC.css, use Roboto fonts when availables. * Update: Commit the whole pre-generated docs (Doxygen, Pelican).
2020-11-12 07:22:31 -06:00
<a class="reference external" href="../pages/check-toolkit.html">Alliance Check Toolkit</a> <span class="raw-html"><br/></span>
Forgotten some pages of the generated documentation.
2020-08-02 11:22:28 -05:00
Regression tests &amp; examples</div>
</div>
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
</div>
</div>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<div class="section" id="coriolis-documentation">
<h2>Coriolis Documentation</h2>
<div class="row">
<div class="col-md-5 col-md-offset-1">
<p><a class="reference external" href="../pages/users-guide.html">Coriolis User's Guide</a> <span class="raw-html"><br/></span>
Using the software</p>
<p><a class="reference external" href="../pages/python-tutorial.html">Python Tutorial</a> <span class="raw-html"><br/></span>
A Tutorial to use Coriolis through Python</p>
<p><a class="reference external" href="../pages/python-cpp.html">Python/C++ Tutorial</a> <span class="raw-html"><br/></span>
Migration towards Python3, first stage: still based on C-Macros. * New: Python/C++ API level: * Write a new C++/template wrapper to get rid of boost::python * The int & long Python type are now merged. So a C/C++ level, it became "PyLong_X" (remove "PyInt_X") and at Python code level, it became "int" (remove "long"). * Change: VLSISAPD finally defunct. * Configuration is now integrated as a Hurricane component, makes use of the new C++/template wrapper. * vlsisapd is now defunct. Keep it in the source for now as some remaining non essential code may have to be ported in the future. * Note: Python code (copy of the migration howto): * New print function syntax print(). * Changed "dict.has_key(k)" for "k" in dict. * Changed "except Exception, e" for "except Exception as e". * The division "/" is now the floating point division, even if both operand are integers. So 3/2 now gives 1.5 and no longer 1. The integer division is now "//" : 1 = 3//2. So have to carefully review the code to update. Most of the time we want to use "//". We must never change to float for long that, in fact, represents DbU (exposed as Python int type). * execfile() must be replaced by exec(open("file").read()). * iter().__next__() becomes iter(x).__next__(). * __getslice__() has been removed, integrated to __getitem__(). * The formating used for str(type(o)) has changed, so In Stratus, have to update them ("<class 'MyClass'>" instead of "MyClass"). * the "types" module no longer supply values for default types like str (types.StringType) or list (types.StringType). Must use "isinstance()" where they were occuring. * Remove the 'L' to indicate "long integer" (like "12L"), now all Python integer are long. * Change in bootstrap: * Ported Coriolis builder (ccb) to Python3. * Ported Coriolis socInstaller.py to Python3. * Note: In PyQt4+Python3, QVariant no longer exists. Use None or directly convert using the python syntax: bool(x), int(x), ... By default, it is a string (str). * Note: PyQt4 bindings & Python3 under SL7. * In order to compile user's must upgrade to my own rebuild of PyQt 4 & 5 bindings 4.19.21-1.el7.soc. * Bug: In cumulus/plugins.block.htree.HTree.splitNet(), set the root buffer of the H-Tree to the original signal (mainly: top clock). Strangely, it was only done when working in full chip mode.
2021-09-19 12:41:24 -05:00
A Tutorial to the Python/C++ interface <span class="sc">api</span> (C-macros version)</p>
<p><a class="reference external" href="../pages/python-cpp-new.html">Python/C++ Tutorial (template)</a> <span class="raw-html"><br/></span>
A Tutorial to the Python/C++ interface <span class="sc">api</span> (C++ template version)</p>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<p><a class="reference external" href="../pages/stratus-language.html">Stratus Language</a> <span class="raw-html"><br/></span>
A Netlist Capture Language (on top of Python)</p>
<p><a class="reference external" href="../pages/stratus-dpgen.html">DpGen Extension (Stratus)</a> <span class="raw-html"><br/></span>
Netlist Capture extension for Datapathes</p>
<p><a class="reference external" href="../pages/stratus-patterns.html">Pattern Extension (Stratus)</a> <span class="raw-html"><br/></span>
Patterns generation extension</p>
<p><a class="reference external" href="../pages/rds.html">RDS documentation</a> <span class="raw-html"><br/></span>
Translating symbolic layout to <span class="sc">gds</span>.</p>
</div>
<div class="col-md-5">
<div class="row">
<p><a class="reference external" href="../doc/hurricane/index.html">Hurricane Reference</a> <span class="raw-html"><br/></span>
<span class="sc">Hurricane</span> Netlist &amp; Physical structure C++ <span class="sc">api</span></p>
<p><a class="reference external" href="../doc/viewer/index.html">Viewer Reference</a> <span class="raw-html"><br/></span>
Graphical interface C++ <span class="sc">api</span></p>
<p><a class="reference external" href="../doc/crlcore/index.html">CRL Core Reference</a> <span class="raw-html"><br/></span>
Parsers/Drivers and I/O C++ <span class="sc">api</span></p>
<p><a class="reference external" href="../doc/unicorn/index.html">Unicorn Reference</a> <span class="raw-html"><br/></span>
Main GUI C++ <span class="sc">api</span></p>
<p><a class="reference external" href="../doc/katabatic/index.html">Katabatic Reference</a> <span class="raw-html"><br/></span>
Articulated Segments Data-Structure</p>
<p><a class="reference external" href="../doc/kite/index.html">Kite Reference</a> <span class="raw-html"><br/></span>
Digital router</p>
<p><a class="reference external" href="../doc/analog/index.html">Hurricane/Analog Reference</a> <span class="raw-html"><br/></span>
About digital design</p>
<p><a class="reference external" href="../doc/oroshi/index.html">Oroshi Reference</a> <span class="raw-html"><br/></span>
Analog devices generators</p>
</div>
</div>
</div>
</div>
<div class="section" id="third-party-documentation">
<h2>Third Party Documentation</h2>
<div class="row">
<div class="col-md-5 col-md-offset-1">
<a class="reference external" href="../doc/lefdef/lefdefref/lefdefrefTOC.html">LEF/DEF Language Reference</a> <span class="raw-html"><br/></span>
Cadence LEF/DEF 5.8 language reference</div>
<div class="col-md-5">
<p><a class="reference external" href="../doc/lefdef/lefapi/ch1Intro.html">LEF C++ API</a> <span class="raw-html"><br/></span>
Cadence Documentation of LEF 5.8 C++ API</p>
<p><a class="reference external" href="../doc/lefdef/defapi/ch1Intro.html">DEF C++ API</a> <span class="raw-html"><br/></span>
Cadence Documentation of DEF 5.8 C++ API</p>
</div>
</div>
</div>
</div>
<!-- /Content -->
<!-- Footer -->
<div class="footer gradient-2">
<div class="container footer-container ">
<div class="row">
<div class="col-xs-4 col-sm-3 col-md-3 col-lg-3">
<div class="footer-title">Social</div>
<ul class="list-unstyled">
</ul>
</div>
<div class="col-xs-4 col-sm-3 col-md-3 col-lg-2">
</div>
<div class="col-xs-4 col-sm-3 col-md-3 col-lg-3">
<div class="footer-title">Links</div>
<ul class="list-unstyled">
Created docker images to check rebuild on various distributions. * New: In bootstrap/docker, paraphernalia to rebuild and check Coriolis for Debian 9, Ubuntu 18 & SL 7 on pristine systems. Added scripts to rebuild Alliance as well and perform the alliance-check-toolkit regression tests. * Change: Updated installation documentation. Added a section for docker.
2020-02-09 11:18:42 -06:00
<li><a href="https://coriolis.lip6.fr/" target="_blank">Alliance/Coriolis</a></li>
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
<li><a href="https://www-soc.lip6.fr/" target="_blank">CIAN Team Website</a></li>
<li><a href="https://f-si.org" target="_blank">Free Silicon Foundation</a></li>
</ul>
</div>
<div class="col-xs-12 col-sm-3 col-md-3 col-lg-4">
<p class="pull-right text-right">
<small><em>Proudly powered by <a href="http://docs.getpelican.com/" target="_blank">pelican</a></em></small><br/>
<small><em><span class="sc">NEST</span> theme by <a href="https://github.com/molivier" target="_blank">molivier</a></em></small><br/>
<small>Copyright © 2020-2020 Sorbonne Universite</small>
</p>
</div>
</div>
</div>
</div>
<!-- /Footer -->
</body>
</html>