Go to file
Gabriel Gouvine 233a2af3d3 Changes to the documentation + README file
* README file with basic instructions
* Updated the prerequisites
* More information for synthesis with Yosys
2015-04-24 14:48:56 +02:00
bootstrap New coriolis launcher. Configuration files cleanup. 2015-04-13 18:54:09 +02:00
coloquinte New coriolis launcher. Configuration files cleanup. 2015-04-13 18:54:09 +02:00
crlcore Add a state to Cell to know if is placed and/or routed. 2015-04-16 16:52:33 +02:00
cumulus Add a state to Cell to know if is placed and/or routed. 2015-04-16 16:52:33 +02:00
documentation Changes to the documentation + README file 2015-04-24 14:48:56 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Add a state to Cell to know if is placed and/or routed. 2015-04-16 16:52:33 +02:00
hurricane Add a state to Cell to know if is placed and/or routed. 2015-04-16 16:52:33 +02:00
ispd Starting to implement support for Windows/Cygwin. 2014-07-13 13:14:49 +02:00
katabatic New coriolis launcher. Configuration files cleanup. 2015-04-13 18:54:09 +02:00
kite Add a state to Cell to know if is placed and/or routed. 2015-04-16 16:52:33 +02:00
knik Remove obsolete XML config files. Add stub technos cmos065 & c35b4. 2015-04-06 12:49:27 +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 Support for Net alias names. Blif parser enhancements. 2015-04-16 15:40:02 +02:00
vlsisapd Happy new year 2015! 2015-03-17 16:56:55 +01:00
.gitignore Adapt the rpm automated build system of bootstrap (pass 2) 2015-04-08 17:13:24 +02:00
README Changes to the documentation + README file 2015-04-24 14:48:56 +02:00

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 scriptable.

Documentation
=============

The full documentation is available [online](https://soc-extras.lip6.fr/en/coriolis/coriolis2-users-guide/) and, once built, as documentation/UsersGuide/UsersGuide.html. Basic build instructions are given below.

Building and running Coriolis
=============================

To build Coriolis, ensure the prerequisites are met, including cmake, boost, bison, flex, Qt, libxml2 and a C++11 compiler.

Copy the sources or clone the git repository as ~/coriolis-2.x/src/coriolis
Then in this directory run the build command:

    ./bootstrap/ccb.py --project=coriolis --make="-jN install"

After the build succeeds, to run the graphical interface:

    eval `~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`
    cgt -V