riscv
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1,485 Commits 18 Branches 8 Tags 96 MiB
PostScript 43.8%
C++ 27%
HTML 9.4%
TeX 6.6%
Python 5.3%
Other 7.5%
Go to file
Jean-Paul Chaput 6ad644fac2 New relation for slaved ABs. Do *not* delete blockage nets. 
* Change: In Hurricane, in DataBase::CellDepths() the recursion stop
    criterion must be Cell::isLeaf() and not Cell::isTerminal() as
    the second one can be used to hide some levels of hierarchy,
    and we want all of them in a blob.
* New: In Hurricane, in Cell, create a new Slaveds relation to keep
    track of all the Cells with a slaved abutment box. This work is
    incomplete as we do not manage the behavior in case of merge or
    Cell destruction or slaving Cells with aready slaveds ones.
      Modify Cell::setAbutmentBox() to work in both autonomous and
    slaved mode.
* New: In Hurricane, in Net, add a new type of Net: BLOCKAGE this
    avoid us to be dependant on the framework pattern recognition.
    (change propagated to the Python support)
* New: In CRL Core, in the various drivers, recognize blockage nets
    as such and set their type accordingly.
* Change: In CRL, in Toolbox::deleteEmptyNets(), preserve blockage
    Nets. This was the cause of crashs in Kite::BuildPowerRails() as
    we where trying to use a deleted blockage net...
* Bug: In Hurricane, in NetAlias, do not write NetAlias as a name
    but as a type. They were not read back and moreover staying in
    the JSON parser stack.
 		2016-03-30 17:47:00 +02:00
bootstrap Handling of Cell destruction in CellViewer. 2016-02-23 10:48:26 +01:00
coloquinte Improvements for Steiner trees 2015-05-06 16:09:50 +02:00
crlcore New relation for slaved ABs. Do *not* delete blockage nets. 2016-03-30 17:47:00 +02:00
cumulus New relation for slaved ABs. Do *not* delete blockage nets. 2016-03-30 17:47:00 +02:00
documentation Update JsonReader for the latest RapidJSON. Doc rebuild. 2016-03-22 15:38:26 +01:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Forgot to catch Bug exception. GCell manage 5 terminals of a Net. 2016-03-17 16:54:53 +01:00
hurricane New relation for slaved ABs. Do *not* delete blockage nets. 2016-03-30 17:47:00 +02:00
ispd Starting to implement support for Windows/Cygwin. 2014-07-13 13:14:49 +02:00
katabatic New relation for slaved ABs. Do *not* delete blockage nets. 2016-03-30 17:47:00 +02:00
kite New relation for slaved ABs. Do *not* delete blockage nets. 2016-03-30 17:47:00 +02:00
knik Update copyright to 2016 for Knik, Katabatic & Kite. 2016-03-06 12:36:18 +01: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 Happy new year 2016! 2016-01-21 00:41:19 +01:00
unicorn Forgot to catch Bug exception. GCell manage 5 terminals of a Net. 2016-03-17 16:54:53 +01:00
vlsisapd Update the socInstaller for the support repositories. 2016-02-21 11:58:54 +01: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