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

126 lines
3.2 KiB
ReStructuredText
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
.. -*- Mode: rst -*-
=============
Documentation
=============
:slug: documentation
:date: 2020-01-01 23:00
:author: Jean-Paul Chaput
:Contact: <Jean-Paul.Chaput@lip6.fr>
:Version: Jan 1, 2020 (jpc)
:status: hidden
.. include:: ../../etc/definitions.rst
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
Alliance Documentation
======================
.. row::
.. column::
:width: 5
:offset: 1
`Alliance Installation <{filename}/pages/alliance/Alliance_HTML.rst>`_ |br|
How to get, build & install Alliance alongside Coriolis
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
.. column::
:width: 5
.. 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
`Alliance Check Toolkit <{filename}/pages/check-toolkit/CheckToolkit_HTML.rst>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Regression tests & examples
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
Coriolis Documentation
======================
.. row::
.. column::
:width: 5
:offset: 1
`Coriolis User's Guide <{filename}/pages/users-guide/UsersGuide_HTML.rst>`_ |br|
Using the software
`Python Tutorial <{filename}/pages/python-tutorial/PythonTutorial_HTML.rst>`_ |br|
A Tutorial to use Coriolis through Python
`Python/C++ Tutorial <{filename}/pages/python-cpp/PythonCpp_HTML.rst>`_ |br|
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 |API| (C-macros version)
`Python/C++ Tutorial (template) <{filename}/pages/python-cpp-new/PythonCppNew_HTML.rst>`_ |br|
A Tutorial to the Python/C++ interface |API| (C++ template version)
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
`Stratus Language <{filename}/pages/stratus/Stratus_HTML.rst>`_ |br|
A Netlist Capture Language (on top of Python)
`DpGen Extension (Stratus) <{filename}/pages/stratus/DpGen_HTML.rst>`_ |br|
Netlist Capture extension for Datapathes
`Pattern Extension (Stratus) <{filename}/pages/stratus/Patterns_HTML.rst>`_ |br|
Patterns generation extension
`RDS documentation <{filename}/pages/rds/RDS_HTML.rst>`_ |br|
Translating symbolic layout to |GDS|.
.. column::
:width: 5
.. row::
`Hurricane Reference <../doc/hurricane/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
|Hurricane| Netlist & Physical structure C++ |API|
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
`Viewer Reference <../doc/viewer/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Graphical interface C++ |API|
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
`CRL Core Reference <../doc/crlcore/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Parsers/Drivers and I/O C++ |API|
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
`Unicorn Reference <../doc/unicorn/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Main GUI C++ |API|
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
`Katabatic Reference <../doc/katabatic/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Articulated Segments Data-Structure
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
`Kite Reference <../doc/kite/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Digital router
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
`Hurricane/Analog Reference <../doc/analog/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
About digital design
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
`Oroshi Reference <../doc/oroshi/index.html>`_ |br|
Full update of the generated documentation.
2020-04-27 07:14:03 -05:00
Analog devices generators
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
Third Party Documentation
=========================
.. row::
.. column::
:width: 5
:offset: 1
`LEF/DEF Language Reference <../doc/lefdef/lefdefref/lefdefrefTOC.html>`_ |br|
Cadence LEF/DEF 5.8 language reference
.. column::
:width: 5
`LEF C++ API <../doc/lefdef/lefapi/ch1Intro.html>`_ |br|
Cadence Documentation of LEF 5.8 C++ API
`DEF C++ API <../doc/lefdef/defapi/ch1Intro.html>`_ |br|
Cadence Documentation of DEF 5.8 C++ API