coriolis/documentation/content/pages/documentation.rst

123 lines
3.0 KiB
ReStructuredText

.. -*- 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
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
.. column::
:width: 5
.. row::
`Alliance Check Toolkit`_ |br|
Regression tests & examples
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|
A Tutorial to the Python/C++ interface |API|
`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|
|Hurricane| Netlist & Physical structure C++ |API|
`Viewer Reference <../doc/viewer/index.html>`_ |br|
Graphical interface C++ |API|
`CRL Core Reference <../doc/crlcore/index.html>`_ |br|
Parsers/Drivers and I/O C++ |API|
`Unicorn Reference <../doc/unicorn/index.html>`_ |br|
Main GUI C++ |API|
`Katabatic Reference <../doc/katabatic/index.html>`_ |br|
Articulated Segments Data-Structure
`Kite Reference <../doc/kite/index.html>`_ |br|
Digital router
`Hurricane/Analog Reference <../doc/analog/index.html>`_ |br|
About digital design
`Oroshi Reference <../doc/oroshi/index.html>`_ |br|
Analog devices generators
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