Go to file
Robert Taylor 6499f00020 Update for new poetry builder interface 2023-07-16 06:11:54 +00:00
.github/workflows Add cache key 2023-07-16 06:11:53 +00:00
Coriolis Use git tags to version releases 2023-02-21 16:10:55 +01:00
Seabreeze Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
anabatic Give priority of non-pref segments anchored on punctuals over regular ones. 2023-07-03 19:59:10 +02:00
bootstrap Finally put the *master* branch up to date. Will stay on it for now on. 2023-07-14 12:49:20 +02:00
bora Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
coloquinte@97bb781ba3 Finally understood how to update the submodule. 2023-07-09 17:43:00 +02:00
crlcore Allow Rectilinear to be tagged as external components in GdsParser. 2023-07-15 21:24:38 +02:00
cumulus In cumulus/chip.pads, now support non-square corner I/O pads. 2023-07-15 21:26:13 +02:00
deprecated Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
documentation Remove uniform density option, replaced by densityVariation 2023-06-10 14:45:07 +02:00
equinox Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
etesian Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
flute Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
foehn Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
hurricane New Rectilinear::getNearestHSide() function. 2023-07-15 21:23:42 +02:00
ispd Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
karakaze Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
katana Give priority of non-pref segments anchored on punctuals over regular ones. 2023-07-03 19:59:10 +02:00
lefdef Fix missing libraries problems (seen on Cygwin). 2023-03-07 17:29:40 +01:00
nix Remove OpenMP flags in nix build 2023-06-08 17:11:48 +02:00
oroshi Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
solstice Downgrade CMake requirements to 3.16. Detects correctly Python 3. 2023-03-03 15:36:40 +01:00
stratus1 Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
tramontana Add a tile counter in verbose time to monitor the progress. 2023-07-14 12:31:38 +02:00
tutorial Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
unicorn Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
unittests Add a flag througout all the build system to manage manylinux (PyPI). 2023-07-03 19:54:01 +02:00
.gitignore Ignore /result (from nix-build) 2021-10-26 22:30:33 +00:00
.gitlab-ci.yml Upload wheels in CI 2023-02-21 16:10:55 +01:00
.gitmodules Make the Coloquinte submodule follow the coriolis-submodule branch automatically. 2023-07-09 17:19:32 +02: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 Remove old steps from the installation 2023-04-04 16:20:29 +02:00
SUPPORT.rst Add SUPPORT.rst file 2021-12-09 22:32:02 +01:00
builder.py Use ccache to speed up build 2023-07-16 06:11:43 +00: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
poetry.lock Update for new poetry builder interface 2023-07-16 06:11:54 +00:00
pyproject.toml Update for new poetry builder interface 2023-07-16 06:11:54 +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 3,
* 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/
   ego@home:~$ cd ~/coriolis-2.x/src
   ego@home:src$ git clone https://gitlab.lip6.fr/vlsi-eda/coriolis.git
   ego@home:src$ cd coriolis

Then, build the tool: ::

    ego@home:coriolis$ make install

If you encounter issues, please consult SUPPORT.rst for tips.
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 environment 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