Go to file
Jean-Paul Chaput 80dcd264bb Allow nearest Track selection in Katana::RoutingPlane::getTrackByPosition().
* Change: In Katana::RoutingPlane::getTrackByPosition(), when requesting a
    track less than *one pitch* beyond the last one, return the last one
    instead of NULL. Only if the mode allows it (i.e. Nearest or Inferior).
2018-04-13 15:06:15 +02:00
anabatic Correct rounding of GCell horizontal size in GCell::doGrid(). 2018-04-13 15:00:13 +02:00
bootstrap Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
coloquinte Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
crlcore Correct interval capacity computation around zero in RoutingLayerGauge. 2018-04-13 14:59:40 +02:00
cumulus Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
documentation Added first suppport for Polygons (Triangles). 2018-03-20 11:49:04 +01:00
equinox Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
etesian Working aspect ratio and feed cell loading in Etesian. 2018-01-10 17:46:11 +01:00
hurricane More non-deterministics behavior corrections. 2018-04-08 16:58:55 +02:00
ispd Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
katabatic Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
katana Allow nearest Track selection in Katana::RoutingPlane::getTrackByPosition(). 2018-04-13 15:06:15 +02:00
kite Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
knik Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
lefdef Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
mauka Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
metis Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
nimbus Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
solstice Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
stratus1 Validating channel routing mode (two metals) on SNX. 2018-03-16 16:20:04 +01:00
tutorial Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
unicorn Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
vlsisapd Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
.gitignore Update documentation to build on Debian 9.2 (stretch). 2017-10-30 15:33:37 +01:00
Makefile Implementation of DataBase native save/restore in JSON (step 2). 2016-01-21 00:25:39 +01:00
README.rst Complete hoverhaul of the documentation to Sphinx. 2017-07-15 17:35:02 +02: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/_build/html/index.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