Go to file
Marie-Minerve Louërat 2bc2fd1583 Typos corrigees dans Users Guide.
Fin de devel_anabatic
2019-06-04 14:32:23 +02:00
anabatic Various bug corrections to pass the alliance-check-toolkit reference benchs. 2019-05-24 23:57:22 +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 Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
cumulus Various bug corrections to pass the alliance-check-toolkit reference benchs. 2019-05-24 23:57:22 +02:00
documentation Typos corrigees dans Users Guide. 2019-06-04 14:32:23 +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 mixing real pads & symbolic core. Wrapper around s2r. 2019-05-22 14:34:32 +02:00
flute Patch flute to be compatible with boost 1.65. 2019-03-04 12:34:43 +01:00
hurricane Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
ispd Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
karakaze Support for mixing real pads & symbolic core. Wrapper around s2r. 2019-05-22 14:34:32 +02:00
katabatic Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
katana Support for mixing real pads & symbolic core. Wrapper around s2r. 2019-05-22 14:34:32 +02:00
kite Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
knik Make FLUTE an independant tool in the Coriolis git repository. 2019-02-12 12:48:52 +01:00
lefdef Correct dependency problems in lefdef. 2018-11-27 13:43:59 +01: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 Support for mixing real pads & symbolic core. Wrapper around s2r. 2019-05-22 14:34:32 +02:00
unicorn Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +02:00
unittests Compatiblilty with boost 1.57 on RedHat 6. 2019-03-11 16:01:11 +01:00
vlsisapd Full update of the generated documentation for version 2.3 2019-05-27 18:49:51 +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 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