riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,670 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 95d1b53646 Complete hoverhaul of the documentation to Sphinx. 
* New: In documentation, reorganise all the various documents into one
    Sphinx coherent one. The index also provide a link toward the
    Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones
    (for Stratus).
      This will make easier all future extensions to the doc corpus.
      The generated documentation is commited into Git so a new user
    can use it directly after cloning the repository.
      The HTML doc is truly generated by Sphinx, but the pdf one is
    created rst2latex. The Sphinx pdf writer is buggy when a "tabular"
    contain a multicol and a multirow in the same area of the table.
    rst2latex handles it correctly.
      We use a theme borrowed for Read The Doc (half of it).
      It seems that some Javascripts are not working correctly,
    namely the folding of the navigation sub-menus and the index
    generation and search mode.
 		2017-07-15 17:35:02 +02:00
anabatic Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
bootstrap Complete hoverhaul of the documentation to Sphinx. 2017-07-15 17:35:02 +02:00
coloquinte In Etesian, check for unplaced intermediate models with AB. 2016-12-02 16:59:32 +01:00
crlcore Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
cumulus Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
documentation Complete hoverhaul of the documentation to Sphinx. 2017-07-15 17:35:02 +02:00
equinox Compliance with Clang 3.4 (RHEL7, MacOS). 2014-12-09 23:49:46 +01:00
etesian Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
hurricane Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
ispd Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
katabatic Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
katana Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
kite Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
knik Accurate measuring of memory usage under Linux. 2017-02-25 18:21:55 +01:00
mauka Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
metis Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
nimbus Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
solstice Correct the garbled screen when shifting right in CellWidget. 2015-04-05 19:21:20 +02:00
stratus1 Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
unicorn Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52:58 +02:00
vlsisapd Check for any version of Python 2, instead of 2.7. 2017-07-11 17:52: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 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