riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,439 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 fcb4acadad Improvements & bugs corrections in the LEF/DEF importer/exporter. 
* Bug: In Hurricane, In NetAlias::removeAlias(), perform the isMaster()
    check on the *current* hook, not the *this* one... Was preventing the
    removal of most aliases.
* New: In CRL Core, in DefExport, perform a virtual flatten before exporting
    a design. Replace the hard-wired "sxlib" gauge by the current default
    one. More secure management of flattened instance and net names (removal
    of all potentially special characters). In net names, correct management
    of vectorized names (do not systematically add "_net" at the end).
      In DefImport, manage the BUSBITS property and revectorize accordingly
    the net names. When loading nets, systematically remove the alias of
    the temporary net "__prebuild__" (a bug in NetAlias was preventing it).
      In LefExport, the right value of MANUFACTURINGGRID in pseudo symbolic
    mode is 0.5 (expressed in lamba). That way all length are even multiples
    of it. Note that there is still the order bug of the 5.7 drivers that
    puts that entry *before* UNITS in the LEF file (bad bad Cadence).
 		2015-06-18 15:12:01 +02:00
bootstrap Partial rewrite of socInstaller.py to be more object-oriented. 2015-06-18 14:54:45 +02:00
coloquinte Improvements for Steiner trees 2015-05-06 16:09:50 +02:00
crlcore Improvements & bugs corrections in the LEF/DEF importer/exporter. 2015-06-18 15:12:01 +02:00
cumulus More accurate routing guiding under a block corona. 2015-06-06 18:22:48 +02:00
documentation Added README and detection of 64 bits using /lib. 2015-04-25 18:27:04 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Rationalization of Cell's flags. Compilation warnings hunt. 2015-06-10 15:49:58 +02:00
hurricane Improvements & bugs corrections in the LEF/DEF importer/exporter. 2015-06-18 15:12:01 +02:00
ispd Starting to implement support for Windows/Cygwin. 2014-07-13 13:14:49 +02:00
katabatic More accurate routing guiding under a block corona. 2015-06-06 18:22:48 +02:00
kite Rationalization of Cell's flags. Compilation warnings hunt. 2015-06-10 15:49:58 +02:00
knik Rationalization of Cell's flags. Compilation warnings hunt. 2015-06-10 15:49:58 +02:00
mauka Happy new year 2015! 2015-03-17 16:56:55 +01:00
metis Happy new year 2015! 2015-03-17 16:56:55 +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 Remove simulated annealing placer Nimbus/Metis/Mauka. 2015-03-17 22:50:00 +01:00
unicorn Annoying errors in init script under RHEL6 (bad devtoolset2 check). 2015-06-12 15:22:16 +02:00
vlsisapd Rationalization of Cell's flags. Compilation warnings hunt. 2015-06-10 15:49:58 +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 Added a top level Makefile to encapsulate the ./bootsrap/ccb.py call. 2015-05-09 23:16:36 +02:00
README.rst Added a top level Makefile to encapsulate the ./bootsrap/ccb.py call. 2015-05-09 23:16:36 +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/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.
* 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
   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