riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/documentation/UsersGuide/Installation.rst

358 lines
16 KiB
ReStructuredText
Raw Normal View History

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 10:35:02 -05:00
.. -*- Mode: rst -*-
.. include:: ../etc/definitions.rst
Installation
============
.. note::
As the sources are being released, the binary packaging is dropped.
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
You may still find (very) old versions here: http://asim.lip6.fr/pub/coriolis/2.0 .
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 10:35:02 -05:00
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
In a nutshell, building source consists in pulling the |git| repository then
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 10:35:02 -05:00
running the |ccb| installer.
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. note::
The documentation is already generated and commited in the |git| tree.
You may not install the additional prerequisites for the documentation.
By default the documentation is not generated, just installed by |ccb|.
If you really want to re-generate it, add the ``--doc`` flag to |ccb|.
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 10:35:02 -05:00
Main building prerequisites:
* cmake
* C++11-capable compiler
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
* BFD library (provided through ``binutils``).
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 10:35:02 -05:00
* RapidJSON_
* python2.7
* boost
* libxml2
* bzip2
* yacc & lex
* Qt 4 or Qt 5
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
* PyQt 4 or PyQt 5
In Python scripts, if PyQt 4 fails to load, try PyQt 5. * In CRL::Cyclop/CMakeLists.txt, add *again* the MOC files to the list of .cpp . Don't know what is happening here with MOC under Qt 5. * In CRL/python/helpers.io, cleanly fails if neither PyQt 4 nor PyQt 5 is found. And tell it directly because this the module tasked to handle the exceptions/errors... * In Cumulus/plugins/AboutWindow.py, try PyQt 4 then PyQt 5. * In documentation/UsersGuide, now tells explicitely that Qt 4 must be used under RedHat 7 and Qt 5 under Debian.
2019-10-30 10:58:43 -05:00
* Qwt 6
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 10:35:02 -05:00
Building documentation prerequisites:
* doxygen
* latex
* python-docutils (for reStructuredText)
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
The following libraries get directly bundled with |Coriolis|:
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 10:35:02 -05:00
* LEF/DEF (from `SI2 <https://www.si2.org/>`_)
Update generated documenation (change for devtoolset).
2019-03-04 07:35:16 -06:00
* FLUTE (from `Chris C. N. Chu <http://home.eng.iastate.edu/~cnchu/flute.html>`_)
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 10:35:02 -05:00
For other distributions, refer to their own packaging system.
In Python scripts, if PyQt 4 fails to load, try PyQt 5. * In CRL::Cyclop/CMakeLists.txt, add *again* the MOC files to the list of .cpp . Don't know what is happening here with MOC under Qt 5. * In CRL/python/helpers.io, cleanly fails if neither PyQt 4 nor PyQt 5 is found. And tell it directly because this the module tasked to handle the exceptions/errors... * In Cumulus/plugins/AboutWindow.py, try PyQt 4 then PyQt 5. * In documentation/UsersGuide, now tells explicitely that Qt 4 must be used under RedHat 7 and Qt 5 under Debian.
2019-10-30 10:58:43 -05:00
Cross Dependencies Issues
~~~~~~~~~~~~~~~~~~~~~~~~~
There is a difficult tangle of dependencies between |Python|, |Qt|, |Qwt| and |PyQt|,
the requirements are:
* A |Python| 2.7.
* |Qt|, either 4 or 5.
* |Qwt| version 6, compiled against the relevant |Qt| version.
* |PyQt|, version 4 or 5, according to the choosen |Qt|.
Problems arise because:
* Under |RHEL| 7 or clones, there is no compatible |PyQt5| build compatible with their
|Qt| 5 version (we fall short of one minor, they provides |Qt| 5.9 were we need at
least |Qt| 5.10). So we have to stick to |Qt| 4 on those platforms.
Fortunately we can build a |Qwt| 6 with |Qt| 4.
* Under |Debian| or |Ubuntu| there is no |Qwt| 6 build against |Qt| 4, so we have to
use |Qt| 5 and |PyQt| 5.
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 10:35:02 -05:00
Fixed Directory Tree
~~~~~~~~~~~~~~~~~~~~
Typos corrigees dans les fichiers du User Guide
2019-05-24 06:24:11 -05:00
In order to simplify the work of the |ccb| installer, the source, build
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 10:35:02 -05:00
and installation tree is fixed. To successfully compile |Coriolis| you must
follow it exactly. The tree is relative to the home directory of the user
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
building it (note :fboxtt:`~/` or :fboxtt:`$HOME/`). Only the source
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 10:35:02 -05:00
directory needs to be manually created by the user, all others will be
automatically created either by |ccb| or the build system.
In Python scripts, if PyQt 4 fails to load, try PyQt 5. * In CRL::Cyclop/CMakeLists.txt, add *again* the MOC files to the list of .cpp . Don't know what is happening here with MOC under Qt 5. * In CRL/python/helpers.io, cleanly fails if neither PyQt 4 nor PyQt 5 is found. And tell it directly because this the module tasked to handle the exceptions/errors... * In Cumulus/plugins/AboutWindow.py, try PyQt 4 then PyQt 5. * In documentation/UsersGuide, now tells explicitely that Qt 4 must be used under RedHat 7 and Qt 5 under Debian.
2019-10-30 10:58:43 -05:00
|newpage|
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 10:35:02 -05:00
+--------------------------------------------------------------------------------------------------------------+
| **Sources** |
+------------------------------+-------------------------------------------------------------------------------+
| | Sources root | | ~/coriolis-2.x/src |
| | **under git** | | ~/coriolis-2.x/src/coriolis |
+------------------------------+-------------------------------------------------------------------------------+
| **Architecture Dependant Build** |
+------------------------------+-------------------------------------------------------------------------------+
| | Linux, SL 7, 64b | | ~/coriolis-2.x/Linux.el7_64/Release.Shared/build/<tool> |
| | Linux, SL 6, 32b | | ~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/<tool> |
| | Linux, SL 6, 64b | | ~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/<tool> |
| | Linux, Fedora, 64b | | ~/coriolis-2.x/Linux.fc_64/Release.Shared/build/<tool> |
| | Linux, Fedora, 32b | | ~/coriolis-2.x/Linux.fc/Release.Shared/build/<tool> |
| | FreeBSD 8, 32b | | ~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/<tool> |
| | FreeBSD 8, 64b | | ~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/<tool> |
| | Windows 7, 32b | | ~/coriolis-2.x/Cygwin.W7/Release.Shared/build/<tool> |
| | Windows 7, 64b | | ~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/<tool> |
| | Windows 8.x, 32b | | ~/coriolis-2.x/Cygwin.W8/Release.Shared/build/<tool> |
| | Windows 8.x, 64b | | ~/coriolis-2.x/Cygwin.W8_64/Release.Shared/build/<tool> |
+------------------------------+-------------------------------------------------------------------------------+
| **Architecture Dependant Install** |
+------------------------------+-------------------------------------------------------------------------------+
| Linux, SL 6, 32b | ~/coriolis-2.x/Linux.slsoc6x/Release.Shared/install/ |
+------------------------------+-------------------------------------------------------------------------------+
| **FHS Compliant Structure under Install** |
+------------------------------+-------------------------------------------------------------------------------+
| | Binaries | | .../install/bin |
| | Libraries (Python) | | .../install/lib |
| | Include by tool | | .../install/include/coriolis2/<project>/<tool> |
| | Configuration files | | .../install/etc/coriolis2/ |
| | Doc, by tool | | .../install/share/doc/coriolis2/en/html/<tool> |
+------------------------------+-------------------------------------------------------------------------------+
.. note:: *Alternate build types:* the ``Release.Shared`` means an optimized build
with shared libraries. But there are also available ``Static`` instead of ``Shared``
and ``Debug`` instead of ``Release`` and any combination of them.
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
``Static`` does not work because I don't know yet to mix statically linked binaries
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 10:35:02 -05:00
and Python modules (which must be dynamic).
Building Coriolis
~~~~~~~~~~~~~~~~~
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
The actively developed branch
-----------------------------
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 10:35:02 -05:00
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
The **devel_anabatic** branch is now closed and we go back to a more classical
scheme where **master** is the stable version and **devel** the development one.
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 10:35:02 -05:00
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
The |Coriolis| |git| repository is https://www-soc.lip6.fr/git/coriolis.git
.. note::
Again, the **devel_anabatic** branch is now closed. Please revert to **devel**
or **master**.
.. note::
Under |RHEL| 7 or clones, they upgraded their version of |Qt| 4 (from 4.6 to 4.8)
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
so the *diagonal line* bug no longer occurs. So we can safely use the default
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
system |Qt| again.
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Installing on |RedHat| or compatible distributions
--------------------------------------------------
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
1. Install or check that the required prerequisites are installed : ::
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:~> yum install -y git cmake bison flex gcc-c++ libstdc++-devel \
binutils-devel \
boost-devel boost-python boost-filesystem \
boost-regex boost-wave \
python-devel libxml2-devel bzip2-devel \
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
qt-devel qwt-devel # Qt 4
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
Note, that the ``Qwt`` packages are directly available from the standart distribution
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
when using |Qt| 4.
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
2. Install the unpackaged prerequisites. Currently, only RapidJSON_. ::
dummy@lepka:~> mkdir -p ~/coriolis-2.x/src/support
dummy@lepka:support> cd ~/coriolis-2.x/src/support
dummy@lepka:support> git clone http://github.com/miloyip/rapidjson
3. Create the source directory and pull the |git| repository: ::
dummy@lepka:~> mkdir -p ~/coriolis-2.x/src
dummy@lepka:src> cd ~/coriolis-2.x/src
dummy@lepka:src> git clone https://www-soc.lip6.fr/git/coriolis.git
4. Build & install: ::
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:src> cd coriolis
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
dummy@lepka:coriolis> git checkout devel
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:coriolis> ./bootstrap/ccb.py --project=support \
--project=coriolis \
--make="-j4 install"
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. note::
Pre-generated documentation will get installed by the previous command.
Only if you did made modifications to it you need to regenerate it with: ::
dummy@lepka:coriolis> ./bootstrap/ccb.py --project=support \
--project=coriolis \
--doc --make="-j1 install"
We need to perform a separate installation of the documentation because it
Merge branch 'devel_anabatic' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/UsersGuide/Installation.rst
2019-05-26 08:52:18 -05:00
does not support to be generated with a parallel build. So we compile & install in a first
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
stage in ``-j4`` (or whatever) then we generate the documentation in ``-j1``
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 10:35:02 -05:00
Update generated documenation (change for devtoolset).
2019-03-04 07:35:16 -06:00
Under |RHEL6| or clones, you must build using the |devtoolset|, the version is to
be given as argument: ::
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:coriolis> ./bootstrap/ccb.py --project=coriolis \
--devtoolset=8 --make="-j4 install"
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
If you want to use Qt 5 instead of Qt 4, modify the previous steps as follows:
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
* At **step 1**, do not install the |QT| 4 related development package (``qt4-devel``),
but instead: ::
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
dummy@lepka:~> yum install -y qt5-qtbase-devel qt5-qtsvg-devel # Qt 5.
The package ``qwt-qt5-devel`` and it's dependency ``qwt-qt5`` are not provided
by any standard repository (like |EPEL|). You may download them from the
`LIP6 Addons Repository <https://ftp.lip6.fr/pub/linux/distributions/slsoc/soc/7/addons/x86_64/repoview/letter_q.group.html>`_
Then run: ::
dummy@lepka:~> yum localinstall -y qwt-qt5-6.1.2-4.fc23.x86_64.rpm \
qwt-qt5-6.1.2-4.fc23.x86_64.rpm # Qwt for Qt 5.
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 10:35:02 -05:00
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
* At **step 4**, add a ``--qt5`` argument to the ``ccb.py`` command line.
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
* The |Python| scripts that make use of |PyQt| in ``crlcore`` and ``cumulus`` must be
Full update of the generated documentation for version 2.3
2019-05-27 11:49:51 -05:00
edited to import ``PyQt5`` instead of ``PtQt4`` (should find a way to automatically
switch between the two of them).
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 10:35:02 -05:00
The complete list of |ccb| functionalities can be accessed with the ``--help`` argument.
It also may be run in graphical mode (``--gui``).
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Building a Debug Enabled Version
--------------------------------
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
The ``Release.Shared`` default version of the |Coriolis| is built stripped of symbols
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
and optimized so that it makes analysing a core dump after a crash difficult. In the
(unlikely) case of a crash, you may want to build, alongside the optimized version,
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
a debug one which allows forensic examination by |gdb| (or |valgrind| or whatever).
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Run again ``ccb.py``, adding the ``--debug`` argument: ::
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:coriolis> ./bootstrap/ccb.py --project=support \
--project=coriolis \
--make="-j4 install" --debug
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
As |cgt| is a |Python| script, the right command to run |gdb| is: ::
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:work> gdb python core.XXXX
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. Building the Devel Branch
.. -------------------------
..
.. In the |Coriolis| |git| repository, two branches are present:
..
.. * The :cb:`master` branch, which contains the latest stable version. This is the
.. one used by default if you follow the above instructions.
..
.. * The :cb:`devel` branch, which obviously contains the latest commits from the
.. development team. To use it instead of the :cb:`master` one, do the following
.. command just after the first step: ::
..
.. dummy@lepka:coriolis> git checkout devel
.. dummy@lepka:coriolis> ./bootstrap/ccb.py --project=coriolis \
.. --make="-j4 install" --debug
..
Merge branch 'devel_anabatic' of ssh://bop-t/users/largo2/git/coriolis into devel_anabatic Conflicts: documentation/UsersGuide/Installation.rst
2019-05-26 08:52:18 -05:00
.. Be aware that it may require newer versions of the dependencies and may introduce
.. incompatibilities with the stable version.
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 10:35:02 -05:00
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
Installing on |Debian| 9, |Ubuntu| 18 or compatible distributions
-----------------------------------------------------------------
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
First, install or check that the required prerequisites are installed : ::
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
dummy@lepka:~> sudo apt install -y build-essential binutils-dev \
git cmake bison flex gcc python-dev \
libboost-all-dev libboost-python-dev \
libbz2-dev libxml2-dev rapidjson-dev libbz2-dev \
qtbase5-dev libqt5svg5-dev libqwt-qt5-dev \ # Qt 5
In Python scripts, if PyQt 4 fails to load, try PyQt 5. * In CRL::Cyclop/CMakeLists.txt, add *again* the MOC files to the list of .cpp . Don't know what is happening here with MOC under Qt 5. * In CRL/python/helpers.io, cleanly fails if neither PyQt 4 nor PyQt 5 is found. And tell it directly because this the module tasked to handle the exceptions/errors... * In Cumulus/plugins/AboutWindow.py, try PyQt 4 then PyQt 5. * In documentation/UsersGuide, now tells explicitely that Qt 4 must be used under RedHat 7 and Qt 5 under Debian.
2019-10-30 10:58:43 -05:00
python-pyqt5 \
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
doxygen dvipng graphviz python-sphinx \
texlive-fonts-extra texlive-lang-french
Second step is to create the source directory and pull the |git| repository: ::
dummy@lepka:~> mkdir -p ~/coriolis-2.x/src
dummy@lepka:src> cd ~/coriolis-2.x/src
dummy@lepka:src> git clone https://www-soc.lip6.fr/git/coriolis.git
Third and final step, build & install: ::
dummy@lepka:src> cd coriolis
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
dummy@lepka:coriolis> git checkout devel
In Python scripts, if PyQt 4 fails to load, try PyQt 5. * In CRL::Cyclop/CMakeLists.txt, add *again* the MOC files to the list of .cpp . Don't know what is happening here with MOC under Qt 5. * In CRL/python/helpers.io, cleanly fails if neither PyQt 4 nor PyQt 5 is found. And tell it directly because this the module tasked to handle the exceptions/errors... * In Cumulus/plugins/AboutWindow.py, try PyQt 4 then PyQt 5. * In documentation/UsersGuide, now tells explicitely that Qt 4 must be used under RedHat 7 and Qt 5 under Debian.
2019-10-30 10:58:43 -05:00
dummy@lepka:coriolis> ./bootstrap/ccb.py --project=coriolis --qt5 \
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
--make="-j4 install"
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 10:35:02 -05:00
Additionnal Requirement under |MacOS|
-------------------------------------
Typos corrigees dans Users Guide. Fin de devel_anabatic
2019-06-04 07:32:23 -05:00
|Coriolis| makes use of the :cb:`boost::python` module, but the |macports| |boost|
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 10:35:02 -05:00
seems unable to work with the |Python| bundled with |MacOS|. So you have to install
both of them from |macports|: ::
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
dummy@macos:~> port install boost +python27
dummy@macos:~> port select python python27
dummy@macos:-> export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks
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 10:35:02 -05:00
The last two lines tell |MacOS| to use the |Python| from |macports| and *not* from
the system.
Then proceed with the generic install instructions.
Packaging Coriolis
~~~~~~~~~~~~~~~~~~
Typos corrigees dans les fichiers du User Guide
2019-05-24 06:24:11 -05:00
Packager should not use |ccb|, instead ``bootstrap/Makefile.package`` is provided
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 10:35:02 -05:00
to emulate a top-level ``autotool`` makefile. Just copy it in the root of the
|Coriolis| git repository (``~/corriolis-2.x/src/coriolis/``) and build.
Typos corrigees dans les fichiers du User Guide
2019-05-24 06:24:11 -05:00
Sligthly outdated packaging configuration files can also be found under ``bootstrap/``:
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 10:35:02 -05:00
* ``bootstrap/coriolis2.spec.in`` for |rpm| based distributions.
* ``bootstrap/debian`` for |Debian| based distributions.
Hooking up into |Alliance|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|Coriolis| relies on |Alliance| for the cell libraries. So after installing or
packaging, you must configure it so that it can found those libraries.
Updating the documentation of the startup procedure.
2017-12-02 08:51:21 -06:00
The easiest way is to setup the |Alliance| environment (i.e. sourcing
``.../etc/profile.d/alc_env.{sh,csh}``) **before** setting up |Coriolis| environment
(see the next section). To understand how |Coriolis| find/setup |Alliance| you may
Migrating the initialisation system to be completely Python-like. * New: In bootstrap/coriolisEnv.py, add the "etc" directory to the PYTHONPATH as initialization are now Python modules. * New: In Hurricane/analogic, first groundwork for the integration of PIP/MIM/MOM multi-capacitors. Add C++ and Python interface for the allocation matrix and the list of capacities values. * Change: In Hurricane::RegularLayer, add a layer parameter to the constructor so the association between the RegularLayer and it's BasicLayer can readily be done. * Change: In Hurricane::Layer, add a new getCut() accessor to get the cut layer in ViaLayer. * Change: In Hurricane::DataBase::get(), the Python wrapper should no longer consider an error if the data-base has not been created yet. Just return None. * Bug: In Isobar::PyLayer::getEnclosure() wrapper, if the overall enclosure is requested, pass the right parameter to the C++ function. * Change: In AllianceFramework, make public _bindLibraries() and export it to the Python interface. * Change: In AllianceFramework::create(), do not longer call bindLibraries(). This now must be done explicitely and afterwards. * Change: In AllianceFramework::createLibrary() and Environement::addSYSTEM_LIBRARY(), minor bug corrections that I don't recall. * Change: In SearchPath::prepend(), set the selected index to zero and return it. * Change: In CRL::System CTOR, add "etc" to the PYTHONPATH as the configuration files are now organized as Python modules. * New: In PyCRL, export the CRL::System singleton, it's creation is no longer triggered by the one of AllianceFramework. * New: In CRL/etc/, convert most of the configuration files into the Python module format. For now, keep the old ".conf", but that are no longer used. For the real technologies, we cannot keep the directory name as "180" or "45" as it not allowed by Python syntax, so we create "node180" or "node45" instead. Most of the helpers and coriolisInit.py are no longer used now. To be removed in future commits after being sure that everything works... * Bug: In AutoSegment::makeDogleg(AutoContact*), the layer of the contacts where badly computed when one end of the original segment was attached to a non-preferred direction segment (mostly on terminal contacts). Now use the new AutoContact::updateLayer() method. * Bug: In Dijkstra::load(), limit symetric search area only if the net is a symmetric one ! * Change: In Katana/python/katanaInit.py, comply with the new initialisation scheme. * Change: In Unicorn/cgt.py, comply to the new inititalization scheme. * Change: In cumulus various Python scripts remove the call to helpers.staticInitialization() as they are not needed now (we run in only *one* interpreter, so we correctly share all init). In plugins/__init__.py, read the new NDA directory variable. * Bug: In cumulus/plugins/Chip.doCoronafloorplan(), self.railsNb was not correctly managed when there was no clock. * Change: In cumulus/plugins/Configuration.coronaContactArray(), compute the viaPitch from the technology instead of the hard-coded 4.0 lambdas. In Configuration.loadConfiguration(), read the "ioring.py" from the new user's settings module. * Bug: In stratus.dpgen_ADSB2F, gives coordinates translated into DbU to the XY functions. In st_model.Save(), use the VstUseConcat flag to get correct VST files. In st_net.hur_net(), when a net is POWER/GROUND or CLOCK also make it global. * Change: In Oroshi/python/WIP_Transistor.py, encapsulate the generator inside a try/except block to get prettier error (and stop at the first).
2019-10-28 12:09:14 -05:00
have look to the *Configuration and User's Settings* section.
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 10:35:02 -05:00
Setting up the Environment (coriolisEnv.py)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To simplify the tedious task of configuring your environment, a helper is provided
in the ``bootstrap`` source directory (also installed in the directory
``.../install/etc/coriolis2/``) : ::
~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py
Use it like this: ::
dummy@lepka:~> eval `~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`
.. note:: **Do not call that script in your environement initialisation.**
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
When used under |RHEL6| or clones, it needs to be run in the |devtoolset|
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 10:35:02 -05:00
environement. The script then launch a new shell, which may cause an
infinite loop if it's called again in, say :cb:`~/.bashrc`.
Instead you may want to create an alias: ::
alias c2r='eval "`~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`"'