jcarr
/
coriolis
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
coriolis/documentation/UsersGuide/LaTeX_defs.rst

68 lines
5.3 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-latex(raw)
:format: latex
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: https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/
.. _Stratus Documentation: https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/html/stratus/index.html
* 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
.. |DONE| replace:: :raw-latex:`\marginpar{\fbox{\small\ding{56}}}`
.. For LaTeX/PDF backend.
.. |Key_ESC| replace:: :raw-latex:`\key{ESC}\xspace`
.. |Key_CTRL| replace:: :raw-latex:`\key{CTRL}\xspace`
.. |Key_Up| replace:: :raw-latex:`\key{Up}\xspace`
.. |Key_Down| replace:: :raw-latex:`\key{Down}\xspace`
.. |Key_Left| replace:: :raw-latex:`\key{Left}\xspace`
.. |Key_Right| replace:: :raw-latex:`\key{Right}\xspace`
.. |Key_f| replace:: :raw-latex:`\key{f}\xspace`
.. |Key_G| replace:: :raw-latex:`\key{G}\xspace`
.. |Key_i| replace:: :raw-latex:`\key{i}\xspace`
.. |Key_l| replace:: :raw-latex:`\key{l}\xspace`
.. |Key_m| replace:: :raw-latex:`\key{m}\xspace`
.. |Key_k| replace:: :raw-latex:`\key{k}\xspace`
.. |Key_K| replace:: :raw-latex:`\key{K}\xspace`
.. |Key_o| replace:: :raw-latex:`\key{o}\xspace`
.. |Key_p| replace:: :raw-latex:`\key{p}\xspace`
.. |Key_q| replace:: :raw-latex:`\key{q}\xspace`
.. |Key_w| replace:: :raw-latex:`\key{w}\xspace`
.. |Key_S| replace:: :raw-latex:`\key{S}\xspace`
.. |Key_z| replace:: :raw-latex:`\key{z}\xspace`
.. |Plus| replace:: :raw-latex:`$+$\xspace`
.. |rightarrow| replace:: :raw-latex:`$\rightarrow$`
.. |menu_P&R| replace:: :raw-latex:`\fbox{\textsf{\textbf{{P\&R}}}}`
.. |menu_StepByStep| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{S}tep by Step}}}}`
.. |menu_KiteSaveGlobalRouting| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{S}ave Global Routing}}}}`
.. |menu_KiteLoadGlobalRouting| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{L}oad Global Routing}}}}`
.. |menu_KiteGlobalRoute| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{G}lobal Route}}}}`
.. |menu_KiteDetailedRoute| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{D}etailed Route}}}}`
Add NetRoutingState (Property) on Nets to tell Kite what to do. * New: In Katabatic, add the ability to decorate some (i.e. few) nets with a state that indicate to Katabatic & Kite what to do with it. The possible states are: 1. Fixed : all the wire are in fixed positions. The router cannot move them and account them as obstacles. 2. ManualGlobalRoute : a user-defined topology is supplied. The wires still have to be detailed route in "Detailed Pre-Route" but will be skipped for the global routing and fixed for the general Detailed route. 3. AutomaticGlobalRoute : ordinary nets, to be global routed then detail routed. 4. Excluded : do not try to global or detail route thoses nets. 5. MixedPreRoute : mask combining Fixed and ManualGlobalRoute. Not all nets have this property, only those that needs a special processing. To ease the access to the state, it is nested inside a PrivateProperty in the net (NetRoutingProperty), with an extension access class (NetRoutingExtension). * New: In Kite, take account of NetRoutingState. Pointers to the net's states are strored inside an internal map for faster access. The property is *not* deleted when Kite is destroyed. The property will remains until the Net itself is destroyed. As a consequence, the lists that where passed to high level function are removed as the information can now be accessed directly through the net NetRoutingProperty. * New: In Unicorn, in CgtMain, comply with the update interface. * New: In documentation, update the User's Guide to explain the Pre-routed step of Kite.
2014-07-02 07:36:58 -05:00
.. |menu_KiteDetailedPreRoute| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{D}etailed Pre-Route}}}}`
* 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
.. |menu_KiteFinalizeRoute| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{F}inalize Route}}}}`
.. Stand-alone images.
.. |ViewerSnapshot_1| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.7\textwidth]{./images/Viewer-1.eps}}\end{center}`
.. |ControllerSnapshot_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-1.eps}\end{center}`
.. |ControllerLook_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Look-1.eps}\end{center}`
.. |ControllerFilter_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Filter-1.eps}\end{center}`
.. |ControllerLayersGos_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-LayersGos-1.eps}\end{center}`
.. |ControllerNetlist_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Netlist-1.eps}\end{center}`
.. |ViewerNetlist_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Viewer-Netlist-1.eps}\end{center}`
.. |ControllerSelection_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Selection-1.eps}\end{center}`
.. |ControllerInspector_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-1.eps}\end{center}`
.. |ControllerInspector_2| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-2.eps}\end{center}`
.. |ControllerInspector_3| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Inspector-3.eps}\end{center}`
.. |ControllerSettings_1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Controller-Settings-1.eps}\end{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-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Coriolis-Soft-Schema.eps}\end{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
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
.. |BigMouse| image:: ./images/ComputerMouse.eps
* ./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
: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-latex:`\dotfill`
.. |noindent| replace:: :raw-latex:`\noindent`
.. |medskip| replace:: :raw-latex:`\medskip`
.. |newpage| replace:: :raw-latex:`\newpage`
* ./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