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/HTML_defs.rst

66 lines
4.7 KiB
ReStructuredText
Raw Normal View History

* All Tools: - A complete sweep of cleanup to suppress allmost all compiler warnings. * ./crlcore: - New: Extented Python support for all objects needed to configure Coriolis. - New: Configuration files and load helpers completly written in Python. An XML emulation mode is still avalaible. - New: UsersGuide, as a replacement for README, written in ReST. - New: Start of Doxygen documentation (mostly for documenting the initialisation objects & methods).
2012-11-16 06:49:47 -06:00
.. -*- Mode: rst -*-
.. role:: raw-html(raw)
:format: html
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
.. URLs that changes between the various backends.
.. _Coriolis Tools Documentation: file:///usr/share/doc/coriolis2/index.html
.. _Stratus Documentation: file:///usr/share/doc/coriolis2/en/html/stratus/index.html
.. _Here: file:///usr/share/doc/coriolis2/en/latex/users-guide/UsersGuide.pdf
* All Tools: - A complete sweep of cleanup to suppress allmost all compiler warnings. * ./crlcore: - New: Extented Python support for all objects needed to configure Coriolis. - New: Configuration files and load helpers completly written in Python. An XML emulation mode is still avalaible. - New: UsersGuide, as a replacement for README, written in ReST. - New: Start of Doxygen documentation (mostly for documenting the initialisation objects & methods).
2012-11-16 06:49:47 -06:00
.. For HTML backend
.. |Key_ESC| image:: ./images/key_ESC.png
.. |Key_CTRL| image:: ./images/key_CTRL.png
.. |Key_Up| image:: ./images/key_UP.png
.. |Key_Down| image:: ./images/key_DOWN.png
.. |Key_Left| image:: ./images/key_LEFT.png
.. |Key_Right| image:: ./images/key_RIGHT.png
.. |Key_f| image:: ./images/key_F.png
.. |Key_G| image:: ./images/key_Gcap.png
.. |Key_i| image:: ./images/key_Icap.png
.. |Key_l| image:: ./images/key_Lcap.png
.. |Key_m| image:: ./images/key_M.png
.. |Key_k| image:: ./images/key_K.png
.. |Key_K| image:: ./images/key_Kcap.png
.. |Key_o| image:: ./images/key_Ocap.png
.. |Key_p| image:: ./images/key_Pcap.png
.. |Key_q| image:: ./images/key_Qcap.png
.. |Key_w| image:: ./images/key_Wcap.png
.. |Key_S| image:: ./images/key_Scap.png
.. |Key_z| image:: ./images/key_Z.png
.. |Plus| replace:: :raw-html:`+`
.. |rightarrow| replace:: :raw-html:`<p class="empty"></p>`
.. |menu_P&R| replace:: :raw-html:`<p class="empty"></p>`
.. |menu_StepByStep| replace:: :raw-html:`<p class="empty"></p>`
.. |menu_KiteSaveGlobalRouting| image:: ./images/PR-SBS-SaveGlobal.png
.. |menu_KiteLoadGlobalRouting| image:: ./images/PR-SBS-LoadGlobal.png
.. |menu_KiteGlobalRoute| image:: ./images/PR-GlobalRoute.png
.. |menu_KiteDetailedRoute| image:: ./images/PR-DetailedRoute.png
.. |menu_KiteFinalizeRoute| image:: ./images/PR-FinalizeRoute.png
.. Stand-alone images.
.. |ViewerSnapshot_1| replace:: :raw-html:`<center><img class="addborder" src="./images/Viewer-1.png" alt="Viewer Basic Snapshot"></center>`
.. |ControllerSnapshot_1| replace:: :raw-html:`<center><img src="./images/Controller-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerLook_1| replace:: :raw-html:`<center><img src="./images/Controller-Look-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerFilter_1| replace:: :raw-html:`<center><img src="./images/Controller-Filter-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerLayersGos_1| replace:: :raw-html:`<center><img src="./images/Controller-LayersGos-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerNetlist_1| replace:: :raw-html:`<center><img src="./images/Controller-Netlist-1.png" alt="Controller Basic Snapshot"></center>`
.. |ViewerNetlist_1| replace:: :raw-html:`<center><img src="./images/Viewer-Netlist-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerSelection_1| replace:: :raw-html:`<center><img src="./images/Controller-Selection-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerInspector_1| replace:: :raw-html:`<center><img src="./images/Controller-Inspector-1.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerInspector_2| replace:: :raw-html:`<center><img src="./images/Controller-Inspector-2.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerInspector_3| replace:: :raw-html:`<center><img src="./images/Controller-Inspector-3.png" alt="Controller Basic Snapshot"></center>`
.. |ControllerSettings_1| replace:: :raw-html:`<center><img src="./images/Controller-Settings-1.png" alt="Controller Basic Snapshot"></center>`
Make the Python interface closely mirroring the C++ one. * Change: In Isobar, the Python interface was not exactly mirroring the C++ one, now it is the case. The Python code should look likes almost exactly like the C++ one, the only differences remaining being due to the languages respective syntaxes. Note that in the case of constructor functions, it leads to a slightly longer notation in Python that it could have been (mimic the ".create()" static member). Main modifications: 1. Mirror the static constructor syntax with create(): Cell( ... ) ==> Cell.create( ... ) 2. Correct hierarchy for constants in Instance, Net, Pin & Transformation. For example: Hurricane.PlacementStatusFIXED ==> Hurricane.Instance.PlacementStatus.FIXED Hurricane.OrientationID ==> Hurricane.Transformation.Orientation.ID Hurricane.TypeLOGICAL ==> Hurricane.Net.Type.LOGICAL Hurricane.DirectionIN ==> Hurricane.Net.Direction.IN * Change: In CRL Core, correction to match the improved Python API in the configutation helpers. * Change: In Cumulus, correction to match the improved Python API. * Change: In Stratus, correction to match the improved Python API. * Change: In Documenation, update for the new Python interface (both user's guide & examples). * Note: We must port those changes into Chams for it to continue to run. * Change: In Documenation, update the Python script support part.
2014-06-28 10:37:59 -05:00
.. |CoriolisSoftSchema| replace:: :raw-html:`<center><img src="./images/Coriolis-Soft-Schema.png" alt="Coriolis Software Schematic"></center>`
* All Tools: - A complete sweep of cleanup to suppress allmost all compiler warnings. * ./crlcore: - New: Extented Python support for all objects needed to configure Coriolis. - New: Configuration files and load helpers completly written in Python. An XML emulation mode is still avalaible. - New: UsersGuide, as a replacement for README, written in ReST. - New: Start of Doxygen documentation (mostly for documenting the initialisation objects & methods).
2012-11-16 06:49:47 -06:00
* ./crlcore: - Bug: In Histogram::addSample(), reject the sample if iset is superior OR EQUAL to the sets size... - Change: In etc/mauka.conf, sets "mauka.standardAnnealing" to True. Otherwise, when hMetis (4-part) is not used, this leads toward very poor placements. - New: In UsersGuide, add a third style variant for the soc-extras site.
2012-12-09 05:18:07 -06:00
.. |BigMouse| image:: ./images/ComputerMouse.png
:scale: 25%
* All Tools: - A complete sweep of cleanup to suppress allmost all compiler warnings. * ./crlcore: - New: Extented Python support for all objects needed to configure Coriolis. - New: Configuration files and load helpers completly written in Python. An XML emulation mode is still avalaible. - New: UsersGuide, as a replacement for README, written in ReST. - New: Start of Doxygen documentation (mostly for documenting the initialisation objects & methods).
2012-11-16 06:49:47 -06:00
.. Direct LaTeX commands encapsulation.
.. |dotfill| replace:: :raw-html:`&nbsp;&nbsp;`
.. |noindent| replace:: :raw-html:`<p class="empty"></p>`
.. |medskip| replace:: :raw-html:`<br>`
.. |newpage| replace:: :raw-html:`<hr>`