Go to file
Jean-Paul Chaput bff9a38742 Forgot to perform Track re-order after removing zero-length segments.
* Change: In Anabatic::Autocontact, replace getMinDepth() and
    getMaxDepth() by getDepthSpan().
* New: In Anabatic::AutoSegment::canMoveUp(), add an optional check of
    low up density (Flags::CheckLowUpDensity). Allows to move up a
    segment if the up density is (very) low, and in this case it's more
    efficient than breaking it to fit in the lower layer.
      canMoveUp() is now able to perform the same work as canPivotUp()
    if *not* supplied the flag Flags::IgnoreContacts.
* New: In Katana, in GlobalRouting::DigitalDistance() now take into
    account the cost of a VIA (currently set to 2.5). Need to known the
    Net currently routed in the DigitalDistance object itself.
* Change: In Katana::Track::Element::canPivotUp(), now also takes a flag
    parameter.
* Change: In Katana::Manipulator, new flag IgnoreContacts to mirror the
    one of Anabatic.
* Change: In Katana::SegmentFsm, allocate once a Manipulator object instead
    of many times on the fly.
      In SegmentFsm::_slackenGlobal(), in the slacken state, if the up
    density is (very) low, bypass to move up instead of slackening.
    This solve better the routing of the control part of the register file.
    The register file having a pathological case of terminal placement:
    many punctual terminals aligneds in METAL2 *and* a grid of METAL2 and
    METAL3 blockages near below...
* Bug: In Katana::Session::_revalidate(), after removing the zero-length
    segments, forgot to re-order the track, leading to many stranges effects
    as the indexes where no longer coherent in the Track.
2016-09-20 11:30:45 +02:00
anabatic Forgot to perform Track re-order after removing zero-length segments. 2016-09-20 11:30:45 +02:00
bootstrap Anabatic transient commit 18. Port of Kite (Katana), Yeah, Baby! Yeah! 2016-08-15 16:30:13 +02:00
coloquinte Compatibility with clang 7.3 and MacOSX 10.11 2016-07-20 15:21:50 +02:00
crlcore Enable the display of GCells as a density map (and not boundaries). 2016-09-10 18:49:48 +02:00
cumulus Added missing UpdateSession in Stratus & Plugins. 2016-09-11 13:20:05 +02:00
documentation Anabatic transient commit 18. Port of Kite (Katana), Yeah, Baby! Yeah! 2016-08-15 16:30:13 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Some psychotic correction in alignement of displayed messages. 2016-08-27 16:03:15 +02:00
hurricane Show backtrace when catching a C++ exception through Python. 2016-09-12 23:29:35 +02:00
ispd Starting to implement support for Windows/Cygwin. 2014-07-13 13:14:49 +02:00
katabatic Forgot to perform Track re-order after removing zero-length segments. 2016-09-20 11:30:45 +02:00
katana Forgot to perform Track re-order after removing zero-length segments. 2016-09-20 11:30:45 +02:00
kite Solve the template lookup problem in tstream. 2016-07-19 16:02:55 +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 Added missing UpdateSession in Stratus & Plugins. 2016-09-11 13:20:05 +02:00
unicorn Remove GraphicAnabaticengine, temporarily made for debugging. 2016-09-07 11:21:36 +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