Go to file
Jean-Paul Chaput 8a73b03fd8 Synchronize priority of TrackSegments connecteds through doglegs.
* Bug: In Anabatic::Dijsktra, correct the indentation in cdebug calls
    (lots of them causing a big shift right).
* New: In Anabatic::TrackSegment, new helper structure SideStack to
    manage a set of aligned GCells and their various sides sizes.
* Change: In Anabatic::TrackSegment::computeOptimal(), more accurate
    computation of attractors from global segments and variable size
    GCells using SideStack.
* Change: In Katana::DataSymmetric::checkPairing(), increase the tolerance
    for misaligned symmetrics from 2 to 5 tracks (should be enough for our
    narrow channel routing).
* New: In Katana::TrackSegment, add a first flag to enable locking of
    priority. If it is set, calls to either "computePriority()" or
    "forcePriority()" will have no effect. Added the uint32_t flags
    paraphernalia.
* New: In ::computeNetPriority(), overall function to control the call
    of TrackSegment::computeAlignedPriority(). The call is done from
    NegociateWindow::run().
* New: Katana::TrackSegment::computeAlignedPriority(), order the
    TrackSegments aligneds through doglegs to the one with the highest
    priority is routed first and others progressively from him. Done by
    forcing an ever decreasing priority on the aligneds ones.
      The amount of decrease is small so the aligned segments got routed
    (ordered) in close, if not contiguous, sequence. Priority is locked
    for the order to remain.
* Bug: In Katana::TrackSegment::computePriority(), correct computation
    of the priority when there is more than 10 free tracks
    (a DbU::toLambda() call was missing, leading to very big priorities).
* Change: In katana::TrackCost CTOR, do not compute a distance to fixed
    in the case of analog segments, this is backfiring.
      Slight change of the compare function when delta differs. Seems
    to improve a little.
2017-05-30 22:33:06 +02:00
anabatic Synchronize priority of TrackSegments connecteds through doglegs. 2017-05-30 22:33:06 +02:00
bootstrap Remove ‘-‘ from zsh shell on MacOS 2017-05-05 12:01:26 +02:00
coloquinte In Etesian, check for unplaced intermediate models with AB. 2016-12-02 16:59:32 +01:00
crlcore Rename SymmetricStage into PairSymmetrics, plus small cleanup. 2017-05-26 13:32:30 +02:00
cumulus Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
documentation Rename SymmetricStage into PairSymmetrics, plus small cleanup. 2017-05-26 13:32:30 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
hurricane Katana routing algorithm adjustements for analog routing. 2017-05-23 00:20:31 +02:00
ispd Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
katabatic Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
katana Synchronize priority of TrackSegments connecteds through doglegs. 2017-05-30 22:33:06 +02:00
kite Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
knik Accurate measuring of memory usage under Linux. 2017-02-25 18:21:55 +01:00
mauka Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
metis Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
nimbus Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
solstice Correct the garbled screen when shifting right in CellWidget. 2015-04-05 19:21:20 +02:00
stratus1 Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
unicorn Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +02:00
vlsisapd Adjust Katana event sort. CMake detection of Python 2.7 only. 2017-05-11 17:26:56 +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