Go to file
Jean-Paul Chaput abf58190eb Anabatic transient commit 10. Ripup & reroute support in Dijsktra.
* New: In Anabatic:
    - In AnabaticEngine, keep track of overflowed edges.
    - In AnabaticEngine, getNetsFromedge() to lookup all nets going
      through an Edge.
    - In Configuration, read the Kite "reserved local" parameter to
      decrease the Edge capacity (it's a guessing of the cost of the
      local routing).
    - In Edge, add an attribute to know if there is an associated
      segment of the current net (set by Dijkstra::_traceback()).
      Transparently manage the overflowed edges.
    - In GCell_Edges, correct a filtering bug when not all sides are
      selecteds.
    - New GCell::getEdgeTo() to find the edge between two adjacent
      GCells.
    - New GCell::unrefContact() to automatically removes global contacts
      no longer used by any global segments (used during the ripup
      step).
    - In Dijkstra::load(), now able to "reload" and already partially
      or completly routed net (look for Contact of "gcontact" layer
      and their attached segments).
    - In Dijkstra, keep the last net loaded until the next one is.
      Put the cleanup operations in an isolated function "_cleanup()".
    - In Dijkstra::_selectFirstsource() and run(), load first source
      component made of multiple vertexes.
    - In Dijkstra::_trackback(), link the Net segments to the Edges.
    - New Dijkstra::ripup(), Dijkstra::_propagateRipup() to perform
      the ripup of one edge of a Net (must be loaded in Dijkstra first).
      Dijkstra::_tagConnecteds() setup the connexId of a set of Vertexes
    - that are connecteds through edges *with* segments.
    - In GraphicAnabaticengine & GlobalRoute.cpp, embryo of a global
      routing tool with ripup & reroute.
2016-06-26 14:32:32 +02:00
anabatic Anabatic transient commit 10. Ripup & reroute support in Dijsktra. 2016-06-26 14:32:32 +02:00
bootstrap Anabatic transient commit 8. More Dijkstra bugs correcteds. 2016-06-17 13:09:34 +02:00
coloquinte No more MCF_opt.cxx in Coloquinte. 2016-06-10 22:59:33 +02:00
crlcore Anabatic transient commit 8. More Dijkstra bugs correcteds. 2016-06-17 13:09:34 +02:00
cumulus In Stratus, in dpgen_RAM get cell height from the library. 2016-04-13 18:49:50 +02:00
documentation Argh. cdebug was slowing down the program too much. 2016-06-11 21:56:12 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Argh. cdebug was slowing down the program too much. 2016-06-11 21:56:12 +02:00
hurricane Merge branch 'devel' into devel_anabatic 2016-06-11 21:58:25 +02:00
ispd Starting to implement support for Windows/Cygwin. 2014-07-13 13:14:49 +02:00
katabatic Argh. cdebug was slowing down the program too much. 2016-06-11 21:56:12 +02:00
kite Argh. cdebug was slowing down the program too much. 2016-06-11 21:56:12 +02:00
knik Argh. cdebug was slowing down the program too much. 2016-06-11 21:56:12 +02:00
mauka Happy new year 2016! 2016-01-21 00:41:19 +01:00
metis Happy new year 2016! 2016-01-21 00:41:19 +01:00
nimbus Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
solstice Correct the garbled screen when shifting right in CellWidget. 2015-04-05 19:21:20 +02:00
stratus1 Make RF1 support different slice height. 2016-04-24 16:27:38 +02:00
unicorn Anabatic transient commit 8. More Dijkstra bugs correcteds. 2016-06-17 13:09:34 +02:00
vlsisapd OpenChams::SlicingTree: accessor "getSymmetries()" modified. 2016-05-26 17:59:18 +02:00
.dir-locals.el Better handling of exceptions between C++ & Python. Misc. checks. 2015-05-20 14:03:59 +02:00
.gitignore Better handling of exceptions between C++ & Python. Misc. checks. 2015-05-20 14:03:59 +02:00
.projectile Better handling of exceptions between C++ & Python. Misc. checks. 2015-05-20 14:03:59 +02:00
Makefile Implementation of DataBase native save/restore in JSON (step 2). 2016-01-21 00:25:39 +01:00
README.rst Update JsonReader for the latest RapidJSON. Doc rebuild. 2016-03-22 15:38:26 +01:00

README.rst

.. -*- Mode: rst -*-


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


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


Purpose
=======

Coriolis provides several tools to perform the layout of VLSI circuits.  Its
main components are the Hurricane database, the Etesian placer and the Kite
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 scriptables.


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

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

   ./documentation/UsersGuide/UsersGuide.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://soc-extras.lip6.fr/en/coriolis/coriolis2-users-guide/


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

To build Coriolis, ensure the following prerequisites are met:

* Python 2.7.
* 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/support
   ego@home:~$ cd ~/coriolis-2.x/src/support
   ego@home:~$ git clone http://github.com/miloyip/rapidjson
   ego@home:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd
   ego@home:~$ cd ~/coriolis-2.x/src
   ego@home:src$ git clone https://www-soc.lip6.fr/git/coriolis.git
   ego@home:src$ cd coriolis

If you want to use the *devel* branch: ::

    ego@home:coriolis$ git checkout devel

Then, build the tool: ::

    ego@home:coriolis$ make install

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 is tasked to guess it's location and setup appropriatly
the UNIX environment, then lauch ``cgt`` (or *any* command, with the
``--run=<COMMAND>`` option).

Conversely, you can setup the current shell environement 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