jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1,874 Commits 7 Branches 2 Tags 101 MiB
PostScript 43.7%
C++ 28.1%
HTML 9.4%
TeX 6.8%
Python 4.7%
Other 7%
Go to file
Jean-Paul Chaput 5bbeb0b062 Support for separated NDA tree. Big cleanup of the Python init system. 
* Change: In Hurricane::Script, when running a script, no longer do it
    inside a Python sun-interpreter, use the current one. This way we
    no longer have our modules initialized twice or more, which was
    starting to be unmanageable (with the NDA support).
      The settings were re-read multiple time to the same value, so it
    was working, but still...
      I hope I didn't left some dangling Python objects now.
* Bug: In Hurricane::LayoutGenerator::drawLayout(), get the device abutment
    box though a Pyhon object *before* finalizing which removes that objet.
* New: In cumulus/plugins/__init__.py, add a "loadPlugins()" and static
    initialisation to preload plugins modules.
      We use that pre-loading step to append to the module __path__ attribute
    the alternate directory where a NDA covered may be found. This assume that
    the directory tree under the NDA root is identical to the one under the
    public root.
* New: In cumulus/plugins/chip/__init__.py, small utility function
    importContants() to import the constants inside another module namespace,
    to have more consise notations.
* Change: In cumulus/plugins/, in the various plugins sub-modules import
    use the full path from plugins, that is, for example:
      from plugins.core2chip.CoreToChip import IoPad
* Change: In Unicorn/python/unicornInit.py, no longer directly load the
    plugins modules, this is now done by cumulus/plugins/__init__.py.
      Instead, iterate through sys.modules for the ones starting by "plugins/"
    and try to execute a Unicorn hook, if present.
* Change: In Karakaze/python/AnalogDesign.py, update for the new Instance.create()
    prototype (added placement parameter).
 		2019-10-11 17:36:54 +02:00
anabatic Force pitching on dragged AutoContacts. 2019-09-26 01:16:01 +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 Support for separated NDA tree. Big cleanup of the Python init system. 2019-10-11 17:36:54 +02:00
cumulus Support for separated NDA tree. Big cleanup of the Python init system. 2019-10-11 17:36:54 +02:00
documentation Typos corrigees dans Hurricane et Python Tutorial 2019-06-04 14:34:20 +02:00
equinox Compliance with cmake 3.0 (Debian 9.2). Corrects all warnings. 2017-12-02 14:30:05 +01:00
etesian Handle fixed pins on a net 2019-10-06 12:58:49 +02:00
flute Patch flute to be compatible with boost 1.65. 2019-03-04 12:34:43 +01:00
hurricane Support for separated NDA tree. Big cleanup of the Python init system. 2019-10-11 17:36:54 +02:00
ispd Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
karakaze Support for separated NDA tree. Big cleanup of the Python init system. 2019-10-11 17:36:54 +02:00
katabatic Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
katana More terse failure message from the global router. 2019-09-29 18:35:16 +02:00
kite Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
knik Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
lefdef Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +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
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 Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02:00
unicorn Support for separated NDA tree. Big cleanup of the Python init system. 2019-10-11 17:36:54 +02:00
unittests Compatiblilty with boost 1.57 on RedHat 6. 2019-03-11 16:01:11 +01:00
vlsisapd Partial support of newer Bookshelf formats 2019-10-06 12:58:42 +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 Various typos correction (courtesy of G. Gouvine). 2019-07-30 13:13:57 +02: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/_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://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