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

Fix header character usage - crashes with newer docutils

This commit is contained in:
Rob Taylor 2023-11-17 19:28:22 +00:00 committed by Rob Taylor
parent 6ff5cf3e3c
commit 82af38216d
5 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/content/pages/users-guide/Configuration.rst
View File

@ -18,7 +18,7 @@ Coriolis Configuration & Initialisation
General Software Architecture General Software Architecture
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|Coriolis| has been built with respect of the classical paradigm that the |Coriolis| has been built with respect of the classical paradigm that the
computational intensive parts have been written in C++, and almost computational intensive parts have been written in C++, and almost
@ -40,7 +40,7 @@ two methods:
Configuration & User's Settings Configuration & User's Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All configurations files are shipped under the form of |Python| modules. All configurations files are shipped under the form of |Python| modules.
They are to be loaded through ``import`` statements. The user's configuration They are to be loaded through ``import`` statements. The user's configuration
@ -84,7 +84,7 @@ For example, to use |MOSIS| 180nm, you can put in your :cb:`./coriolis2/setting.
A Comprehensive Example of :cb:`./coriolis2/setting.py` A Comprehensive Example of :cb:`./coriolis2/setting.py`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python .. code-block:: python

9
documentation/content/pages/users-guide/Installation.rst
View File

@ -8,6 +8,7 @@ We reccomend installing directly from Pypi <https://pypi.org/>`_. First install
.. code-block:: bash .. code-block:: bash
pip3 install coriolis-eda pip3 install coriolis-eda
@ -129,7 +130,7 @@ Then proceed with the generic install instructions.
|Coriolis| & Docker |Coriolis| & Docker
~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^
Under ``bootstrap/docker/`` scripts and configuration files are provided that Under ``bootstrap/docker/`` scripts and configuration files are provided that
allow to rebuild |Alliance| and |Coriolis| and perform the regression tests allow to rebuild |Alliance| and |Coriolis| and perform the regression tests
@ -149,7 +150,7 @@ arguments:
Packaging Coriolis Packaging Coriolis
~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^
Packager should not use |ccb|, instead ``bootstrap/Makefile.package`` is provided Packager should not use |ccb|, instead ``bootstrap/Makefile.package`` is provided
to emulate a top-level ``autotool`` makefile. Just copy it in the root of the to emulate a top-level ``autotool`` makefile. Just copy it in the root of the
@ -162,7 +163,7 @@ Sligthly outdated packaging configuration files can also be found under ``bootst
Hooking up into |Alliance| Hooking up into |Alliance|
~~~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^^^
|Coriolis| relies on |Alliance| for the cell libraries. So after installing or |Coriolis| relies on |Alliance| for the cell libraries. So after installing or
packaging, you must configure it so that it can found those libraries. packaging, you must configure it so that it can found those libraries.
@ -174,7 +175,7 @@ have look to the `Alliance Helper`.
Setting up the Environment (coriolisEnv.py) Setting up the Environment (coriolisEnv.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To simplify the tedious task of configuring your environment, a helper is provided To simplify the tedious task of configuring your environment, a helper is provided
in the ``bootstrap`` source directory (also installed in the directory in the ``bootstrap`` source directory (also installed in the directory

14
documentation/content/pages/users-guide/Releases.rst
View File

@ -5,7 +5,7 @@ Release Notes
============= =============
Release 1.0.1475 Release 1.0.1475
~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^
This is the first preliminary release of the |Coriolis2| framework. This is the first preliminary release of the |Coriolis2| framework.
@ -32,7 +32,7 @@ will be avalaible later.
Release 1.0.1963 Release 1.0.1963
~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^
Release 1963 is alpha. All the tools from |Coriolis1| have been ported into Release 1963 is alpha. All the tools from |Coriolis1| have been ported into
this release. this release.
@ -50,7 +50,7 @@ this release.
Release 1.0.2049 Release 1.0.2049
~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^
Release `2049` is Alpha. Release `2049` is Alpha.
@ -66,7 +66,7 @@ Release `2049` is Alpha.
Release v2.0.1 Release v2.0.1
~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^
#. Migrated the repository from |svn| to |git|, and release complete sources. #. Migrated the repository from |svn| to |git|, and release complete sources.
As a consequence, we drop the distribution packaging support and give As a consequence, we drop the distribution packaging support and give
@ -76,7 +76,7 @@ Release v2.0.1
Release v2.1 Release v2.1
~~~~~~~~~~~~ ^^^^^^^^^^^^
#. Replace the old simulated annealing placer |Mauka| by the analytical placer #. Replace the old simulated annealing placer |Mauka| by the analytical placer
|Etesian| and its legalization and detailed placement tools. |Etesian| and its legalization and detailed placement tools.
@ -93,7 +93,7 @@ Release v2.1
Release v2.2 Release v2.2
~~~~~~~~~~~~ ^^^^^^^^^^^^
#. Added JSON import/export of the whole Hurricane DataBase. Two save mode #. Added JSON import/export of the whole Hurricane DataBase. Two save mode
are supported: *Cell* mode (standalone) or *Blob* mode, which dump the are supported: *Cell* mode (standalone) or *Blob* mode, which dump the
@ -101,7 +101,7 @@ Release v2.2
Release v2.3 Release v2.3
~~~~~~~~~~~~ ^^^^^^^^^^^^
#. Reverts to a more standard organisation of the branches. **devel_anabatic** is #. Reverts to a more standard organisation of the branches. **devel_anabatic** is
closed and we go on with **master** (stable version) and **devel**. closed and we go on with **master** (stable version) and **devel**.

4
documentation/content/pages/users-guide/ScriptsPlugins.rst
View File

@ -91,7 +91,7 @@ This typical script can be executed in two ways:
Plugins Plugins
~~~~~~~ ^^^^^^^
Plugins are |Python| scripts specially crafted to integrate with |cgt|. Plugins are |Python| scripts specially crafted to integrate with |cgt|.
Their entry point is a :cb:`scriptMain()` method as described in Their entry point is a :cb:`scriptMain()` method as described in
@ -302,7 +302,7 @@ by the clock tree plugin after the netlist clock sub-nets creation.
A Simple Example: AM2901 A Simple Example: AM2901
~~~~~~~~~~~~~~~~~~~~~~~~ ^^^^^^^^^^^^^^^^^^^^^^^^
To illustrate the capabilities of |Coriolis| tools and |Python| scripting, a small To illustrate the capabilities of |Coriolis| tools and |Python| scripting, a small
example, derived from the |Alliance| :cb:`AM2901` is supplied. example, derived from the |Alliance| :cb:`AM2901` is supplied.

43
documentation/content/pages/users-guide/ViewerTools.rst
View File

@ -4,6 +4,9 @@
CGT - The Graphical Interface CGT - The Graphical Interface
============================= =============================
Overview
--------
The |Coriolis| graphical interface is split up into two windows. The |Coriolis| graphical interface is split up into two windows.
* The **Viewer**, with the following features: * The **Viewer**, with the following features:
@ -35,10 +38,10 @@ Features are detailed in `Viewer & Tools`_.
.. _Viewer & Tools: .. _Viewer & Tools:
Viewer & Tools Viewer & Tools
~~~~~~~~~~~~~~ --------------
|Stratus| Netlist Capture |Stratus| Netlist Capture
------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^
|Stratus| is the replacement for |GenLib| procedural netlist capture language. |Stratus| is the replacement for |GenLib| procedural netlist capture language.
It is designed as a set of |Python| classes, and comes with it's own documentation It is designed as a set of |Python| classes, and comes with it's own documentation
@ -46,7 +49,7 @@ It is designed as a set of |Python| classes, and comes with it's own documentati
The |Hurricane| Data-Base The |Hurricane| Data-Base
------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^
The |Alliance| flow is based on the |MBK| data-base, which has one data-structure The |Alliance| flow is based on the |MBK| data-base, which has one data-structure
for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical* for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical*
@ -77,7 +80,7 @@ As for the second release, |Coriolis| can be used only for three purposes :
Synthetizing and loading a design Synthetizing and loading a design
--------------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|Coriolis| supports several file formats. It can load all file format |Coriolis| supports several file formats. It can load all file format
from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst),
@ -106,7 +109,7 @@ and write Alliance designs and libraries directly.
Etesian -- Placer Etesian -- Placer
----------------- ^^^^^^^^^^^^^^^^^
The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is
within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace. within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace.
@ -206,7 +209,7 @@ Etesian Configuration Parameters
Katana -- Global Router Katana -- Global Router
----------------------- ^^^^^^^^^^^^^^^^^^^^^^^
The quality of |Katana| global routing solutions are equivalent to those of FGR_ 1.0. The quality of |Katana| global routing solutions are equivalent to those of FGR_ 1.0.
For an in-depth description of |Katana| algorithms, you may download the thesis of For an in-depth description of |Katana| algorithms, you may download the thesis of
@ -217,7 +220,7 @@ The global router is now deterministic.
Katana -- Detailed Router Katana -- Detailed Router
------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^
|Katana| no longer suffers from the limitations of |Nero|. It can route big designs |Katana| no longer suffers from the limitations of |Nero|. It can route big designs
as its runtime and memory footprint is almost linear (with respect to the number as its runtime and memory footprint is almost linear (with respect to the number
@ -363,7 +366,7 @@ All the defaults value given below are from the default |Alliance| technology
.. _Python Scripts in Cgt: .. _Python Scripts in Cgt:
Executing Python Scripts in Cgt Executing Python Scripts in Cgt
------------------------------- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Python/Stratus scripts can be executed either in text or graphical mode. Python/Stratus scripts can be executed either in text or graphical mode.
@ -386,7 +389,7 @@ For more explanation on Python scripts see `Python Interface to Coriolis`.
Printing & Snapshots Printing & Snapshots
-------------------- ^^^^^^^^^^^^^^^^^^^^
Printing or saving into a |pdf| is fairly simple, just use the **File -> Print** Printing or saving into a |pdf| is fairly simple, just use the **File -> Print**
menu or the |CTRL_P| shortcut to open the dialog box. menu or the |CTRL_P| shortcut to open the dialog box.
@ -419,7 +422,7 @@ Saving into an image is subject to the same remarks as for |pdf|.
Memento of Shortcuts in Graphic Mode Memento of Shortcuts in Graphic Mode
------------------------------------ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The main application binary is |cgt|. The main application binary is |cgt|.
@ -501,7 +504,7 @@ The main application binary is |cgt|.
Cgt Command Line Options Cgt Command Line Options
------------------------ ^^^^^^^^^^^^^^^^^^^^^^^^
Appart from the obvious ``--text`` options, all can be used for text and graphical mode. Appart from the obvious ``--text`` options, all can be used for text and graphical mode.
@ -553,7 +556,7 @@ Some Examples :
Miscellaneous Settings Miscellaneous Settings
---------------------- ^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------+------------------+----------------------------+ +---------------------------------------+------------------+----------------------------+
| Parameter Identifier | Type | Default | | Parameter Identifier | Type | Default |
@ -606,7 +609,7 @@ Miscellaneous Settings
.. _The Controller: .. _The Controller:
The Controller The Controller
~~~~~~~~~~~~~~ --------------
The *Controller* window is composed of seven tabs: The *Controller* window is composed of seven tabs:
@ -625,7 +628,7 @@ The *Controller* window is composed of seven tabs:
.. _The Look Tab: .. _The Look Tab:
The Look Tab The Look Tab
------------ ^^^^^^^^^^^^
You can select how the layout will be displayed. There is a special one You can select how the layout will be displayed. There is a special one
``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_. ``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_.
@ -639,7 +642,7 @@ You should select it prior to calling the print or snapshot dialog boxes.
.. _The Filter Tab: .. _The Filter Tab:
The Filter Tab The Filter Tab
-------------- ^^^^^^^^^^^^^^
The filter tab let you select what hierarchical levels of your design will be The filter tab let you select what hierarchical levels of your design will be
displayed. Hierarchy level are numbered top-down: the level 0 corresponds to displayed. Hierarchy level are numbered top-down: the level 0 corresponds to
@ -670,7 +673,7 @@ unit used to display coordinates.
.. _The Layers&Go Tab: .. _The Layers&Go Tab:
The Layers&Go Tab The Layers&Go Tab
----------------- ^^^^^^^^^^^^^^^^^
Control the individual display of all *layers* and *Gos*. Control the individual display of all *layers* and *Gos*.
@ -692,7 +695,7 @@ For each layer/Go there are two check boxes:
.. _The Netlist Tab: .. _The Netlist Tab:
The Netlist Tab The Netlist Tab
--------------- ^^^^^^^^^^^^^^^
The *Netlist* tab shows the list of nets... By default the tab is not The *Netlist* tab shows the list of nets... By default the tab is not
*synched* with the displayed Cell. To see the nets you must check the *synched* with the displayed Cell. To see the nets you must check the
@ -711,7 +714,7 @@ is highlighted in the *Viewer*.
.. _The Selection Tab: .. _The Selection Tab:
The Selection Tab The Selection Tab
----------------- ^^^^^^^^^^^^^^^^^
The *Selection* tab lists all the components currently selected. They The *Selection* tab lists all the components currently selected. They
can be filtered thanks to the filter pattern. can be filtered thanks to the filter pattern.
@ -731,7 +734,7 @@ the ``t`` key...
.. _The Inspector Tab: .. _The Inspector Tab:
The Inspector Tab The Inspector Tab
----------------- ^^^^^^^^^^^^^^^^^
This tab is very useful, but mostly for |Coriolis| developpers. It allows This tab is very useful, but mostly for |Coriolis| developpers. It allows
to browse through the live DataBase. The *Inspector* provides three entry points: to browse through the live DataBase. The *Inspector* provides three entry points:
@ -758,7 +761,7 @@ its fields using the right/left arrows.
.. _The Settings Tab: .. _The Settings Tab:
The Settings Tab The Settings Tab
---------------- ^^^^^^^^^^^^^^^^
Here comes the description of the *Settings* tab. Here comes the description of the *Settings* tab.