Go to file
Jean-Paul Chaput c53fc01cb2 Add Rectilinear & "cut" support to the extractor.
Note about the managment of VIA & cuts: Components using a layer which
  is a ViaLayer, that is one containing more than one BasicLayer,
  multiple tiles are created in QueryTiles::goCallback().
    Components that have a single BasicLayer of "cut" material will
  also have their multiples tiles created in QueryTiles::goCallback().
    Rectilinear components will have their multiples tiles created
  in Tile::create(). Tile::create() return not all the tiles but the
  one used as root (for the union find).

* New: In SweepLine::_buildCutConnexMap(), when using a "cut" layer
    in a standalone way, and not as part of a ViaLayer, we do not
    automatically know to which layer above & below they are connected.
      We build a table for each cut layer, based on the ViaLayer,
    to know all tops & belows layers they connect (this is cumulative,
    in the case of "cut" towards the substrate).
      Then in Tile::create(), we not only create the tile for the "cut"
    but also in thoses connected layers (and link them in the union
    find).
* New: In Tile::create(), when we encounter a Rectilinear, break it
    into rectangles and make as many tiles. All tiles linked to the
    same root in the union find.
* Bug: In Hurricane::Rectilinear, ambiguous specification of the set
    of points defining the shape. I did suppose that the start and and
    point where not the same the last edge being between them.
      But if FlexLib, it uses the GDSII inspired convention where the
    first and last point must be the same, to indicate a closed contour.
      This difference was not causing any difference with the drawing,
    but it was a problem for getAsRectangle(). This was creating a
    "false" extra vertical edge leading to a bigger rectangle.
    And this, in turn, was making "false" intersections in the
    tiling/sweepline of the extractor.
      Add a more thorough checking of the points vector.
2023-05-05 16:22:51 +02:00
Coriolis Use git tags to version releases 2023-02-21 16:10:55 +01:00
Seabreeze Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
anabatic Fix missing Python link libraries, more of them. 2023-03-09 18:39:48 +01:00
bootstrap Merge branch 'devel' of gitlab.lip6.fr:vlsi-eda/coriolis into tramontana 2023-04-13 14:05:48 +02:00
bora Rewrite backward compatibility for Qwt 5 (Qt4) for SlicingPlotWidget. 2023-03-13 16:51:16 +01:00
coloquinte Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
crlcore Add a verbose option to ToolEngine, don't always display infos. 2023-03-28 16:06:49 +02:00
cumulus Reduce the default pixel threshold to 5. 2023-03-26 21:12:49 +02:00
deprecated Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
documentation Use smaller font for code block in documentation (nest.css). 2023-03-13 16:45:42 +01:00
equinox Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
etesian Transhierarchical/flat extraction work, no netlist rebuild yet. 2023-04-02 23:02:46 +02:00
flute Fix missing Python link libraries, more of them. 2023-03-09 18:39:48 +01:00
foehn Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
hurricane Add Rectilinear & "cut" support to the extractor. 2023-05-05 16:22:51 +02:00
ispd Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
karakaze Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
katana Fix missing Python link libraries, more of them. 2023-03-09 18:39:48 +01:00
lefdef Fix missing libraries problems (seen on Cygwin). 2023-03-07 17:29:40 +01:00
nix install helpers at top level 2023-02-21 16:10:55 +01:00
oroshi Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
solstice Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
stratus1 Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
tramontana Add Rectilinear & "cut" support to the extractor. 2023-05-05 16:22:51 +02:00
tutorial Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
unicorn Removing Solstice & Equinox from Unicorn (forgotten bits). 2023-03-18 18:12:24 +01:00
unittests Add Rectilinear & "cut" support to the extractor. 2023-05-05 16:22:51 +02:00
.gitignore Ignore /result (from nix-build) 2021-10-26 22:30:33 +00:00
.gitlab-ci.yml Upload wheels in CI 2023-02-21 16:10:55 +01:00
COPYRIGHT.rst At last setup a COPYRIGHT.rst and LICENSE.rst files. 2021-10-29 15:03:03 +02:00
LICENSE.rst At last setup a COPYRIGHT.rst and LICENSE.rst files. 2021-10-29 15:03:03 +02:00
Makefile Enabling the user to choose the devtoolset it needs. 2019-03-04 14:20:13 +01:00
README.rst Remove old steps from the installation 2023-04-04 16:20:29 +02:00
SUPPORT.rst Add SUPPORT.rst file 2021-12-09 22:32:02 +01:00
builder.py Don't package docs in the wheel 2023-02-21 16:10:55 +01:00
compat.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
default.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
flake.lock nix: Update dependencies 2021-10-26 20:17:17 +00:00
flake.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
poetry.lock Use ninja for build 2023-02-21 16:10:55 +01:00
pyproject.toml Add pattern back in for git tag versioning 2023-02-21 16:10:55 +01:00
shell.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00

README.rst

.. -*- Mode: rst -*-


===============
Coriolis README
===============

Coriolis is a free database, placement tool and routing tool for VLSI design.


Purpose
=======

Coriolis provides several tools to perform the layout of VLSI circuits.  Its
main components are the Hurricane database, the Etesian placer and the Katana
router, but other tools can use the Hurricane database and the parsers
provided.

The user interface <cgt> is the prefered way to use Coriolis, but all
Coriolis tools are Python modules and thus scriptable.


Documentation
=============

The complete documentation is available here, both in pdf & html:

   ./documentation/output/html
   ./documentation/UsersGuide/UsersGuide.pdf

The documentation of the latest *stable* version is also
available online. It may be quite outdated from the *devel*
version.

    https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/latex/users-guide/UsersGuide.pdf


Building Coriolis
=================

To build Coriolis, ensure the following prerequisites are met:

* Python 3,
* cmake,
* boost,
* bison & flex,
* Qt 4 or 5,
* libxml2,
* RapidJSON,
* A C++11 compliant compiler.

The build system relies on a fixed directory tree from the root
of the user currently building it. Thus first step is to get a clone of
the repository in the right place. Proceed as follow: ::

   ego@home:~$ mkdir -p ~/coriolis-2.x/src/
   ego@home:~$ cd ~/coriolis-2.x/src
   ego@home:src$ git clone https://gitlab.lip6.fr/vlsi-eda/coriolis.git
   ego@home:src$ cd coriolis

Then, build the tool: ::

    ego@home:coriolis$ make install

If you encounter issues, please consult SUPPORT.rst for tips.
Coriolis gets installed at the root of the following tree: ::

    ~/coriolis-2.x/<OS>.<DISTRIB>/Release.Shared/install/

Where ``<OS>`` is the name of your operating system and ``<DISTRIB>`` your
distribution.


Using Coriolis
==============

The Coriolis main interface can be launched with the command: ::

    ego@home:~: ~/coriolis-2.x/<OS>.<DISTRIB>/Release.Shared/install/bin/coriolis

The ``coriolis`` script detects its location and setups the UNIX
environment appropriately, then lauches ``cgt`` (or *any* command, with the
``--run=<COMMAND>`` option).

Conversely, you can setup the current shell environment for Coriolis by
using the helper ``coriolisEnv.py``, then run any Coriolis tool: ::

    ego@home:~$ eval `~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`
    ego@home:~$ cgt -V