riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
2,323 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 b1bc22f8e7 Bad computation of minimal area of stacked VIAs in Cumulus. 
* Bug: In cumulus/plugins.block.configuration.GaugeConf.expandMinArea(),
    The minimal length of the segment intermediate wires where computed
    for the minimal area using an integer division ( // ), which is
    stupid for less than 1.0 values. They are real quantities at this
    point...
      This was making the DRC of ls180 failing.
 		2021-10-07 00:39:24 +02:00
anabatic Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
bootstrap Added "--shell=<SHELL>" option to coriolisEnv.py. 2021-10-02 14:02:03 +02:00
bora Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
coloquinte Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
crlcore Forgotten debug message in SubNetNames::match(). 2021-10-02 00:25:52 +02:00
cumulus Bad computation of minimal area of stacked VIAs in Cumulus. 2021-10-07 00:39:24 +02:00
documentation Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
equinox Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
etesian Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
flute Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
hurricane Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
ispd Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
karakaze Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
katabatic Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
katana In GraphicKatanaEngine, restore normal display of edges occupancy. 2021-10-07 00:32:14 +02:00
kite Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
knik Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
lefdef Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
mauka Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
metis Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
nimbus Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
oroshi Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
solstice Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
stratus1 Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
tutorial Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
unicorn Regenerated whole doc (by mistake)... 2021-10-01 21:36:45 +02:00
unittests Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
vlsisapd Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
.gitignore Various bug corrections to pass the alliance-check-toolkit reference benchs. 2019-05-24 23:57:22 +02:00
Makefile Enabling the user to choose the devtoolset it needs. 2019-03-04 14:20:13 +01:00
README.rst Update doc link for the new Pelican generated one. 2020-02-10 13:38:06 +01:00

README.rst 

.. -*- Mode: rst -*-


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

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


Purpose
=======

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


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

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

   ./documentation/output/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://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/latex/users-guide/UsersGuide.pdf


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 detects its location and setups the UNIX
environment appropriately, then lauches ``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