riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,775 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 2077a19bec In AutoSegment::_changeDepth(), correct invalidation of GCells. 
* Bug: In Anabatic::AutoSegment::_changeDepth(), GCells under the segment
    must be invalidated in order for the density to be recomputed.
    But we were using GCell::invalidate() which is meant for the quad-tree
    and graphic system, so the density almost never updated in case of
    a layer change, leading to over-congested GCells in the top layers
    (110% !).
       Now we directly set the Invalidated flag.
 		2018-06-08 12:20:37 +02:00
anabatic In AutoSegment::_changeDepth(), correct invalidation of GCells. 2018-06-08 12:20:37 +02:00
bootstrap Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
coloquinte Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
crlcore CRL::Blif parser now able to load both non-Alliance & Alliance design. 2018-06-08 12:02:49 +02:00
cumulus Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
documentation Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
equinox Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
etesian Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
hurricane Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
ispd Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
katabatic Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
katana Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
kite Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
knik Happy New Year 2018 ! Update license years... 2018-01-06 17:55:44 +01:00
lefdef Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +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
solstice Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
stratus1 Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
tutorial Add a fully generated documentation in the git repository. 2018-06-06 18:42:26 +02:00
unicorn Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02:00
vlsisapd Typo in CMakeLists.txt : AND instead of "and". 2018-06-06 23:22:18 +02: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