Go to file
Jean-Paul Chaput 91f973c00f Improve the management of the I/O pad near the chip corner.
* Bug: In cumulus/plugins/PadsCorona.py, when a pad is at the beginning
    or at the end of the side, the pad corona terminal may be outside
    the corona range (not directly facing it). In that case, create a
    bend to reach it.
      Worse, in some case more than one (but likely no more), could be
    in that case, so not only do we create a bend but also make a
    shift in the bended segment so two consecutive ones are not on the
    same axis, causing shorts.
      If both end pads of a corner are in that case, we cannot prevent
    a short, so at least, issue a warning.
* Bug: In CRL::Vhdl, the Entity::VstUseConcat was not passed correctly
    along, so we did get a strange mix of conat and direct assignment.
* New: In Unicorn/cgt.py : added --vst-use-concat options to control
    the VST driver behavior.
2019-08-16 00:40:49 +02:00
anabatic Do not slacken segments which source/target in a "go straight" GCell. 2019-08-12 01:01:29 +02:00
bootstrap Adapt socInstaller to the new SL7 & benchmarks. 2019-05-26 15:41:24 +02:00
bora Make FLUTE an independant tool in the Coriolis git repository. 2019-02-12 12:48:52 +01:00
coloquinte Pin management implemented for NetBuilderHV. 2019-03-10 13:25:43 +01:00
crlcore Improve the management of the I/O pad near the chip corner. 2019-08-16 00:40:49 +02:00
cumulus Improve the management of the I/O pad near the chip corner. 2019-08-16 00:40:49 +02:00
documentation Typos corrigees dans Hurricane et Python Tutorial 2019-06-04 14:34:20 +02:00
equinox Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
etesian Support for placing *one* block of a Cell in Etesian. 2019-08-04 17:33:03 +02:00
flute Patch flute to be compatible with boost 1.65. 2019-03-04 12:34:43 +01:00
hurricane ioNet used as "enable" should not get the name of the pad. 2019-08-09 18:45:19 +02:00
ispd Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
karakaze Support for mixing real pads & symbolic core. Wrapper around s2r. 2019-05-22 14:34:32 +02:00
katabatic Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
katana Support for placing *one* block of a Cell in Etesian. 2019-08-04 17:33:03 +02:00
kite Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
knik Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
lefdef Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02: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 Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
oroshi Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
solstice Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
stratus1 Various bug corrections to pass the alliance-check-toolkit reference benchs. 2019-05-24 23:57:22 +02:00
tutorial Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
unicorn Improve the management of the I/O pad near the chip corner. 2019-08-16 00:40:49 +02:00
unittests Compatiblilty with boost 1.57 on RedHat 6. 2019-03-11 16:01:11 +01:00
vlsisapd Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +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 Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02: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/_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://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