riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
2,462 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 302accfbb1 Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
anabatic Support more configuration 1G_xM1_1PinM2. 2021-11-16 00:28:43 +01:00
bootstrap In ccb.py, update the organization name to "Sorbonne Université". 2021-11-21 19:36:35 +01:00
bora Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
coloquinte Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
crlcore Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
cumulus No longer straight route the root of a H-Tree. 2021-11-16 17:11:00 +01:00
documentation Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
equinox Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
etesian Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
flute Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
hurricane Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
ispd Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
karakaze Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
katabatic Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
katana In Katana::Configuration::print(), display the _{h,v}TrackReservedMin. 2021-11-21 19:37:06 +01:00
kite Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
knik Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
lefdef Fix bug in the Cadence/DEF parser, occuring on the PathCbk. 2021-11-06 11:40:48 +01:00
mauka Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
metis Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
nimbus Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
nix nix: Remove unnecessary `ln` from libresoc test 2021-10-26 23:00:13 +00:00
oroshi Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
solstice Fix 'static assertion failed: comparison object must be invocable as const' 2021-10-30 13:50:44 +01:00
stratus1 In Stratus.st_model, make Model derive from object. 2021-11-21 19:37:32 +01:00
tutorial Cleanup of CMake, again. 2021-10-01 19:29:29 +02:00
unicorn Update documentation (by mistake, nothing new). 2021-11-21 23:40:40 +01:00
unittests cmake: Set policy needed for latest FindPython to work 2021-10-15 13:40:25 +01:00
vlsisapd Adapt Nix code to Python 3 switch. 2021-10-26 20:10:59 +00:00
.gitignore Ignore /result (from nix-build) 2021-10-26 22:30:33 +00:00
COPYRIGHT.rst At last setup a COPYRIGHT.rst and LICENSE.rst files. 2021-10-29 15:03:03 +02:00
LICENSE.rst At last setup a COPYRIGHT.rst and LICENSE.rst files. 2021-10-29 15:03:03 +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
compat.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
default.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
flake.lock nix: Update dependencies 2021-10-26 20:17:17 +00:00
flake.nix nix: add compatibility files 2021-10-26 22:30:34 +00:00
shell.nix nix: add compatibility files 2021-10-26 22:30:34 +00: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