diff --git a/README.rst b/README.rst index 861e003e..9336ca1c 100644 --- a/README.rst +++ b/README.rst @@ -26,7 +26,7 @@ Documentation The complete documentation is available here, both in pdf & html: - ./documentation/UsersGuide/UsersGuide.html + ./documentation/_build/html/index.html ./documentation/UsersGuide/UsersGuide.pdf The documentation of the latest *stable* version is also diff --git a/bootstrap/cmake_modules/CMakeLists.txt b/bootstrap/cmake_modules/CMakeLists.txt index cb316971..f0c6c9d1 100644 --- a/bootstrap/cmake_modules/CMakeLists.txt +++ b/bootstrap/cmake_modules/CMakeLists.txt @@ -7,6 +7,7 @@ FindLibexecinfo.cmake FindLibbfd.cmake FindQwt.cmake + FindSphinx.cmake GetGitRevisionDescription.cmake GetGitRevisionDescription.cmake.in ) diff --git a/bootstrap/cmake_modules/FindSphinx.cmake b/bootstrap/cmake_modules/FindSphinx.cmake new file mode 100644 index 00000000..7d4f192a --- /dev/null +++ b/bootstrap/cmake_modules/FindSphinx.cmake @@ -0,0 +1,12 @@ + +# CMake snippet courtesy of Eric Scott BARR's blog. + + find_program( SPHINX_EXECUTABLE NAMES sphinx-build + HINTS $ENV{SPHINX_DIR} + PATH_SUFFIXES bin + DOC "Sphinx documentation generator" + ) + + include( FindPackageHandleStandardArgs ) +find_package_handle_standard_args( Sphinx DEFAULT_MSG SPHINX_EXECUTABLE ) + mark_as_advanced( SPHINX_EXECUTABLE ) diff --git a/crlcore/doc/crlcore/SoC.css b/crlcore/doc/crlcore/SoC.css index 9f833e18..90b66894 100644 --- a/crlcore/doc/crlcore/SoC.css +++ b/crlcore/doc/crlcore/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -220,6 +234,18 @@ font-size: 110%; } + table.UserDefined { + border: 1px solid; + } + + table.UserDefined th { + border: 1px solid; + } + + table.UserDefined td { + padding: 0px 5px; + } + table.DoxUser td, table.DoxUser th { padding: 0px 5px; border: 0px; @@ -349,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -362,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -410,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -427,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -544,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -554,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -583,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -628,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -650,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr { diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index 338c83ec..a3ced41c 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -5,16 +5,14 @@ cmake_minimum_required(VERSION 2.4.0) - OPTION(BUILD_DOC "Build the documentation (html+latex)" OFF) + option(BUILD_DOC "Build the documentation (html+pdf)" OFF) list(INSERT CMAKE_MODULE_PATH 0 "${DESTDIR}$ENV{CORIOLIS_TOP}/share/cmake/Modules/") find_package(Bootstrap REQUIRED) + find_package(Sphinx REQUIRED) setup_project_paths(CORIOLIS) - list(INSERT CMAKE_MODULE_PATH 0 "${CRLCORE_SOURCE_DIR}/cmake_modules/") - print_cmake_module_path() set_cmake_policies() - check_distribution() #if(BUILD_DOC) # include(UseLATEX) @@ -22,13 +20,77 @@ add_subdirectory(examples) if(BUILD_DOC) - add_subdirectory(etc) - add_subdirectory(UsersGuide) - add_subdirectory(PythonCpp) + set ( htmlInstallDir share/doc/coriolis2/en/html/main ) + set ( pdfInstallDir share/doc/coriolis2/en/pdf/main ) + + set ( pythonCppRst PythonCpp/pdfHeader.rst + PythonCpp/Introduction.rst + PythonCpp/Configuration.rst + PythonCpp/DBoStandalone.rst + PythonCpp/DBoHierarchy.rst + PythonCpp/NonDBo.rst + PythonCpp/DbU.rst + PythonCpp/Name.rst ) + + set ( usersGuideRst UsersGuide/pdfHeader.rst + UsersGuide/LicenseCredits.rst + UsersGuide/Releases.rst + UsersGuide/Installation.rst + UsersGuide/Configuration.rst + UsersGuide/ViewerTools.rst + UsersGuide/ScriptsPlugins.rst ) + + set ( rdsRst RDS/pdfHeader.rst + RDS/RDSpage.rst ) + + add_custom_target ( doc_HTML ALL + cd ${DOCUMENTATION_SOURCE_DIR} + && rm -rf _build + && sphinx-build -b html -d _build/doctrees . _build/html ) + add_dependencies ( doc_HTML ../etc/definitions.rst + ../_static/SoC.css + ../_static/www-SoC.css + ../_static/SoC-ReST.css + ../_static/pygments.css + CrlCore/CrlCore.rst + DpGen/DpGen.rst + Hurricane/Hurricane.rst + Patterns/Patterns.rst + Stratus/Stratus.rst + Unicorn/Unicorn.rst + Viewer/Viewer.rst + ${usersGuideRst} UsersGuide/index.rst + ${pythonCppRst} PythonCpp/index.rst + ${rdsRst} RDS/index.rst + ) + + add_custom_target ( pdf_UsersGuide ALL + cd ${DOCUMENTATION_SOURCE_DIR}/UsersGuide + && ../etc/doPdf.sh ${usersGuideRst} UsersGuide.rst ) + add_dependencies ( pdf_UsersGuide ../etc/definitions.rst + ../etc/SoC-ReST.tex + ${usersGuideRst} ) + + add_custom_target ( pdf_PythonCpp ALL + cd ${DOCUMENTATION_SOURCE_DIR}/PythonCpp + && ../etc/doPdf.sh ${pythonCppRst} PythonCpp.rst + ) + add_dependencies ( pdf_PythonCpp ../etc/definitions.rst + ../etc/SoC-ReST.tex + ${pythonCppRst} ) + + add_custom_target ( pdf_RDS ALL + cd ${DOCUMENTATION_SOURCE_DIR}/RDS + && ../etc/doPdf.sh ${rdsRst} RDS.rst + ) + add_dependencies ( pdf_RDS ../etc/definitions.rst + ../etc/SoC-ReST.tex + ${pythonCppRst} ) + + install ( DIRECTORY _build/html/ DESTINATION ${htmlInstallDir} ) + install ( FILES RDS/RDS.pdf + PythonCpp/PythonCpp.pdf + UsersGuide/UsersGuide.pdf DESTINATION ${pdfInstallDir} ) + endif(BUILD_DOC) - set ( htmlInstallDir share/doc/coriolis2/ ) - set ( latexInstallDir share/doc/coriolis2/ ) - - install ( FILES general-index.html DESTINATION ${htmlInstallDir} RENAME index.html ) - diff --git a/documentation/Contents.rst b/documentation/Contents.rst new file mode 100644 index 00000000..febd0e88 --- /dev/null +++ b/documentation/Contents.rst @@ -0,0 +1,20 @@ +.. Coriolis documentation master file, created by + sphinx-quickstart on Mon Jul 10 15:08:36 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Comprenhensive Table of Contents +================================ + +.. toctree:: + + UsersGuide/index.rst + Stratus/Stratus.rst + DpGen/DpGen.rst + Patterns/Patterns.rst + Hurricane/Hurricane.rst + Viewer/Viewer.rst + CrlCore/CrlCore.rst + Unicorn/Unicorn.rst + PythonCpp/index.rst + RDS/index.rst diff --git a/documentation/CrlCore/CrlCore.rst b/documentation/CrlCore/CrlCore.rst new file mode 100644 index 00000000..d462e48e --- /dev/null +++ b/documentation/CrlCore/CrlCore.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +==================== +CRL Core Reference +==================== + +The CRL Core C++ API reference is generated by Doxygen_ and is +available here: `CRL Core `_ diff --git a/documentation/DpGen/DpGen.rst b/documentation/DpGen/DpGen.rst new file mode 100644 index 00000000..0d8324d1 --- /dev/null +++ b/documentation/DpGen/DpGen.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================= +DpGen Reference +================= + +The DpGen extension of the Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `DpGen `_ diff --git a/documentation/Hurricane/Hurricane.rst b/documentation/Hurricane/Hurricane.rst new file mode 100644 index 00000000..4b1ec994 --- /dev/null +++ b/documentation/Hurricane/Hurricane.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +===================== +Hurricane Reference +===================== + +The Hurricane C++ API reference is generated by Doxygen_ and is +available here: `Hurricane `_ diff --git a/documentation/Katabatic/Katabatic.rst b/documentation/Katabatic/Katabatic.rst new file mode 100644 index 00000000..10f35831 --- /dev/null +++ b/documentation/Katabatic/Katabatic.rst @@ -0,0 +1,14 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +===================== +Katabatic Reference +===================== + +The Katabatic C++ API reference is generated by Doxygen_ and is +available here: `Katana `_ + +.. note:: The Katabatic API has served as a base for it's + mixed signal conterpart **Anabatic**. diff --git a/documentation/Kite/Kite.rst b/documentation/Kite/Kite.rst new file mode 100644 index 00000000..41450be3 --- /dev/null +++ b/documentation/Kite/Kite.rst @@ -0,0 +1,14 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================= +Kite Reference +================= + +The Kite C++ API reference is generated by Doxygen_ and is +available here: `Kite `_ + +.. note:: The Kite API has also served has a base for it's + mixed-signal conterpart Katana (:sc:`Kit[e]-Ana[logic]`). diff --git a/documentation/Makefile b/documentation/Makefile new file mode 100644 index 00000000..97677091 --- /dev/null +++ b/documentation/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Coriolis.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Coriolis.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Coriolis" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Coriolis" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/documentation/Patterns/Patterns.rst b/documentation/Patterns/Patterns.rst new file mode 100644 index 00000000..66c4791c --- /dev/null +++ b/documentation/Patterns/Patterns.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +==================== +Patterns Reference +==================== + +The Patterns extension of the Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `Patterns `_ diff --git a/documentation/PythonCpp/CMakeLists.txt b/documentation/PythonCpp/CMakeLists.txt deleted file mode 100644 index 49281f72..00000000 --- a/documentation/PythonCpp/CMakeLists.txt +++ /dev/null @@ -1,39 +0,0 @@ -# -*- mode: CMAKE; explicit-buffer-name: "CMakeLists.txt" -*- - - set ( htmlInstallDir share/doc/coriolis2/en/html/PythonCpp ) - set ( latexInstallDir share/doc/coriolis2/en/latex/PythonCpp ) - - add_custom_target ( doc_HTML ALL - cd ${DOCUMENTATION_SOURCE_DIR}/PythonCpp - && rst2html --link-stylesheet --stylesheet=../etc/SoC.css,../etc/SoC-ReST.css,../etc/Pygments.css PythonCpp.rst PythonCpp.html ) - add_dependencies ( doc_HTML ../etc/definitions.rst - ../etc/SoC.css - ../etc/SoC-ReST.css - ../etc/Pygments.css - PythonCpp.rst ) - - add_custom_target ( doc_LaTeX ALL - cd ${DOCUMENTATION_SOURCE_DIR}/PythonCpp - && export TEXINPUTS=../etc/images//:./images//: - && rst2latex --use-latex-toc --stylesheet=../etc/SoC-ReST.tex PythonCpp.rst PythonCpp-raw.tex - && sed 's, \\& \\\\multicolumn{2}{l|}{, \\& \\\\multicolumn{2}{p{0.6\\\\DUtablewidth}|}{,' PythonCpp-raw.tex > PythonCpp.tex - && pdflatex PythonCpp - && pdflatex PythonCpp - ) - add_dependencies ( doc_LaTeX ../etc/definitions.rst - ../etc/SoC-ReST.tex - PythonCpp.rst ) - - install ( DIRECTORY images/ - DESTINATION ${htmlInstallDir}/images - FILES_MATCHING PATTERN "*.png" ) - install ( FILES PythonCpp.html DESTINATION ${htmlInstallDir} ) - - install ( DIRECTORY images/ - DESTINATION ${latexInstallDir}/images - FILES_MATCHING PATTERN "*.pdf" - PATTERN "*.eps" - PATTERN "*.bb" ) - - install ( FILES PythonCpp.tex - PythonCpp.pdf DESTINATION ${latexInstallDir} ) diff --git a/documentation/PythonCpp/Configuration.rst b/documentation/PythonCpp/Configuration.rst new file mode 100644 index 00000000..2e9d11e9 --- /dev/null +++ b/documentation/PythonCpp/Configuration.rst @@ -0,0 +1,42 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +2. Basic File Structure and CMake configuration +================================================= + +As a first example we will consider the ``Hurrican::Library`` +class. To export a class into Python, we must create three files: + +#. ``PyLibrary.h``, defines the ``PyLibrary`` C-Struct and the functions + needed outside the module istself (mostly for ``PyHurricane.cpp``). + +#. ``PyLibrary.cpp``, contains the complete wrapping of the class and + the Python type definition (``PyTypeLibrary``). + +#. ``PyHurricane.cpp``, the definition of the Python module into which + the classes are registered. The module act as a ``namespace`` in + Python so it is good practice to give it the same name as it's + associated C++ namespace. + +|newpage| + +To build a Python module in |cmake|, use the following macro: + + .. code-block:: cmake + + set( pyCpps PyLibrary.cpp + PyHurricane.cpp ) + set( pyIncludes hurricane/isobar/PyLibrary.h + + add_python_module( "${pyCpps}" + "${pyIncludes}" + "isobar;1.0;1" # Name & version of the supporting + # shared library. + Hurricane # Name of the Python module will give: + # Hurricane.so + "${depLibs}" # List of dependency libraries. + include/coriolis2/hurricane/isobar + # Where to install the include files. + ) diff --git a/documentation/PythonCpp/DBoHierarchy.rst b/documentation/PythonCpp/DBoHierarchy.rst new file mode 100644 index 00000000..4c72bf3b --- /dev/null +++ b/documentation/PythonCpp/DBoHierarchy.rst @@ -0,0 +1,439 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +|newpage| + + +4. Case 2 - Hierarchy of DBo Derived Classes +============================================== + +Now we want to export the following C++ class hierarchy into Python: :: + + PyEntity <-- PyComponent <-+- PyContact + +- PySegment <-+- PyHorizontal + +- PyVertical + + +4.1 Base Class Header +~~~~~~~~~~~~~~~~~~~~~~~ + +**Remark:** this is only a partial description of the tree for the sake of +clarity. + +One important fact to remember is that ``PyEntity`` and ``PyComponent`` +being related to C++ abstract classes, no objects of those types will be +created, only ``PyContact``, ``PyHorizontal`` or ``PyVertical`` will. + +The consequence is that there is no ``PyEntity_Link()`` like in :ref:`3.1` +but instead two functions: + +#. ``PyEntity_NEW()`` which create the relevant ``PyEntity`` *derived* + object from the ``Entity`` one. For example, if the ``Entity*`` given + as argument is in fact a ``Horizontal*``, then the function will + return a ``PyHorizontal*``. + +#. ``EntityCast()`` do the reverse of ``PyEntity_NEW()`` that is, from + a ``PyEntity``, return the C++ *derived* object. Again, if the + ``PyEntity*`` is a ``PyHorizontal*``, the function will cast it as + a ``Horizontal*`` *then* return it as an ``Entity*``. + +.. code-block:: python + + #ifndef ISOBAR_PY_ENTITY_H + #define ISOBAR_PY_ENTITY_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Entity.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyObject_HEAD + Hurricane::Entity* _object; + } PyEntity; + + extern PyObject* PyEntity_NEW ( Hurricane::Entity* entity ); + extern void PyEntity_LinkPyType (); + extern PyTypeObject PyTypeEntity; + extern PyMethodDef PyEntity_Methods[]; + + + #define IsPyEntity(v) ( (v)->ob_type == &PyTypeEntity ) + #define PYENTITY(v) ( (PyEntity*)(v) ) + #define PYENTITY_O(v) ( PYENTITY(v)->_object ) + + } // extern "C". + + Hurricane::Entity* EntityCast ( PyObject* derivedObject ); + + } // Isobar namespace. + + #endif // ISOBAR_PY_ENTITY_H + +|newpage| + + +4.2 Base Class File +~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File` are: + +#. No call to ``DBoLinkCreateMethod()`` because there must be no ``PyEntity_Link()``, + but the definitions of ``PyEntity_NEW()`` and ``EntityCast``. + +#. For defining the ``PyTypeEntity`` Python type, we call a different + macro: ``PyTypeRootObjectDefinitions``, dedicated to base classes. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyCell.h" + #include "hurricane/isobar/PyHorizontal.h" + #include "hurricane/isobar/PyVertical.h" + #include "hurricane/isobar/PyContact.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #if defined(__PYTHON_MODULE__) + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Entity,entity,function) + + DBoDestroyAttribute(PyEntity_destroy ,PyEntity) + + static PyObject* PyEntity_getCell ( PyEntity *self ) + { + Cell* cell = NULL; + HTRY + METHOD_HEAD( "Entity.getCell()" ) + cell = entity->getCell(); + HCATCH + return PyCell_Link( cell ); + } + + PyMethodDef PyEntity_Methods[] = + { { "getCell", (PyCFunction)PyEntity_getCell, METH_NOARGS + , "Returns the entity cell." } + , { "destroy", (PyCFunction)PyEntity_destroy, METH_NOARGS + , "Destroy associated hurricane object, the python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + + DBoDeleteMethod(Entity) + PyTypeObjectLinkPyType(Entity) + + #else // End of Python Module Code Part. + + PyObject* PyEntity_NEW ( Entity* entity ) + { + if (not entity) { + PyErr_SetString ( HurricaneError, "Invalid Entity (bad occurrence)" ); + return NULL; + } + + Horizontal* horizontal = dynamic_cast(entity); + if (horizontal) return PyHorizontal_Link( horizontal ); + + Vertical* vertical = dynamic_cast(entity); + if (vertical) return PyVertical_Link( vertical ); + + Contact* contact = dynamic_cast(entity); + if (contact) return PyContact_Link( contact ); + + Py_RETURN_NONE; + } + + PyTypeRootObjectDefinitions(Entity) + + #endif // Shared Library Code Part (1). + + } // extern "C". + + + #if !defined(__PYTHON_MODULE__) + + Hurricane::Entity* EntityCast ( PyObject* derivedObject ) { + if (IsPyHorizontal(derivedObject)) return PYHORIZONTAL_O(derivedObject); + if (IsPyVertical (derivedObject)) return PYVERTICAL_O(derivedObject); + if (IsPyContact (derivedObject)) return PYCONTACT_O(derivedObject); + return NULL; + } + + #endif // Shared Library Code Part (2). + + } // Isobar namespace. + +|newpage| + + +4.3 Intermediate Class Header +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.1 Class Associated Header File` are: + +#. As for ``PyEntity``, and because this is still an abstract class, + there is no ``PyComponent_Link()`` function. + +#. The definition of the ``PyComponent`` |struct| is differs. There is + no ``PyObject_HEAD`` (it is a Python *derived* class). The only + field is of the base class type ``PyEntity`` and for use with + Coriolis macros, **it must** be named ``_baseObject`` (note that + this is *not* a pointer but a whole object). + +.. code-block:: c++ + + #ifndef ISOBAR_PY_COMPONENT_H + #define ISOBAR_PY_COMPONENT_H + + #include "hurricane/isobar/PyEntity.h" + #include "hurricane/Component.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyEntity _baseObject; + } PyComponent; + + extern PyTypeObject PyTypeComponent; + extern PyMethodDef PyComponent_Methods[]; + extern void PyComponent_LinkPyType (); + + #define IsPyComponent(v) ((v)->ob_type == &PyTypeComponent) + #define PYCOMPONENT(v) ((PyComponent*)(v)) + #define PYCOMPONENT_O(v) (static_cast(PYCOMPONENT(v)->_baseObject._object)) + + } // extern "C". + } // Isobar namespace. + + #endif + + +4.4 Intermediate Class File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File` are: + +1. Redefinition of the default macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. + + * The pointer to the C++ encapsulated object (attribute ``_object``) is hold + by the base class ``PyEntity``. The ``ACCESS_OBJECT`` macro which is tasked + to give access to that attribute is then ``_baseObject._object`` as + ``PyComponent`` is a direct derived class of ``PyEntity``. + + * ``ACCESS_CLASS`` is similar to ``ACCESS_OBJECT`` for accessing the base + class, that is a pointer to ``PyEntity``. + +|newpage| + +2. For defining the ``PyTypeComponent`` Python type, we call a yet different + macro: ``PyTypeInheritedObjectDefinitions()``, dedicated to derived classes. + For this this macro we need to give as argument the derived class and the + base class. + +.. code-block:: c++ + + #include "hurricane/isobar/PyComponent.h" + #include "hurricane/isobar/PyNet.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #undef ACCESS_OBJECT + #undef ACCESS_CLASS + #define ACCESS_OBJECT _baseObject._object + #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject) + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Component,component,function) + + #if defined(__PYTHON_MODULE__) + + DirectGetLongAttribute(PyComponent_getX,getX,PyComponent,Component) + DirectGetLongAttribute(PyComponent_getY,getY,PyComponent,Component) + DBoDestroyAttribute(PyComponent_destroy,PyComponent) + + static PyObject* PyComponent_getNet ( PyComponent *self ) + { + Net* net = NULL; + HTRY + METHOD_HEAD( "Component.getNet()" ) + net = component->getNet( ); + HCATCH + return PyNet_Link( net ); + } + + PyMethodDef PyComponent_Methods[] = + { { "getX" , (PyCFunction)PyComponent_getX , METH_NOARGS + , "Return the Component X value." } + , { "getY" , (PyCFunction)PyComponent_getY , METH_NOARGS + , "Return the Component Y value." } + , { "getNet" , (PyCFunction)PyComponent_getNet , METH_NOARGS + , "Returns the net owning the component." } + , { "destroy", (PyCFunction)PyComponent_destroy, METH_NOARGS + , "destroy associated hurricane object, the python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DBoDeleteMethod(Component) + PyTypeObjectLinkPyType(Component) + + #else // Python Module Code Part. + + PyTypeInheritedObjectDefinitions(Component, Entity) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +4.5 Terminal Class Header +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The contents of this file is almost identical to `4.3 Intermediate Class Header`_, +save for the presence of a ``PyContact_Link()`` function. She is present +at this level because the class is a concrete one and can be instanciated. + +.. code-block:: c++ + + #ifndef ISOBAR_PY_CONTACT_H + #define ISOBAR_PY_CONTACT_H + + #include "hurricane/isobar/PyComponent.h" + #include "hurricane/Contact.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyComponent _baseObject; + } PyContact; + + extern PyTypeObject PyTypeContact; + extern PyMethodDef PyContact_Methods[]; + extern PyObject* PyContact_Link ( Hurricane::Contact* object ); + extern void PyContact_LinkPyType (); + + #define IsPyContact(v) ( (v)->ob_type == &PyTypeContact ) + #define PYCONTACT(v) ( (PyContact*)(v) ) + #define PYCONTACT_O(v) ( PYCONTACT(v)->_baseObject._baseObject._object ) + + } // extern "C". + } // Isobar namespace. + + #endif // ISOBAR_PY_CONTACT_H + + +4.6 Terminal Class File +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from `4.4 Intermediate Class File`_ are: + +#. As previously, we have to redefine the macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. + But, as we are one level deeper into the hierarchy, one more level of + indirection using ``_baseObject`` must be used. + + * ``ACCESS_OBJECT`` becomes ``_baseObject._baseObject._object``. + + * ``ACCESS_CLASS`` becomes ``&(_pyObject->_baseObject._baseObject)``. + +#. For defining the ``PyTypeContact`` Python type, we call again + ``PyTypeInheritedObjectDefinitions()``. It is the same whether the class is + terminal or not. + +#. And, this time, as the Python class is concrete, we call the macro + ``DBoLinkCreateMethod()`` to create the ``PyContact_Link()`` function. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyContact.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #undef ACCESS_OBJECT + #undef ACCESS_CLASS + #define ACCESS_OBJECT _baseObject._baseObject._object + #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject._baseObject) + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Contact,contact,function) + + #if defined(__PYTHON_MODULE__) + + DirectGetLongAttribute(PyContact_getWidth , getWidth , PyContact,Contact) + DirectGetLongAttribute(PyContact_getHeight, getHeight, PyContact,Contact) + DBoDestroyAttribute(PyContact_destroy, PyContact) + + static PyObject* PyContact_create ( PyObject*, PyObject *args ) + { + Contact* contact = NULL; + HTRY + // Usual signature then arguments parsing. + HCATCH + return PyContact_Link(contact); + } + + PyMethodDef PyContact_Methods[] = + { { "create" , (PyCFunction)PyContact_create , METH_VARARGS|METH_STATIC + , "Create a new Contact." } + , { "destroy" , (PyCFunction)PyContact_destroy , METH_NOARGS + , "Destroy associated hurricane object, the python object remains." } + , { "getWidth" , (PyCFunction)PyContact_getWidth , METH_NOARGS + , "Return the contact width." } + , { "getHeight", (PyCFunction)PyContact_getHeight, METH_NOARGS + , "Return the contact height." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DBoDeleteMethod(Contact) + PyTypeObjectLinkPyType(Contact) + + #else // Python Module Code Part. + + DBoLinkCreateMethod(Contact) + PyTypeInheritedObjectDefinitions(Contact, Component) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +4.8 Python Module +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: c++ + + DL_EXPORT(void) initHurricane () + { + PyEntity_LinkPyType(); // step 1. + PyComponent_LinkPyType(); + PyContact_LinkPyType(); + + PYTYPE_READY( Entity ) // step 2. + PYTYPE_READY_SUB( Component, Entity ) + PYTYPE_READY_SUB( Contact , Component ) + + __cs.addType( "ent" , &PyTypeEntity , "" , false ); // step 3. + __cs.addType( "comp" , &PyTypeComponent, "", false, "ent" ); + __cs.addType( "contact", &PyTypeContact , "" , false, "comp" ); + + PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); + if (module == NULL) { + cerr << "[ERROR]\n" + << " Failed to initialize Hurricane module." << endl; + return; + } + + Py_INCREF( &PyTypeContact ); // step 4. + PyModule_AddObject( module, "Contact", (PyObject*)&PyTypeContact ); // step 4. + } diff --git a/documentation/PythonCpp/DBoStandalone.rst b/documentation/PythonCpp/DBoStandalone.rst new file mode 100644 index 00000000..36cdb46e --- /dev/null +++ b/documentation/PythonCpp/DBoStandalone.rst @@ -0,0 +1,395 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +3. Case 1 - DBo Derived, Standalone +====================================== + +As example, we take ``Library``. This a ``DBo`` derived class, but we +choose not to export the parent classes. From Python, it will appear +as a base class. + +.. _3.1: + +.. _3.1 Class Associated Header File: + +3.1 Class Associated Header File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Here is the typical content of a header file (for ``PyLibrary``): + +.. code-block:: c++ + + #ifndef PY_LIBRARY_H + #define PY_LIBRARY_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Library.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + typedef struct { + PyObject_HEAD + Library* _object; + } PyLibrary; + + extern PyTypeObject PyTypeLibrary; + extern PyMethodDef PyLibrary_Methods[]; + extern PyObject* PyLibrary_Link ( Hurricane::Library* lib ); + extern void PyLibrary_LinkPyType (); + + + #define IsPyLibrary(v) ( (v)->ob_type == &PyTypeLibrary ) + #define PYLIBRARY(v) ( (PyLibrary*)(v) ) + #define PYLIBRARY_O(v) ( PYLIBRARY(v)->_object ) + + } // extern "C". + } // Isobar namespace. + + #endif // PY_LIBRARY_H + + +The code is organized as follow: + +1. It must have, *as the first include* ``PyHurricane.h``, which provides + the complete bunch of macros needed to build the module. Then the include + of the C++ class we want to wrap (``Library.h``). + +2. As Python is written in C, all the wrapper code has to be but inside + an ``extern "C"`` namespace. + +3. Definition of the wrapped |struct|, ``PyLibrary``. It is standard Python here. + + .. note:: + For our set of macros to work, the name of the pointer to the + C++ class must always be **_object**, and the various functions and + macros defined here must take the name of the class (either in + lowercase, camel case or capitals). + +4. Declaration of the Python type ``PyTypeLibrary`` (standard). + +5. Declaration of the Python type table of methods ``PyLibrary_Methods`` (standard). + +.. _3.6: + +6. Declaration of ``PyLibrary_Link()``, helper to convert a C++ ``Lybrary`` into + a ``PyLibrary`` (put in the support shared library). + +7. Declaration of ``PyLibrary_LinkPyType()``, this function setup the class-level + function of the new Python type (here, ``PyTypeLibrary``). + +8. And, lastly, three macros to: + + * ``IsPylibrary()``, know if a Python object is a ``PyLibrary`` + * ``PYLIBRARY()``, force cast (C style) of a ``PyObject`` into a ``PyLibrary``. + * ``PYLIBRARY_O()``, extract the C++ object (``Library*``) from the Python + object (``PyLibrary``). + + +.. _3.2 Class Associated File: + +3.2 Class Associated File +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +3.2.1 Head of the file +------------------------ + +.. code-block:: c++ + + #include "hurricane/isobar/PyLibrary.h" + #include "hurricane/isobar/PyDataBase.h" + #include "hurricane/isobar/PyCell.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Library,lib,function) + +As for the header, all the code must be put inside a ``extern "C"`` namespace. + +A convenience macro ``METHOD_HEAD()`` must be defined, by refining +``GENERIC_METHOD_HEAD()``. This macro will be used in the method wrappers +below to cast the ``_object`` field of the Python object into the +appropriate C++ class, this is done using a C-style cast. +The parameters of that macro are: + +#. The C++ encapsulated class (``Library``). +#. The name of the *variable* that will be used to store a pointer + to the C++ working object. +#. The name of the C++ method which is to be wrapped. + + +3.2.2 The Python Module Part +------------------------------ + +First, we have to build all the wrappers to the C++ methods of +the class. For common predicates, accessors, and mutators macros +are supplied. + +Wrapping of the ``Library::getCell()`` method: + +.. code-block:: c++ + + static PyObject* PyLibrary_getCell ( PyLibrary* self, PyObject* args ) + { + Cell* cell = NULL; + + HTRY + METHOD_HEAD( "Library.getCell()" ) + char* name = NULL; + if (PyArg_ParseTuple(args,"s:Library.getCell", &name)) { + cell = lib->getCell( Name(name) ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library::getCell." ); + return NULL; + } + HCATCH + + return PyCell_Link(cell); + } + +Key points about this method wrapper: + +#. The ``HTRY`` / ``HCATCH`` macros provides an insulation from the C++ + exceptions. If one is emitted, it will be catched and transformed in + a Python one. This way, the Python program will be cleanly interrupted + and the usual stack trace displayed. + +#. The returned value of this method is of type ``Cell*``, we have to + transform it into a Python one. This is done with ``PyCell_Link()``. + This macro is supplied by the ``PyCell.h`` header and this is why + it must be included. + +|newpage| + + +Wrapping of the ``Library::create()`` method: + +.. code-block:: c++ + + static PyObject* PyLibrary_create( PyObject*, PyObject* args ) + { + PyObject* arg0; + PyObject* arg1; + Library* library = NULL; + + HTRY + __cs.init( "Library.create" ); // Step (1). + if (not PyArg_ParseTuple( args, "O&O&:Library.create" + , Converter, &arg0 + , Converter, &arg1 )) { // Step (2). + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library constructor." ); + return NULL; + } + if (__cs.getObjectIds() == ":db:string") { // Step (3.a) + DataBase* db = PYDATABASE_O(arg0); + library = Library::create( db, Name(PyString_AsString(arg1)) ); + } else if (__cs.getObjectIds() == ":library:string") { // Step (3.b) + Library* masterLibrary = PYLIBRARY_O(arg0); + library = Library::create( masterLibrary, Name(PyString_AsString(arg1)) ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library constructor." ); + return NULL; + } + HCATCH + + return PyLibrary_Link( library ); + } + +Key point about this constructor: + +#. We want the Python interface to mimic as closely as possible the + C++ API. As such, Python object will be created using a static + ``.create()`` method. So we do not use the usual Python allocation + mechanism. + +#. As it is a *static* method, there is no first argument. + +#. Python do not allow function overload like C++. To emulate that + behavior we use the ``__cs`` object (which is a global variable). + + #. Init/reset the ``__cs`` object: see *step (1)*. + + #. Call ``PyArg_ParseTuple()``, read every mandatory or optional + argument as a Python object (``"O&"``) and use ``Converter`` + on each one. ``Converter`` will determine the real type of + the Python object given as argument by looking at the + encapsulated C++ class. It then update the ``__cs`` object. + Done in *step (2)* + + #. After the call to ``PyArg_ParseTuple()``, the function + ``__cs.getObjectIds()`` will return the *signature* of + the various arguments. In our case, the valid signatures + will be ``":db:string"`` (*step (3.a)*a) and ``":library:string"`` + (*step (3.b)*). + + #. Call the C++ method after extracting the C++ objects from + the Python arguments. Note the use of the ``PYLIBRARY_O()`` + and ``PYDATABSE_O()`` macros to perform the conversion. + +#. Return the result, encapsulated through a call to ``PyLibrary_Link()``. + +|newpage| + + +Wrapping of the ``Library::destroy()`` method: + +.. code-block:: c++ + + DBoDestroyAttribute(PyLibrary_destroy, PyLibrary) + +For C++ classes **that are derived** from ``DBo``, the destroy method +wrapper must be defined using the macro ``DBoDestroyAttribute()``. +This macro implements the bi-directional communication mechanism +using ``Hurricane::Property``. It **must not** be used for +non ``DBo`` derived classes. + + +Defining the method table of the PyLibrary type: + +.. code-block:: c++ + + PyMethodDef PyLibrary_Methods[] = + { { "create" , (PyCFunction)PyLibrary_create , METH_VARARGS|METH_STATIC + , "Creates a new library." } + , { "getCell" , (PyCFunction)PyLibrary_getCell, METH_VARARGS + , "Get the cell of name " } + , { "destroy" , (PyCFunction)PyLibrary_destroy, METH_NOARGS + , "Destroy associated hurricane object The python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + +This is standard Python/C API. The name of the ``PyMethodDef`` table must be +named from the class: ``PyLibrary_Methods``. + + +3.2.3 Python Type Linking +--------------------------- + +Defining the ``PyTypeLibrary`` class methods and the type linking function. + +Those are the functions for the Python object itself to work, not the +wrapped method from the C++ class. + +.. note:: + At this point we **do not** define the ``PyTypeLibrary`` itself. + Only it's functions and a function to set them up *once* the + type will be defined. + +.. code-block:: c++ + + DBoDeleteMethod(Library) + PyTypeObjectLinkPyType(Library) + + +The macro ``DBoDeleteMethod()`` define the function to delete a +``PyLibrary`` *Python* object. Again, do not mistake it for the deletion +of the C++ class (implemented by ``DBoDestroyAttribute()``). +Here again, ``DBoDeleteMethod()`` is specially tailored for +``DBo`` derived classes. + +.. _PyLibrary_LinkPyType(): + +To define ``PyLibrary_LinkPyType()``, use the ``PyTypeObjectLinkPyType()`` +macro. This macro is specific for ``DBo`` derived classes that are seen as +base classes under Python (i.e. we don't bother exposing the base +class under Python). ``PyLibrary_LinkPyType()`` setup the class functions +in the ``PyTypeLibrary`` type object, it **must** be called in the +Python module this class is part of (in this case: ``PyHurricane.cpp``). +This particular flavor of the macro *will define* and setup the +following class functions: + +* ``PyTypeLibrary.tp_compare`` (defined by the macro). +* ``PyTypeLibrary.tp_repr`` (defined by the macro). +* ``PyTypeLibrary.tp_str`` (defined by the macro). +* ``PyTypeLibrary.tp_hash`` (defined by the macro). +* ``PyTypeLibrary.tp_methods`` sets to the previously defined ``PyLibrary_Methods`` table. +* ``PyTypeLibrary.tp_dealloc`` is set to a function that *must* be named ``PyLibrary_DeAlloc``, + this is what ``DBoDeleteMethod`` does. It is *not* done by ``PyTypeObjectLinkPyType``. + +Defining the ``PyTypeLibrary`` type: + + +3.2.4 The Shared Library Part +------------------------------- + +This part will be put in a separate supporting shared library, allowing +other Python module to link against it (and make use of its symbols). + +.. code-block:: c++ + + DBoLinkCreateMethod(Library) + PyTypeObjectDefinitions(Library) + + +To define ``PyTypeLibrary``, use the ``PyTypeObjectDefinitions()`` macro. +This macro is specific for classes that, as exposed by Python, +are neither *derived* classes nor *base* classes for others. +That is, they are standalone from the inheritance point of view. + +The ``DBoLinkCreateMethod()`` macro will define the ``PyLibrary_Link()`` +function which is responsible for encapsulating a C++ ``Library`` object +into a Python ``PyLibrary`` one. + + +3.3 Python Module (C++ namespace) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We use the Python module to replicate the C++ *namespace*. Thus, for the +``Hurricane`` namespace we create a Python ``Hurricane`` module which is +defined in the ``PyHurricane.cpp`` file, then we add into that module +dictionary all the Python types encapsulating the C++ classes of that +namespace. + +.. code-block:: c++ + + DL_EXPORT(void) initHurricane () + { + PyLibrary_LinkPyType(); // step 1. + + PYTYPE_READY( Library ) // step 2. + + __cs.addType( "library", &PyTypeLibrary, "", false ); // step 3. + + PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); + if (module == NULL) { + cerr << "[ERROR]\n" + << " Failed to initialize Hurricane module." << endl; + return; + } + + Py_INCREF( &PyTypeLibrary ); // step 4. + PyModule_AddObject( module, "Library", (PyObject*)&PyTypeLibrary ); // step 4. + } + +The ``initHurricane()`` initialisation function shown above has +been scrubbed of everything not relevant to the ``PyLibrary`` class. +The integration of the ``PyLibrary`` class into the module needs +four steps: + +#. A call to `PyLibrary_LinkPyType()`_ to hook the Python type functions + in the Python type object. + +#. A call to the ``PYTYPE_READY()`` macro (standard Python). + +#. Registering the type into the ``__cs`` object, with ``addType()``. + The arguments are self explanatory, save for the last which is a + boolean to tell if this is a *derived* class or not. + +#. Adding the type object (``PyTypeLibrary``) into the dictionnary of + the module itself. This allow to mimic closely the C++ syntax: + + .. code-block:: python + + import Hurricane + lib = Hurricane.Library.create( db, 'root' ) diff --git a/documentation/PythonCpp/DbU.rst b/documentation/PythonCpp/DbU.rst new file mode 100644 index 00000000..930e76d1 --- /dev/null +++ b/documentation/PythonCpp/DbU.rst @@ -0,0 +1,67 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +6. Encapsulating DbU +====================== + +While ``Hurricane::DbU`` is a class, the ``Hurricane::DbU::Unit`` is only +a ``typedef`` over ``uint64_t``. The ``DbU`` class only provides a set of +static methods to manipulate and convert to and from other units. +At Python level, ``DbU::Unit`` will be stored in plain ``long long``. + +When a ``DbU::Unit`` argument is expected in a Python functions, just use +the ``DbU::Unit PyAny_AsLong( PyObject* )`` function to convert it. + +For example, if we explicit the expension of: + +.. code-block:: c++ + + DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) + +|newpage| + +We would get: + +.. code-block:: c++ + + static PyObject* PyPoint_setX ( PyPoint *self, PyObject* args ) + { + Point* cobject = static_cast( self->_object ); + if (cobject == NULL) { + PyErr_SetString( ProxyError + , "Attempt to call Point.setX() on an unbound Hurricane object" ); + return NULL; + } + + HTRY + PyObject* arg0 = NULL; + if (not PyArg_ParseTuple( args, "O:Point.setX()", &arg0 )) + return ( NULL ); + cobject->setX( Isobar::PyAny_AsLong(arg0) ); + HCATCH + Py_RETURN_NONE; + } + + +For the other way around, use ``PyObject* PyDbU_FromLong( DbU::Unit )``. + +.. code-block:: c++ + + DirectGetLongAttribute(PyPoint_GetX,getX,PyPoint,Point) + +We would get: + +.. code-block:: c++ + + static PyObject* PyPoint_GetX ( PyPoint *self, PyObject* args ) + { + Point* cobject = static_cast( self->_object ); + if (cobject == NULL) { + PyErr_SetString( ProxyError + , "Attempt to call Point.getX() on an unbound Hurricane object" ); + return NULL; + } + return Isobar::PyDbU_FromLong(cobject->getX()); + } diff --git a/documentation/PythonCpp/Introduction.rst b/documentation/PythonCpp/Introduction.rst new file mode 100644 index 00000000..5a3300e4 --- /dev/null +++ b/documentation/PythonCpp/Introduction.rst @@ -0,0 +1,185 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +1. Introduction +================= + +* This document is written for people already familiar with the + `Python/C API Reference Manual`_. + +* The macros provided by the Hurricane Python/C API are written using + the standard Python C/API. That is, you may not use them and write + directly your functions with the original API or any mix between. + You only have to respect some naming convention. + +* Coriolis is build against Python 2.7. + + +1.1 First, A Disclaimer +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Hurricane Python/C++ API has been written about ten years ago, at a time +my mastering of template programming was less than complete. This is why this +interface is build with old fashioned C macro instead of C++ template. + +It is my hope that at some point in the future I will have time to completly +rewrite it, borrowing the interface from ``boost::python``. + + +1.2 About Technical Choices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some would say, why not use *off the shelf* wrappers like ``swig`` +or ``boost::python``, here are some clues. + +#. **Partial exposure of the C++ class tree.** We expose at Python level + C++ base classes, only if they provides common methods that we want + to see. Otherwise, we just show them as base classes under Python. + For instance ``Library`` is derived from ``DBo``, but we won't see + it under Python. + +#. **Bi-directional communication.** When a Python object is deleted, the + wrapper obviously has a pointer toward the underlying C++ object and + is able to delete it. But, the reverse case can occurs, meaning that + you have a C++ object wrapped in Python and the database delete the + underlying object. The wrapped Python object *must* be informed that + it no longer refer a valid C++ one. Moreover, as we do not control + when Python objects gets deleteds (that is, when their reference count + reaches zero), we can have valid Python object with a dangling + C++ pointer. So our Python objects can be warned by the C++ objects + that they are no longer valid and any other operation than the + deletion should result in a severe non-blocking error. + + To be precise, this apply to persistent object in the C++ database, + like ``Cell``, ``Net``, ``Instance`` or ``Component``. Short lived + objects like ``Box`` or ``Point`` retains the classic Python behavior. + + Another aspect is that, for all derived ``DBo`` objects, one and only + one Python object is associated. For one given ``Instance`` object we + will always return the *same* ``PyInstance`` object, thanks to the + bi-directional link. Obviously, the *reference count* of the + ``PyInstance`` is managed accordingly. This mechanism is implemented + by the ``PyInstance_Link()`` function. + +#. **Linking accross modules.** As far as I understand, the wrappers + are for monolithic libraries. That is, you wrap the entire library + in one go. But Hurricane has a modular design, the core database + then various tools. We do not, and cannot, have one gigantic wrapper + that would encompass all the libraries in one go. We do one Python + module for one C++ library. + + This brings another issue, at Python level this time. The Python + modules for the libraries have to share some functions. Python + provides a mechanism to pass C function pointers accross modules, + but I did found it cumbersome. Instead, all our modules are split + in two: + + * The first part contains the classic Python module code. + * The second part is to be put in a separate dynamic library that + will hold the shared functions. The Python module is dynamically linked + against that library like any other. And any other Python module + requiring the functions will link against the associated shared + library. + + Each module file will be compiled *twice*, once to build the Python + module (``__PYTHON_MODULE`` is defined) and once to build the supporting + shared library (``__PYTHON_MODULE__`` **not** defined). This tricky + double compilation is taken care of though the ``add_python_module`` + ``cmake`` macro. + + For the core Hurricane library we will have: + + * ``Hurricane.so`` the Python module (use with: ``import Hurricane``). + * ``libisobar.so.1.0`` the supporting shared library. + + The ``PyLibrary.cpp`` file will have the following structure: + + .. code-block:: c++ + + #include "hurricane/isobar/PyLibrary.h" + + namespace Isobar { + + extern "C" { + + #if defined(__PYTHON_MODULE__) + + // +=================================================================+ + // | "PyLibrary" Python Module Code Part | + // +=================================================================+ + // + // The classic part of a Python module. Goes into Hurricane.so. + + + #else // End of Python Module Code Part. + + // x=================================================================x + // | "PyLibrary" Shared Library Code Part | + // x=================================================================x + // + // Functions here will be part of the associated shared library and + // made available to all other Python modules. Goes into libisobar.so.1.0 + + + # endif // Shared Library Code Part. + + } // extern "C". + + } // Isobar namespace. + + + This way, we do not rely upon a pointer transmission through Python + modules, but directly uses linker capabilities. + + +1.3 Botched Design +~~~~~~~~~~~~~~~~~~~~ + +The mechanism to compute the signature of a call to a Python function, +the ``__cs`` object, is much too complex and, in fact, not needed. +At some point I may root it out, but it is used in so many places... + +What I should have used the ``"O!"`` capablity of ``PyArg_ParseTuple()``, +like in the code below: + +|newpage| + +.. code-block:: c++ + + static PyObject* PyContact_create ( PyObject*, PyObject *args ) + { + Contact* contact = NULL; + HTRY + PyNet* pyNet = NULL; + PyLayer* pyLayer = NULL; + PyComponent* pyComponent = NULL; + DbU::Unit x = 0; + DbU::Unit y = 0; + DbU::Unit width = 0; + DbU::Unit height = 0; + + if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" + , &PyTypeNet , &pyNet + , &PyTypeLayer, &pyLayer + , &x, &y, &width, &height)) { + contact = Contact::create( PYNET_O(pyNet), PYLAYER_O(pyLayer) + , x, y, width, height ); + } else { + PyErr_Clear(); + if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" + , &PyTypeComponent, &pyComponent + , &PyTypeLayer , &pyLayer + , &x, &y, &width, &height)) { + contact = Contact::create( PYCOMPONENT_O(pyComponent), PYLAYER_O(pyLayer) + , x, y, width, height ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Contact constructor." ); + return NULL; + } + } + HCATCH + return PyContact_Link( contact ); + } diff --git a/documentation/PythonCpp/Name.rst b/documentation/PythonCpp/Name.rst new file mode 100644 index 00000000..bb4470e8 --- /dev/null +++ b/documentation/PythonCpp/Name.rst @@ -0,0 +1,9 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +7. No C++ Hurricane::Name encapsulation +========================================== + +To be written. diff --git a/documentation/PythonCpp/NonDBo.rst b/documentation/PythonCpp/NonDBo.rst new file mode 100644 index 00000000..db9f570a --- /dev/null +++ b/documentation/PythonCpp/NonDBo.rst @@ -0,0 +1,171 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +5. Case 3 - Non-DBo Standalone Classe +======================================= + +Let's have a look at the encapsulation of ``Hurricane::Point``. + +Non-BDo derived classes do not support the bi-directionnal communication. +So each Python object is associated with one C++ object. The C++ object +is created and deleted along with the Python one. This behavior implies +that the C++ object is *copy constructible* (which should be the case). + + +5.1 Class Header +~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.1 Class Associated Header File`: + +* There is no ``PyPoint_Link()`` function, as it's related to the + bi-directional communication mechanism. + +.. note:: + **About the _object attribute** of the PyPoint. As the C++ object life span + (``Point``) is linked to the Python (``PyPoint``) one, we may have used a + value instead of a pointer. It is best to keep a pointer as the macros + written for ``DBo`` derived classes will remain usables. + + +.. code-block:: c++ + + #ifndef ISOBAR_PY_POINT_H + #define ISOBAR_PY_POINT_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Point.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyObject_HEAD + Hurricane::Point* _object; + } PyPoint; + + extern PyTypeObject PyTypePoint; + extern PyMethodDef PyPoint_Methods[]; + extern void PyPoint_LinkPyType(); + + #define IsPyPoint(v) ( (v)->ob_type == &PyTypePoint ) + #define PYPOINT(v) ( (PyPoint*)(v) ) + #define PYPOINT_O(v) ( PYPOINT(v)->_object ) + + } // extern "C". + } // Isobar namespace. + + #endif // ISOBAR_PY_POINT_H + +|newpage| + + +5.2 Class File +~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File`: + +* As there is no ``PyPoint_Link()`` function, there is no call to any + flavor of the ``DBoLinkcreatemethod()`` macro (obvious as it's *not* + a ``DBo``). + +* To use the standard Python constructor, we have to define ``PyPoint_NEW()`` + and ``PyPoint_Init()`` functions, I'm not absolutely certain that the later + needs to be defined (that part is still not clear to me from the Python doc). + +* As it's not a ``DBo`` there is no ``destroy()`` method, so no call to + ``DirectDestroyMethod()`` + +* Lastly, as this object has a ``PyPoint_NEW()`` (field ``tp_new``) and + a ``PyPoint_Init()`` (field ``tp_init``) we have to use the macro + ``PyTypeObjectLinkPyTypeNewInit()`` to define ``PyPoint_LinkPyType()``. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyPoint.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Point,point,function) + + #if defined(__PYTHON_MODULE__) + + static PyObject* PyPoint_NEW ( PyObject* module, PyObject *args ) + { + Point* point = NULL; + HTRY + PyObject* arg0 = NULL; + PyObject* arg1 = NULL; + + __cs.init( "Point.Point" ); + if (not PyArg_ParseTuple( args,"|O&O&:Point.Point" + , Converter,&arg0 + , Converter,&arg1 )) { + PyErr_SetString ( ConstructorError + , "invalid number of parameters for Point constructor." ); + return NULL; + } + + if (__cs.getObjectIds() == "") + { point = new Point()); } + else if (__cs.getObjectIds() == ":point") + { point = new Point( *PYPOINT_O(arg0) ); } + else if (__cs.getObjectIds() == ":int:int") + { point = new Point( PyAny_AsLong(arg0), PyAny_AsLong(arg1) ); } + else { + PyErr_SetString ( ConstructorError + , "invalid number of parameters for Point constructor." ); + return NULL; + } + + PyPoint* pyPoint = PyObject_NEW( PyPoint, &PyTypePoint ); + if (pyPoint == NULL) { delete point; return NULL; } + pyPoint->_object = point; + HCATCH + + return (PyObject*)pyPoint; + } + + static int PyPoint_Init ( PyPoint* self, PyObject* args, PyObject* kwargs ) + { return 0; } + + DirectGetLongAttribute(PyPoint_getX,getX,PyPoint,Point) + DirectGetLongAttribute(PyPoint_getY,getY,PyPoint,Point) + DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) + DirectSetLongAttribute(PyPoint_SetY,setY,PyPoint,Point) + + PyMethodDef PyPoint_Methods[] = + { { "getX" , (PyCFunction)PyPoint_getX , METH_NOARGS + , "Return the Point X value." } + , { "getY" , (PyCFunction)PyPoint_getY , METH_NOARGS + , "Return the Point Y value." } + , { "setX" , (PyCFunction)PyPoint_SetX , METH_VARARGS + , "Modify the Point X value." } + , { "setY" , (PyCFunction)PyPoint_SetY , METH_VARARGS + , "Modify the Point Y value." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DirectDeleteMethod(PyPoint_DeAlloc,PyPoint) + PyTypeObjectLinkPyTypeNewInit(Point) + + #else // Python Module Code Part. + + PyTypeObjectDefinitions(Point) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +5.2 Class File +~~~~~~~~~~~~~~~~ + +To put it bluntly, there is no difference in the Python module for +a standalone ``DBo`` class and a non-``DBo`` class. diff --git a/documentation/PythonCpp/PythonCpp.pdf b/documentation/PythonCpp/PythonCpp.pdf index a23b9254..0efe7a5f 100644 Binary files a/documentation/PythonCpp/PythonCpp.pdf and b/documentation/PythonCpp/PythonCpp.pdf differ diff --git a/documentation/PythonCpp/PythonCpp.rst b/documentation/PythonCpp/PythonCpp.rst deleted file mode 100644 index 6225a1f9..00000000 --- a/documentation/PythonCpp/PythonCpp.rst +++ /dev/null @@ -1,1296 +0,0 @@ -.. -*- Mode: rst -*- - -.. include:: ../etc/definitions.rst - - -|medskip| - - -=================================== -Hurricane Python/C++ API Tutorial -=================================== - -.. contents:: - -|newpage| - - -1. Introduction -================= - -* This document is written for people already familiar with the - `Python/C API Reference Manual`_. - -* The macros provided by the Hurricane Python/C API are written using - the standard Python C/API. That is, you may not use them and write - directly your functions with the original API or any mix between. - You only have to respect some naming convention. - -* Coriolis is build against Python 2.7. - - -1.1 First, A Disclaimer -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The Hurricane Python/C++ API has been written about ten years ago, at a time -my mastering of template programming was less than complete. This is why this -interface is build with old fashioned C macro instead of C++ template. - -It is my hope that at some point in the future I will have time to completly -rewrite it, borrowing the interface from ``boost::python``. - - -1.2 About Technical Choices -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some would say, why not use *off the shelf* wrappers like ``swig`` -or ``boost::python``, here are some clues. - -#. **Partial exposure of the C++ class tree.** We expose at Python level - C++ base classes, only if they provides common methods that we want - to see. Otherwise, we just show them as base classes under Python. - For instance ``Library`` is derived from ``DBo``, but we won't see - it under Python. - -#. **Bi-directional communication.** When a Python object is deleted, the - wrapper obviously has a pointer toward the underlying C++ object and - is able to delete it. But, the reverse case can occurs, meaning that - you have a C++ object wrapped in Python and the database delete the - underlying object. The wrapped Python object *must* be informed that - it no longer refer a valid C++ one. Moreover, as we do not control - when Python objects gets deleteds (that is, when their reference count - reaches zero), we can have valid Python object with a dangling - C++ pointer. So our Python objects can be warned by the C++ objects - that they are no longer valid and any other operation than the - deletion should result in a severe non-blocking error. - - To be precise, this apply to persistent object in the C++ database, - like ``Cell``, ``Net``, ``Instance`` or ``Component``. Short lived - objects like ``Box`` or ``Point`` retains the classic Python behavior. - - Another aspect is that, for all derived ``DBo`` objects, one and only - one Python object is associated. For one given ``Instance`` object we - will always return the *same* ``PyInstance`` object, thanks to the - bi-directional link. Obviously, the *reference count* of the - ``PyInstance`` is managed accordingly. This mechanism is implemented - by the ``PyInstance_Link()`` function. - -#. **Linking accross modules.** As far as I understand, the wrappers - are for monolithic libraries. That is, you wrap the entire library - in one go. But Hurricane has a modular design, the core database - then various tools. We do not, and cannot, have one gigantic wrapper - that would encompass all the libraries in one go. We do one Python - module for one C++ library. - - This brings another issue, at Python level this time. The Python - modules for the libraries have to share some functions. Python - provides a mechanism to pass C function pointers accross modules, - but I did found it cumbersome. Instead, all our modules are split - in two: - - * The first part contains the classic Python module code. - * The second part is to be put in a separate dynamic library that - will hold the shared functions. The Python module is dynamically linked - against that library like any other. And any other Python module - requiring the functions will link against the associated shared - library. - - Each module file will be compiled *twice*, once to build the Python - module (``__PYTHON_MODULE`` is defined) and once to build the supporting - shared library (``__PYTHON_MODULE__`` **not** defined). This tricky - double compilation is taken care of though the ``add_python_module`` - ``cmake`` macro. - - For the core Hurricane library we will have: - - * ``Hurricane.so`` the Python module (use with: ``import Hurricane``). - * ``libisobar.so.1.0`` the supporting shared library. - - The ``PyLibrary.cpp`` file will have the following structure: - - .. code:: c++ - - #include "hurricane/isobar/PyLibrary.h" - - namespace Isobar { - - extern "C" { - - #if defined(__PYTHON_MODULE__) - - // +=================================================================+ - // | "PyLibrary" Python Module Code Part | - // +=================================================================+ - // - // The classic part of a Python module. Goes into Hurricane.so. - - - #else // End of Python Module Code Part. - - // x=================================================================x - // | "PyLibrary" Shared Library Code Part | - // x=================================================================x - // - // Functions here will be part of the associated shared library and - // made available to all other Python modules. Goes into libisobar.so.1.0 - - - # endif // Shared Library Code Part. - - } // extern "C". - - } // Isobar namespace. - - - This way, we do not rely upon a pointer transmission through Python - modules, but directly uses linker capabilities. - - -1.3 Botched Design -~~~~~~~~~~~~~~~~~~~~ - -The mechanism to compute the signature of a call to a Python function, -the ``__cs`` object, is much too complex and, in fact, not needed. -At some point I may root it out, but it is used in so many places... - -What I should have used the ``"O!"`` capablity of ``PyArg_ParseTuple()``, -like in the code below: - -|newpage| - -.. code:: c++ - - static PyObject* PyContact_create ( PyObject*, PyObject *args ) - { - Contact* contact = NULL; - HTRY - PyNet* pyNet = NULL; - PyLayer* pyLayer = NULL; - PyComponent* pyComponent = NULL; - DbU::Unit x = 0; - DbU::Unit y = 0; - DbU::Unit width = 0; - DbU::Unit height = 0; - - if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" - , &PyTypeNet , &pyNet - , &PyTypeLayer, &pyLayer - , &x, &y, &width, &height)) { - contact = Contact::create( PYNET_O(pyNet), PYLAYER_O(pyLayer) - , x, y, width, height ); - } else { - PyErr_Clear(); - if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" - , &PyTypeComponent, &pyComponent - , &PyTypeLayer , &pyLayer - , &x, &y, &width, &height)) { - contact = Contact::create( PYCOMPONENT_O(pyComponent), PYLAYER_O(pyLayer) - , x, y, width, height ); - } else { - PyErr_SetString( ConstructorError - , "invalid number of parameters for Contact constructor." ); - return NULL; - } - } - HCATCH - return PyContact_Link( contact ); - } - - -2. Basic File Structure and CMake configuration -================================================= - -As a first example we will consider the ``Hurrican::Library`` -class. To export a class into Python, we must create three files: - -#. ``PyLibrary.h``, defines the ``PyLibrary`` C-Struct and the functions - needed outside the module istself (mostly for ``PyHurricane.cpp``). - -#. ``PyLibrary.cpp``, contains the complete wrapping of the class and - the Python type definition (``PyTypeLibrary``). - -#. ``PyHurricane.cpp``, the definition of the Python module into which - the classes are registered. The module act as a ``namespace`` in - Python so it is good practice to give it the same name as it's - associated C++ namespace. - -|newpage| - -To build a Python module in |cmake|, use the following macro: - - .. code:: cmake - - set( pyCpps PyLibrary.cpp - PyHurricane.cpp ) - set( pyIncludes hurricane/isobar/PyLibrary.h - - add_python_module( "${pyCpps}" - "${pyIncludes}" - "isobar;1.0;1" # Name & version of the supporting - # shared library. - Hurricane # Name of the Python module will give: - # Hurricane.so - "${depLibs}" # List of dependency libraries. - include/coriolis2/hurricane/isobar - # Where to install the include files. - ) - - -3. Case 1 - DBo Derived, Standalone -====================================== - -As example, we take ``Library``. This a ``DBo`` derived class, but we -choose not to export the parent classes. From Python, it will appear -as a base class. - - -3.1 Class Associated Header File -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Here is the typical content of a header file (for ``PyLibrary``): - -.. code:: c++ - - #ifndef PY_LIBRARY_H - #define PY_LIBRARY_H - - #include "hurricane/isobar/PyHurricane.h" - #include "hurricane/Library.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - typedef struct { - PyObject_HEAD - Library* _object; - } PyLibrary; - - extern PyTypeObject PyTypeLibrary; - extern PyMethodDef PyLibrary_Methods[]; - extern PyObject* PyLibrary_Link ( Hurricane::Library* lib ); - extern void PyLibrary_LinkPyType (); - - - #define IsPyLibrary(v) ( (v)->ob_type == &PyTypeLibrary ) - #define PYLIBRARY(v) ( (PyLibrary*)(v) ) - #define PYLIBRARY_O(v) ( PYLIBRARY(v)->_object ) - - } // extern "C". - } // Isobar namespace. - - #endif // PY_LIBRARY_H - - -The code is organized as follow: - -1. It must have, *as the first include* ``PyHurricane.h``, which provides - the complete bunch of macros needed to build the module. Then the include - of the C++ class we want to wrap (``Library.h``). - -2. As Python is written in C, all the wrapper code has to be but inside - an ``extern "C"`` namespace. - -3. Definition of the wrapped |struct|, ``PyLibrary``. It is standard Python here. - - .. note:: - For our set of macros to work, the name of the pointer to the - C++ class must always be **_object**, and the various functions and - macros defined here must take the name of the class (either in - lowercase, camel case or capitals). - -4. Declaration of the Python type ``PyTypeLibrary`` (standard). - -5. Declaration of the Python type table of methods ``PyLibrary_Methods`` (standard). - -.. _3.6: - -6. Declaration of ``PyLibrary_Link()``, helper to convert a C++ ``Lybrary`` into - a ``PyLibrary`` (put in the support shared library). - -7. Declaration of ``PyLibrary_LinkPyType()``, this function setup the class-level - function of the new Python type (here, ``PyTypeLibrary``). - -8. And, lastly, three macros to: - - * ``IsPylibrary()``, know if a Python object is a ``PyLibrary`` - * ``PYLIBRARY()``, force cast (C style) of a ``PyObject`` into a ``PyLibrary``. - * ``PYLIBRARY_O()``, extract the C++ object (``Library*``) from the Python - object (``PyLibrary``). - - -3.2 Class Associated File -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -3.2.1 Head of the file ------------------------- - -.. code:: c++ - - #include "hurricane/isobar/PyLibrary.h" - #include "hurricane/isobar/PyDataBase.h" - #include "hurricane/isobar/PyCell.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Library,lib,function) - -As for the header, all the code must be put inside a ``extern "C"`` namespace. - -A convenience macro ``METHOD_HEAD()`` must be defined, by refining -``GENERIC_METHOD_HEAD()``. This macro will be used in the method wrappers -below to cast the ``_object`` field of the Python object into the -appropriate C++ class, this is done using a C-style cast. -The parameters of that macro are: - -#. The C++ encapsulated class (``Library``). -#. The name of the *variable* that will be used to store a pointer - to the C++ working object. -#. The name of the C++ method which is to be wrapped. - - -3.2.2 The Python Module Part ------------------------------- - -First, we have to build all the wrappers to the C++ methods of -the class. For common predicates, accessors, and mutators macros -are supplied. - -Wrapping of the ``Library::getCell()`` method: - -.. code:: c++ - - static PyObject* PyLibrary_getCell ( PyLibrary* self, PyObject* args ) - { - Cell* cell = NULL; - - HTRY - METHOD_HEAD( "Library.getCell()" ) - char* name = NULL; - if (PyArg_ParseTuple(args,"s:Library.getCell", &name)) { - cell = lib->getCell( Name(name) ); - } else { - PyErr_SetString( ConstructorError - , "invalid number of parameters for Library::getCell." ); - return NULL; - } - HCATCH - - return PyCell_Link(cell); - } - -Key points about this method wrapper: - -#. The ``HTRY`` / ``HCATCH`` macros provides an insulation from the C++ - exceptions. If one is emitted, it will be catched and transformed in - a Python one. This way, the Python program will be cleanly interrupted - and the usual stack trace displayed. - -#. The returned value of this method is of type ``Cell*``, we have to - transform it into a Python one. This is done with ``PyCell_Link()``. - This macro is supplied by the ``PyCell.h`` header and this is why - it must be included. - -|newpage| - - -Wrapping of the ``Library::create()`` method: - -.. code:: c++ - - static PyObject* PyLibrary_create( PyObject*, PyObject* args ) - { - PyObject* arg0; - PyObject* arg1; - Library* library = NULL; - - HTRY - __cs.init( "Library.create" ); // Step (1). - if (not PyArg_ParseTuple( args, "O&O&:Library.create" - , Converter, &arg0 - , Converter, &arg1 )) { // Step (2). - PyErr_SetString( ConstructorError - , "invalid number of parameters for Library constructor." ); - return NULL; - } - if (__cs.getObjectIds() == ":db:string") { // Step (3.a) - DataBase* db = PYDATABASE_O(arg0); - library = Library::create( db, Name(PyString_AsString(arg1)) ); - } else if (__cs.getObjectIds() == ":library:string") { // Step (3.b) - Library* masterLibrary = PYLIBRARY_O(arg0); - library = Library::create( masterLibrary, Name(PyString_AsString(arg1)) ); - } else { - PyErr_SetString( ConstructorError - , "invalid number of parameters for Library constructor." ); - return NULL; - } - HCATCH - - return PyLibrary_Link( library ); - } - -Key point about this constructor: - -#. We want the Python interface to mimic as closely as possible the - C++ API. As such, Python object will be created using a static - ``.create()`` method. So we do not use the usual Python allocation - mechanism. - -#. As it is a *static* method, there is no first argument. - -#. Python do not allow function overload like C++. To emulate that - behavior we use the ``__cs`` object (which is a global variable). - - #. Init/reset the ``__cs`` object: see *step (1)*. - - #. Call ``PyArg_ParseTuple()``, read every mandatory or optional - argument as a Python object (``"O&"``) and use ``Converter`` - on each one. ``Converter`` will determine the real type of - the Python object given as argument by looking at the - encapsulated C++ class. It then update the ``__cs`` object. - Done in *step (2)* - - #. After the call to ``PyArg_ParseTuple()``, the function - ``__cs.getObjectIds()`` will return the *signature* of - the various arguments. In our case, the valid signatures - will be ``":db:string"`` (*step (3.a)*a) and ``":library:string"`` - (*step (3.b)*). - - #. Call the C++ method after extracting the C++ objects from - the Python arguments. Note the use of the ``PYLIBRARY_O()`` - and ``PYDATABSE_O()`` macros to perform the conversion. - -#. Return the result, encapsulated through a call to ``PyLibrary_Link()``. - -|newpage| - - -Wrapping of the ``Library::destroy()`` method: - -.. code:: c++ - - DBoDestroyAttribute(PyLibrary_destroy, PyLibrary) - -For C++ classes **that are derived** from ``DBo``, the destroy method -wrapper must be defined using the macro ``DBoDestroyAttribute()``. -This macro implements the bi-directional communication mechanism -using ``Hurricane::Property``. It **must not** be used for -non ``DBo`` derived classes. - - -Defining the method table of the PyLibrary type: - -.. code:: c++ - - PyMethodDef PyLibrary_Methods[] = - { { "create" , (PyCFunction)PyLibrary_create , METH_VARARGS|METH_STATIC - , "Creates a new library." } - , { "getCell" , (PyCFunction)PyLibrary_getCell, METH_VARARGS - , "Get the cell of name " } - , { "destroy" , (PyCFunction)PyLibrary_destroy, METH_NOARGS - , "Destroy associated hurricane object The python object remains." } - , {NULL, NULL, 0, NULL} /* sentinel */ - }; - - -This is standard Python/C API. The name of the ``PyMethodDef`` table must be -named from the class: ``PyLibrary_Methods``. - - -3.2.3 Python Type Linking ---------------------------- - -Defining the ``PyTypeLibrary`` class methods and the type linking function. - -Those are the functions for the Python object itself to work, not the -wrapped method from the C++ class. - -.. note:: - At this point we **do not** define the ``PyTypeLibrary`` itself. - Only it's functions and a function to set them up *once* the - type will be defined. - -.. code:: c++ - - DBoDeleteMethod(Library) - PyTypeObjectLinkPyType(Library) - - -The macro ``DBoDeleteMethod()`` define the function to delete a -``PyLibrary`` *Python* object. Again, do not mistake it for the deletion -of the C++ class (implemented by ``DBoDestroyAttribute()``). -Here again, ``DBoDeleteMethod()`` is specially tailored for -``DBo`` derived classes. - -.. _PyLibrary_LinkPyType(): - -To define ``PyLibrary_LinkPyType()``, use the ``PyTypeObjectLinkPyType()`` -macro. This macro is specific for ``DBo`` derived classes that are seen as -base classes under Python (i.e. we don't bother exposing the base -class under Python). ``PyLibrary_LinkPyType()`` setup the class functions -in the ``PyTypeLibrary`` type object, it **must** be called in the -Python module this class is part of (in this case: ``PyHurricane.cpp``). -This particular flavor of the macro *will define* and setup the -following class functions: - -* ``PyTypeLibrary.tp_compare`` (defined by the macro). -* ``PyTypeLibrary.tp_repr`` (defined by the macro). -* ``PyTypeLibrary.tp_str`` (defined by the macro). -* ``PyTypeLibrary.tp_hash`` (defined by the macro). -* ``PyTypeLibrary.tp_methods`` sets to the previously defined ``PyLibrary_Methods`` table. -* ``PyTypeLibrary.tp_dealloc`` is set to a function that *must* be named ``PyLibrary_DeAlloc``, - this is what ``DBoDeleteMethod`` does. It is *not* done by ``PyTypeObjectLinkPyType``. - -Defining the ``PyTypeLibrary`` type: - - -3.2.4 The Shared Library Part -------------------------------- - -This part will be put in a separate supporting shared library, allowing -other Python module to link against it (and make use of its symbols). - -.. code:: c++ - - DBoLinkCreateMethod(Library) - PyTypeObjectDefinitions(Library) - - -To define ``PyTypeLibrary``, use the ``PyTypeObjectDefinitions()`` macro. -This macro is specific for classes that, as exposed by Python, -are neither *derived* classes nor *base* classes for others. -That is, they are standalone from the inheritance point of view. - -The ``DBoLinkCreateMethod()`` macro will define the ``PyLibrary_Link()`` -function which is responsible for encapsulating a C++ ``Library`` object -into a Python ``PyLibrary`` one. - - -3.3 Python Module (C++ namespace) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -We use the Python module to replicate the C++ *namespace*. Thus, for the -``Hurricane`` namespace we create a Python ``Hurricane`` module which is -defined in the ``PyHurricane.cpp`` file, then we add into that module -dictionary all the Python types encapsulating the C++ classes of that -namespace. - -.. code:: c++ - - DL_EXPORT(void) initHurricane () - { - PyLibrary_LinkPyType(); // step 1. - - PYTYPE_READY( Library ) // step 2. - - __cs.addType( "library", &PyTypeLibrary, "", false ); // step 3. - - PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); - if (module == NULL) { - cerr << "[ERROR]\n" - << " Failed to initialize Hurricane module." << endl; - return; - } - - Py_INCREF( &PyTypeLibrary ); // step 4. - PyModule_AddObject( module, "Library", (PyObject*)&PyTypeLibrary ); // step 4. - } - -The ``initHurricane()`` initialisation function shown above has -been scrubbed of everything not relevant to the ``PyLibrary`` class. -The integration of the ``PyLibrary`` class into the module needs -four steps: - -#. A call to `PyLibrary_LinkPyType()`_ to hook the Python type functions - in the Python type object. - -#. A call to the ``PYTYPE_READY()`` macro (standard Python). - -#. Registering the type into the ``__cs`` object, with ``addType()``. - The arguments are self explanatory, save for the last which is a - boolean to tell if this is a *derived* class or not. - -#. Adding the type object (``PyTypeLibrary``) into the dictionnary of - the module itself. This allow to mimic closely the C++ syntax: - - .. code:: python - - import Hurricane - lib = Hurricane.Library.create( db, 'root' ) - -|newpage| - - -4. Case 2 - Hierarchy of DBo Derived Classes -============================================== - -Now we want to export the following C++ class hierarchy into Python: :: - - PyEntity <-- PyComponent <-+- PyContact - +- PySegment <-+- PyHorizontal - +- PyVertical - - -4.1 Base Class Header -~~~~~~~~~~~~~~~~~~~~~~~ - -**Remark:** this is only a partial description of tree for the sake of -clarity. - -One important fact to remember is that ``PyEntity`` and ``PyComponent`` -being related to C++ abstract classes, no objects of those types will be -created, only ``PyContact``, ``PyHorizontal`` or ``PyVertical`` will. - -The consequence is that there is no ``PyEntity_Link()`` like in `3.6`_ -but instead two functions: - -#. ``PyEntity_NEW()`` which create the relevant ``PyEntity`` *derived* - object from the ``Entity`` one. For example, if the ``Entity*`` given - as argument is in fact a ``Horizontal*``, then the function will - return a ``PyHorizontal*``. - -#. ``EntityCast()`` do the reverse of ``PyEntity_NEW()`` that is, from - a ``PyEntity``, return the C++ *derived* object. Again, if the - ``PyEntity*`` is a ``PyHorizontal*``, the function will cast it as - a ``Horizontal*`` *then* return it as an ``Entity*``. - -.. code:: python - - #ifndef ISOBAR_PY_ENTITY_H - #define ISOBAR_PY_ENTITY_H - - #include "hurricane/isobar/PyHurricane.h" - #include "hurricane/Entity.h" - - namespace Isobar { - extern "C" { - - typedef struct { - PyObject_HEAD - Hurricane::Entity* _object; - } PyEntity; - - extern PyObject* PyEntity_NEW ( Hurricane::Entity* entity ); - extern void PyEntity_LinkPyType (); - extern PyTypeObject PyTypeEntity; - extern PyMethodDef PyEntity_Methods[]; - - - #define IsPyEntity(v) ( (v)->ob_type == &PyTypeEntity ) - #define PYENTITY(v) ( (PyEntity*)(v) ) - #define PYENTITY_O(v) ( PYENTITY(v)->_object ) - - } // extern "C". - - Hurricane::Entity* EntityCast ( PyObject* derivedObject ); - - } // Isobar namespace. - - #endif // ISOBAR_PY_ENTITY_H - -|newpage| - - -4.2 Base Class File -~~~~~~~~~~~~~~~~~~~~~ - -Changes from `3.2 Class Associated File`_ are: - -#. No call to ``DBoLinkCreateMethod()`` because there must be no ``PyEntity_Link()``, - but the definitions of ``PyEntity_NEW()`` and ``EntityCast``. - -#. For defining the ``PyTypeEntity`` Python type, we call a different - macro: ``PyTypeRootObjectDefinitions``, dedicated to base classes. - - -.. code:: c++ - - #include "hurricane/isobar/PyCell.h" - #include "hurricane/isobar/PyHorizontal.h" - #include "hurricane/isobar/PyVertical.h" - #include "hurricane/isobar/PyContact.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - #if defined(__PYTHON_MODULE__) - - #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Entity,entity,function) - - DBoDestroyAttribute(PyEntity_destroy ,PyEntity) - - static PyObject* PyEntity_getCell ( PyEntity *self ) - { - Cell* cell = NULL; - HTRY - METHOD_HEAD( "Entity.getCell()" ) - cell = entity->getCell(); - HCATCH - return PyCell_Link( cell ); - } - - PyMethodDef PyEntity_Methods[] = - { { "getCell", (PyCFunction)PyEntity_getCell, METH_NOARGS - , "Returns the entity cell." } - , { "destroy", (PyCFunction)PyEntity_destroy, METH_NOARGS - , "Destroy associated hurricane object, the python object remains." } - , {NULL, NULL, 0, NULL} /* sentinel */ - }; - - - DBoDeleteMethod(Entity) - PyTypeObjectLinkPyType(Entity) - - #else // End of Python Module Code Part. - - PyObject* PyEntity_NEW ( Entity* entity ) - { - if (not entity) { - PyErr_SetString ( HurricaneError, "Invalid Entity (bad occurrence)" ); - return NULL; - } - - Horizontal* horizontal = dynamic_cast(entity); - if (horizontal) return PyHorizontal_Link( horizontal ); - - Vertical* vertical = dynamic_cast(entity); - if (vertical) return PyVertical_Link( vertical ); - - Contact* contact = dynamic_cast(entity); - if (contact) return PyContact_Link( contact ); - - Py_RETURN_NONE; - } - - PyTypeRootObjectDefinitions(Entity) - - #endif // Shared Library Code Part (1). - - } // extern "C". - - - #if !defined(__PYTHON_MODULE__) - - Hurricane::Entity* EntityCast ( PyObject* derivedObject ) { - if (IsPyHorizontal(derivedObject)) return PYHORIZONTAL_O(derivedObject); - if (IsPyVertical (derivedObject)) return PYVERTICAL_O(derivedObject); - if (IsPyContact (derivedObject)) return PYCONTACT_O(derivedObject); - return NULL; - } - - #endif // Shared Library Code Part (2). - - } // Isobar namespace. - -|newpage| - - -4.3 Intermediate Class Header -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Changes from `3.1 Class Associated Header File`_ are: - -#. As for ``PyEntity``, and because this is still an abstract class, - there is no ``PyComponent_Link()`` function. - -#. The definition of the ``PyComponent`` |struct| is differs. There is - no ``PyObject_HEAD`` (it is a Python *derived* class). The only - field is of the base class type ``PyEntity`` and for use with - Coriolis macros, **it must** be named ``_baseObject`` (note that - this is *not* a pointer but a whole object). - -.. code:: c++ - - #ifndef ISOBAR_PY_COMPONENT_H - #define ISOBAR_PY_COMPONENT_H - - #include "hurricane/isobar/PyEntity.h" - #include "hurricane/Component.h" - - namespace Isobar { - extern "C" { - - typedef struct { - PyEntity _baseObject; - } PyComponent; - - extern PyTypeObject PyTypeComponent; - extern PyMethodDef PyComponent_Methods[]; - extern void PyComponent_LinkPyType (); - - #define IsPyComponent(v) ((v)->ob_type == &PyTypeComponent) - #define PYCOMPONENT(v) ((PyComponent*)(v)) - #define PYCOMPONENT_O(v) (static_cast(PYCOMPONENT(v)->_baseObject._object)) - - } // extern "C". - } // Isobar namespace. - - #endif - - -4.4 Intermediate Class File -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Changes from `3.2 Class Associated File`_ are: - -1. Redefinition of the default macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. - - * The pointer to the C++ encapsulated object (attribute ``_object``) is hold - by the base class ``PyEntity``. The ``ACCESS_OBJECT`` macro which is tasked - to give access to that attribute is then ``_baseObject._object`` as - ``PyComponent`` is a direct derived class of ``PyEntity``. - - * ``ACCESS_CLASS`` is similar to ``ACCESS_OBJECT`` for accessing the base - class, that is a pointer to ``PyEntity``. - -|newpage| - -2. For defining the ``PyTypeComponent`` Python type, we call a yet different - macro: ``PyTypeInheritedObjectDefinitions()``, dedicated to derived classes. - For this this macro we need to give as argument the derived class and the - base class. - -.. code:: c++ - - #include "hurricane/isobar/PyComponent.h" - #include "hurricane/isobar/PyNet.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - #undef ACCESS_OBJECT - #undef ACCESS_CLASS - #define ACCESS_OBJECT _baseObject._object - #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject) - #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Component,component,function) - - #if defined(__PYTHON_MODULE__) - - DirectGetLongAttribute(PyComponent_getX,getX,PyComponent,Component) - DirectGetLongAttribute(PyComponent_getY,getY,PyComponent,Component) - DBoDestroyAttribute(PyComponent_destroy,PyComponent) - - static PyObject* PyComponent_getNet ( PyComponent *self ) - { - Net* net = NULL; - HTRY - METHOD_HEAD( "Component.getNet()" ) - net = component->getNet( ); - HCATCH - return PyNet_Link( net ); - } - - PyMethodDef PyComponent_Methods[] = - { { "getX" , (PyCFunction)PyComponent_getX , METH_NOARGS - , "Return the Component X value." } - , { "getY" , (PyCFunction)PyComponent_getY , METH_NOARGS - , "Return the Component Y value." } - , { "getNet" , (PyCFunction)PyComponent_getNet , METH_NOARGS - , "Returns the net owning the component." } - , { "destroy", (PyCFunction)PyComponent_destroy, METH_NOARGS - , "destroy associated hurricane object, the python object remains." } - , {NULL, NULL, 0, NULL} /* sentinel */ - }; - - DBoDeleteMethod(Component) - PyTypeObjectLinkPyType(Component) - - #else // Python Module Code Part. - - PyTypeInheritedObjectDefinitions(Component, Entity) - - #endif // Shared Library Code Part. - - } // extern "C". - } // Isobar namespace. - - -4.5 Terminal Class Header -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The contents of this file is almost identical to `4.3 Intermediate Class Header`_, -save for the presence of a ``PyContact_Link()`` function. She is present -at this level because the class is a concrete one and can be instanciated. - -.. code:: c++ - - #ifndef ISOBAR_PY_CONTACT_H - #define ISOBAR_PY_CONTACT_H - - #include "hurricane/isobar/PyComponent.h" - #include "hurricane/Contact.h" - - namespace Isobar { - extern "C" { - - typedef struct { - PyComponent _baseObject; - } PyContact; - - extern PyTypeObject PyTypeContact; - extern PyMethodDef PyContact_Methods[]; - extern PyObject* PyContact_Link ( Hurricane::Contact* object ); - extern void PyContact_LinkPyType (); - - #define IsPyContact(v) ( (v)->ob_type == &PyTypeContact ) - #define PYCONTACT(v) ( (PyContact*)(v) ) - #define PYCONTACT_O(v) ( PYCONTACT(v)->_baseObject._baseObject._object ) - - } // extern "C". - } // Isobar namespace. - - #endif // ISOBAR_PY_CONTACT_H - - -4.6 Terminal Class File -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Changes from `4.4 Intermediate Class File`_ are: - -#. As previously, we have to redefine the macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. - But, as we are one level deeper into the hierarchy, one more level of - indirection using ``_baseObject`` must be used. - - * ``ACCESS_OBJECT`` becomes ``_baseObject._baseObject._object``. - - * ``ACCESS_CLASS`` becomes ``&(_pyObject->_baseObject._baseObject)``. - -#. For defining the ``PyTypeContact`` Python type, we call again - ``PyTypeInheritedObjectDefinitions()``. It is the same whether the class is - terminal or not. - -#. And, this time, as the Python class is concrete, we call the macro - ``DBoLinkCreateMethod()`` to create the ``PyContact_Link()`` function. - - -.. code:: c++ - - #include "hurricane/isobar/PyContact.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - #undef ACCESS_OBJECT - #undef ACCESS_CLASS - #define ACCESS_OBJECT _baseObject._baseObject._object - #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject._baseObject) - #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Contact,contact,function) - - #if defined(__PYTHON_MODULE__) - - DirectGetLongAttribute(PyContact_getWidth , getWidth , PyContact,Contact) - DirectGetLongAttribute(PyContact_getHeight, getHeight, PyContact,Contact) - DBoDestroyAttribute(PyContact_destroy, PyContact) - - static PyObject* PyContact_create ( PyObject*, PyObject *args ) - { - Contact* contact = NULL; - HTRY - // Usual signature then arguments parsing. - HCATCH - return PyContact_Link(contact); - } - - PyMethodDef PyContact_Methods[] = - { { "create" , (PyCFunction)PyContact_create , METH_VARARGS|METH_STATIC - , "Create a new Contact." } - , { "destroy" , (PyCFunction)PyContact_destroy , METH_NOARGS - , "Destroy associated hurricane object, the python object remains." } - , { "getWidth" , (PyCFunction)PyContact_getWidth , METH_NOARGS - , "Return the contact width." } - , { "getHeight", (PyCFunction)PyContact_getHeight, METH_NOARGS - , "Return the contact height." } - , {NULL, NULL, 0, NULL} /* sentinel */ - }; - - DBoDeleteMethod(Contact) - PyTypeObjectLinkPyType(Contact) - - #else // Python Module Code Part. - - DBoLinkCreateMethod(Contact) - PyTypeInheritedObjectDefinitions(Contact, Component) - - #endif // Shared Library Code Part. - - } // extern "C". - } // Isobar namespace. - - -4.8 Python Module -~~~~~~~~~~~~~~~~~~~ - -.. code:: c++ - - DL_EXPORT(void) initHurricane () - { - PyEntity_LinkPyType(); // step 1. - PyComponent_LinkPyType(); - PyContact_LinkPyType(); - - PYTYPE_READY( Entity ) // step 2. - PYTYPE_READY_SUB( Component, Entity ) - PYTYPE_READY_SUB( Contact , Component ) - - __cs.addType( "ent" , &PyTypeEntity , "" , false ); // step 3. - __cs.addType( "comp" , &PyTypeComponent, "", false, "ent" ); - __cs.addType( "contact", &PyTypeContact , "" , false, "comp" ); - - PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); - if (module == NULL) { - cerr << "[ERROR]\n" - << " Failed to initialize Hurricane module." << endl; - return; - } - - Py_INCREF( &PyTypeContact ); // step 4. - PyModule_AddObject( module, "Contact", (PyObject*)&PyTypeContact ); // step 4. - } - - -5. Case 3 - Non-DBo Standalone Classe -======================================= - -Let's have a look at the encapsulation of ``Hurricane::Point``. - -Non-BDo derived classes do not support the bi-directionnal communication. -So each Python object is associated with one C++ object. The C++ object -is created and deleted along with the Python one. This behavior implies -that the C++ object is *copy constructible* (which should be the case). - - -5.1 Class Header -~~~~~~~~~~~~~~~~~~ - -Changes from `3.1 Class Associated Header File`_: - -* There is no ``PyPoint_Link()`` function, as it's related to the - bi-directional communication mechanism. - -.. note:: - **About the _object attribute** of the PyPoint. As the C++ object life span - (``Point``) is linked to the Python (``PyPoint``) one, we may have used a - value instead of a pointer. It is best to keep a pointer as the macros - written for ``DBo`` derived classes will remain usables. - - -.. code:: c++ - - #ifndef ISOBAR_PY_POINT_H - #define ISOBAR_PY_POINT_H - - #include "hurricane/isobar/PyHurricane.h" - #include "hurricane/Point.h" - - namespace Isobar { - extern "C" { - - typedef struct { - PyObject_HEAD - Hurricane::Point* _object; - } PyPoint; - - extern PyTypeObject PyTypePoint; - extern PyMethodDef PyPoint_Methods[]; - extern void PyPoint_LinkPyType(); - - #define IsPyPoint(v) ( (v)->ob_type == &PyTypePoint ) - #define PYPOINT(v) ( (PyPoint*)(v) ) - #define PYPOINT_O(v) ( PYPOINT(v)->_object ) - - } // extern "C". - } // Isobar namespace. - - #endif // ISOBAR_PY_POINT_H - -|newpage| - - -5.2 Class File -~~~~~~~~~~~~~~~~ - -Changes from `3.2 Class Associated File`_: - -* As there is no ``PyPoint_Link()`` function, there is no call to any - flavor of the ``DBoLinkcreatemethod()`` macro (obvious as it's *not* - a ``DBo``). - -* To use the standard Python constructor, we have to define ``PyPoint_NEW()`` - and ``PyPoint_Init()`` functions, I'm not absolutely certain that the later - needs to be defined (that part is still not clear to me from the Python doc). - -* As it's not a ``DBo`` there is no ``destroy()`` method, so no call to - ``DirectDestroyMethod()`` - -* Lastly, as this object has a ``PyPoint_NEW()`` (field ``tp_new``) and - a ``PyPoint_Init()`` (field ``tp_init``) we have to use the macro - ``PyTypeObjectLinkPyTypeNewInit()`` to define ``PyPoint_LinkPyType()``. - - -.. code:: c++ - - #include "hurricane/isobar/PyPoint.h" - - namespace Isobar { - using namespace Hurricane; - - extern "C" { - - #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Point,point,function) - - #if defined(__PYTHON_MODULE__) - - static PyObject* PyPoint_NEW ( PyObject* module, PyObject *args ) - { - Point* point = NULL; - HTRY - PyObject* arg0 = NULL; - PyObject* arg1 = NULL; - - __cs.init( "Point.Point" ); - if (not PyArg_ParseTuple( args,"|O&O&:Point.Point" - , Converter,&arg0 - , Converter,&arg1 )) { - PyErr_SetString ( ConstructorError - , "invalid number of parameters for Point constructor." ); - return NULL; - } - - if (__cs.getObjectIds() == "") - { point = new Point()); } - else if (__cs.getObjectIds() == ":point") - { point = new Point( *PYPOINT_O(arg0) ); } - else if (__cs.getObjectIds() == ":int:int") - { point = new Point( PyAny_AsLong(arg0), PyAny_AsLong(arg1) ); } - else { - PyErr_SetString ( ConstructorError - , "invalid number of parameters for Point constructor." ); - return NULL; - } - - PyPoint* pyPoint = PyObject_NEW( PyPoint, &PyTypePoint ); - if (pyPoint == NULL) { delete point; return NULL; } - pyPoint->_object = point; - HCATCH - - return (PyObject*)pyPoint; - } - - static int PyPoint_Init ( PyPoint* self, PyObject* args, PyObject* kwargs ) - { return 0; } - - DirectGetLongAttribute(PyPoint_getX,getX,PyPoint,Point) - DirectGetLongAttribute(PyPoint_getY,getY,PyPoint,Point) - DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) - DirectSetLongAttribute(PyPoint_SetY,setY,PyPoint,Point) - - PyMethodDef PyPoint_Methods[] = - { { "getX" , (PyCFunction)PyPoint_getX , METH_NOARGS - , "Return the Point X value." } - , { "getY" , (PyCFunction)PyPoint_getY , METH_NOARGS - , "Return the Point Y value." } - , { "setX" , (PyCFunction)PyPoint_SetX , METH_VARARGS - , "Modify the Point X value." } - , { "setY" , (PyCFunction)PyPoint_SetY , METH_VARARGS - , "Modify the Point Y value." } - , {NULL, NULL, 0, NULL} /* sentinel */ - }; - - DirectDeleteMethod(PyPoint_DeAlloc,PyPoint) - PyTypeObjectLinkPyTypeNewInit(Point) - - #else // Python Module Code Part. - - PyTypeObjectDefinitions(Point) - - #endif // Shared Library Code Part. - - } // extern "C". - } // Isobar namespace. - - -5.2 Class File -~~~~~~~~~~~~~~~~ - -To put it bluntly, there is no difference in the Python module for -a standalone ``DBo`` class and a non-``DBo`` class. - - -6. Encapsulating DbU -====================== - -While ``Hurricane::DbU`` is a class, the ``Hurricane::DbU::Unit`` is only -a ``typedef`` over ``uint64_t``. The ``DbU`` class only provides a set of -static methods to manipulate and convert to and from other units. -At Python level, ``DbU::Unit`` will be stored in plain ``long long``. - -When a ``DbU::Unit`` argument is expected in a Python functions, just use -the ``DbU::Unit PyAny_AsLong( PyObject* )`` function to convert it. - -For example, if we explicit the expension of: - -.. code:: c++ - - DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) - -|newpage| - -We would get: - -.. code:: c++ - - static PyObject* PyPoint_setX ( PyPoint *self, PyObject* args ) - { - Point* cobject = static_cast( self->_object ); - if (cobject == NULL) { - PyErr_SetString( ProxyError - , "Attempt to call Point.setX() on an unbound Hurricane object" ); - return NULL; - } - - HTRY - PyObject* arg0 = NULL; - if (not PyArg_ParseTuple( args, "O:Point.setX()", &arg0 )) - return ( NULL ); - cobject->setX( Isobar::PyAny_AsLong(arg0) ); - HCATCH - Py_RETURN_NONE; - } - - -For the other way around, use ``PyObject* PyDbU_FromLong( DbU::Unit )``. - -.. code:: c++ - - DirectGetLongAttribute(PyPoint_GetX,getX,PyPoint,Point) - -We would get: - -.. code:: c++ - - static PyObject* PyPoint_GetX ( PyPoint *self, PyObject* args ) - { - Point* cobject = static_cast( self->_object ); - if (cobject == NULL) { - PyErr_SetString( ProxyError - , "Attempt to call Point.getX() on an unbound Hurricane object" ); - return NULL; - } - return Isobar::PyDbU_FromLong(cobject->getX()); - } - - -7. No C++ Hurricane::Name encapsulation -========================================== - -To be written. diff --git a/documentation/PythonCpp/index.rst b/documentation/PythonCpp/index.rst new file mode 100644 index 00000000..cb5575c2 --- /dev/null +++ b/documentation/PythonCpp/index.rst @@ -0,0 +1,23 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +=================================== +Hurricane Python/C++ API Tutorial +=================================== + +Printable version of this document `PythonCpp.pdf <../../../pdf/main/PythonCpp.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + Introduction.rst + Configuration.rst + DBoStandalone.rst + DBoHierarchy.rst + NonDBo.rst + DbU.rst + Name.rst + diff --git a/documentation/PythonCpp/pdfHeader.rst b/documentation/PythonCpp/pdfHeader.rst new file mode 100644 index 00000000..29cdbf2b --- /dev/null +++ b/documentation/PythonCpp/pdfHeader.rst @@ -0,0 +1,15 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +=================================== +Hurricane Python/C++ API Tutorial +=================================== + +|pagestylefancy| + + +.. contents:: + +|newpage| diff --git a/documentation/RDS/HTML_defs.rst b/documentation/RDS/HTML_defs.rst deleted file mode 100644 index 43c7dd0a..00000000 --- a/documentation/RDS/HTML_defs.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. -*- Mode: rst -*- - -.. role:: raw-html(raw) - :format: html - -.. URLs that changes between the various backends. - -.. For HTML backend - -.. Stand-alone images. -.. |RDS_VW| replace:: :raw-html:`
RDS Variable Width Rule
` -.. |RDS_LCW| replace:: :raw-html:`
RDS Left Constant Width Rule
` -.. |SegmentOrientation| replace:: :raw-html:`
Symbolic Segment Orientations
` -.. |BIGVIA_1| replace:: :raw-html:`
BIGVIA holes
` -.. |BIGVIA_2| replace:: :raw-html:`
BIGVIA holes overlap
` - -.. Direct LaTeX commands encapsulation. -.. |dotfill| replace:: :raw-html:`  ` -.. |noindent| replace:: :raw-html:`

` -.. |medskip| replace:: :raw-html:`
` -.. |newpage| replace:: :raw-html:`
` - diff --git a/documentation/RDS/LaTeX_defs.rst b/documentation/RDS/LaTeX_defs.rst deleted file mode 100644 index 37d0bbf3..00000000 --- a/documentation/RDS/LaTeX_defs.rst +++ /dev/null @@ -1,25 +0,0 @@ - -.. -*- Mode: rst -*- - -.. role:: raw-latex(raw) - :format: latex - -.. URLs that changes between the various backends. - -.. |DONE| replace:: :raw-latex:`\marginpar{\fbox{\small\ding{56}}}` - -.. For LaTeX/PDF backend. - -.. Stand-alone images. -.. |RDS_VW| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.7\textwidth]{./images/RDS_VW.eps}}\end{center}` -.. |RDS_LCW| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.4\textwidth]{./images/RDS_LCW.eps}}\end{center}` -.. |SegmentOrientation| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.5\textwidth]{./images/SegmentOrientation.eps}}\end{center}` -.. |BIGVIA_1| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.5\textwidth]{./images/bigvia-1.eps}}\end{center}` -.. |BIGVIA_2| replace:: :raw-latex:`\begin{center}\fbox{\includegraphics[width=.5\textwidth]{./images/bigvia-2.eps}}\end{center}` - -.. Direct LaTeX commands encapsulation. -.. |dotfill| replace:: :raw-latex:`\dotfill` -.. |noindent| replace:: :raw-latex:`\noindent` -.. |medskip| replace:: :raw-latex:`\medskip` -.. |newpage| replace:: :raw-latex:`\newpage` - diff --git a/documentation/RDS/RDS.html b/documentation/RDS/RDS.html deleted file mode 100644 index f93f2d4d..00000000 --- a/documentation/RDS/RDS.html +++ /dev/null @@ -1,1286 +0,0 @@ - - - - - - - - - - - - -
- - --- - - - - - - - - - -
Date:26, september 2014
Authors:Jean-Paul Chaput
Contact:<alliance-users@soc.lip6.fr>
Version:0.2
- - - - - - - - - - -


-

Disclaimer: This document is still far from complete.

-


-
-

Symbolic to Real Conversion In Alliance

- -


-


-
-

Symbolic Layout

-
-

Symbolic Components

-

A symbolic layout is, in practice, made of only of three objects:

- ----- - - - - - - - - - - - - - - - - - - - - -
ObjectmbkExplanation
SegmentsphsegOriented segments with a width and an orientation.
VIAs & contactsphviaBoils down to just a point.
Big VIAs & Big ContactsphviaPoint with a width and a height -That is a rectangle of width by height centered -on the VIA coordinates.
-

Each of thoses objects is associated to a symbolic layer which will -control how the object is translated in many real rectangles.

- ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
mbkLayer NameUsable ByUsage
phsegNWELLSegmentN Well
PWELLSegmentP Well
NDIFSegmentN Diffusion
PDIFSegmentP Diffusion
NTIESegmentN Tie
PTIESegmentP Tie
NTRANSSegmentN transistor, in Alliance, a transistor -is represented as a segment (it's grid).
PTRANSSegmentP transistor
POLYSegmentPolysilicium
ALUxSegmentMetal level x
CALUxSegmentMetal level x, that can be used by the -upper hierarchical level as a connector. -From the layout point of view it is the -same as ALUx.
TALUxSegmentBlockage for metal level x. Will -diseappear in the real layout as it is an -information for the P&R tools only.
phviaCONT_BODY_NVIA, BIGVIAContact to N Well
CONT_BODY_PVIA, BIGVIAContact to P Well
CONT_DIF_NVIA, BIGVIAContact to N Diffusion
CONT_DIF_PVIA, BIGVIAContact to P Diffusion
CONT_POLYVIA, BIGVIAContact to polysilicium
CONT_VIAVIA, BIGVIAContact between metal1 and metal2
CONT_VIAxVIA, BIGVIAContact between metal x and metal x+1. -The index is the the one of the bottom -metal of the VIA.
C_X_NVIAN transistor corner, to build transistor -bend. Not used anymore in recent technos
C_X_PVIAP transistor corner, to build transistor -bend. Not used anymore in recent technos
-
-

Note

-

Not all association of object and symbolic layers are meaningful. -For instance you cannot associate a contact to a NTRANS layer.

-
-
-

Note

-

The symbolic layer associated with blockages is prefixed by a T, -for transparency, which may seems silly. It is for historical reasons, -it started as a true transparency, but at some point we had to invert -the meaning (blockage) with the rise of over-the-cell routing, but the -name stuck...

-
-
-
-

Symbolic Segments

-

In Alliance, segments are oriented (up, down, left, right). This disambiguate -the left or right side when using the LCW and RCW rules in the rds file. -It allows to generate, if needed, asymetric object in the real layout file.

-

Symbolic Segment Orientations

-
-
-
-

The RDS File

-

The RDS file control how a symbolic layout is transformed into it's real -conterpart.

-
-

Note

-

Unit used inside the RDS file: all units are expressed in micrometers.

-
-

Alliance tools relying on the RDS file, and what layers are active for them:

- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
ToolNameRDS Flags
Layout editorgraalALL
Design Rule CheckerdrucALL, DRC
Electrical extractorcougarALL, EXT
The symbolic to real layout translators2rALL
-
-

Physical Grid & Lambda Value

-

RDS file:

-
-DEFINE  PHYSICAL_GRID  0.005
-DEFINE  LAMBDA         0.09
-
-

Tells that the physical grid (founder grid) step is 0.005µm and the lambda has -a value of 0.09µm. That is, one lambda is 18 grid steps.

-

We can distinguish two kind of rds files:

-
    -
  • The 1µm kind, odd segment widths and coordinates are allowed, but the LAMBDA -value must represent an even number of foundry grid step.
    • -
  • The 2µm kind, segments widths and coordinates must all be even. And in that case -the LAMBDA value can be any multiple of the foundry grid.
    • -
-
-
-

The MBK_TO_RDS_SEGMENT table

-

The MBK_TO_RDS_SEGMENT table control the way segments are translated into -real rectangles. Be aware that we are translating segments and not rectangles. -Segments are defined by their axis (source & target points) and their width. -The geometrical transformations are described according to that model. -Obviously, they are either horizontal or vertical.

-

The translation method of a symbolic segment is as follow:

-
    -

  1. The segment is translated into one or more physical rectangles. -The generated rectangles depends on the tool which is actually -using rds and the flag for the considered real layer. -For instance, real layers flagged with DRC will be generated -for s2r (for the cif or gds) and druc, but will not -be shown under graal.

    -
    2. -

  2. Translation into one real layer. First the source & target coordinates and width -of the symbolic segment are multiplied by the LAMBDA value to obtain a real -segment. Then one of the VW, LCW or RCW transformation is applied to -that segment to get the final real rectangle.

    -
      -

    • VW for Variable Width, expand the real layer staying centered from the -original one. In those rules, the third number is not used, it is only here -to make the life easier for the parser...

      -

      RDS Variable Width Rule

      -
      • -

    • LCW or RCW for Left/Right Constant Width, create an off-center rectangle -of fixed width relatively to the real segment. Note that the SP number -is the distance between the edge of the real segment and the edge of the -generated real rectangle (not from the axis). It is often zero.

      -

      RDS Left Constant Width Rule

      -
      • -
    -
    3. -
-


-

Examples:

-
-TABLE MBK_TO_RDS_SEGMENT
-
-    # (Case 1)
-    ALU1       RDS_ALU1   VW  0.18  0.09  0.0  ALL
-
-    # (Case 2)
-    NDIF       RDS_NDIF   VW  0.18  0.0   0.0  ALL \
-               RDS_ACTIV  VW  0.18  0.0   0.0  DRC \
-               RDS_NIMP   VW  0.36  0.36  0.0  DRC
-
-    # (Case 3)
-    NTRANS     RDS_POLY   VW  0.27  0.00  0.0  ALL \
-               RDS_GATE   VW  0.27  0.00  0.0  DRC \
-               RDS_NDIF  LCW  0.0   0.27  0.0  EXT \
-               RDS_NDIF  RCW  0.0   0.27  0.0  EXT \
-               RDS_NDIF   VW  0.0   0.72  0.0  DRC \
-               RDS_ACTIV  VW  0.0   0.72  0.0  ALL \
-               RDS_NIMP   VW  0.18  1.26  0.0  DRC
-
-END
-
-

Case 1 the ALU1 is translated in exacltly one real rectangle of -RDS_ALU1, both ends are extended by 0.18µm and it's width is increased -by 0.09µm.

-

Case 2 the NDIF will be translated into only one segment -under graal, for symbolic visualization. And into three real rectangles -for s2r and druc.

-

Case 3 the NTRANS, associated to a transistor is a little bit -more complex, the generated shapes are different for the extractor cougar -in one hand, and for both druc & s2r in the other hand.

-
    -

  • For the extractor (EXT & ALL flags) there will be four rectangles -generateds:

    -
      -
    1. The gate (RDS_GATE)
      2. -
    2. The left diffusion of the transistor (source or drain) (RDS_NDIF).
      3. -
    3. The right diffusion of the transistor (drain or source) (RDS_NDIF).
      4. -
    4. The active area (RDS_ACTIV).
      5. -
    -

    As the extractor must kept separate the source and the drain of the transistor, -they are generated as two offset rectangles, using the LCW and RCW directives.

    -
    • -

  • For s2r and druc (DRC and ALL), five rectangles are generateds:

    -
      -
    1. The poly (RDS_POLY).
      2. -
    2. The gate (RDS_GATE).
      3. -
    3. The diffusion, as one rectangle that covers both the LCW and the RCW (RDS_NDIF).
      4. -
    4. The active area (RDS_ACTIV).
      5. -
    5. The N implantation (RDS_NIMP).
      6. -
    -

    In the layout send to the foundry, the source & drain are draw as one rectangle -across the gate area (the transistor being defined by the intersection of both -rectangles).

    -
    • -
-


-
-
-

The MBK_TO_RDS_VIA table

-

This table is to translate default VIAs into real via. In the symbolic layout -the default VIA is simply a point and a set of layers. All layers are converted -in squares shapes centered on the VIA coordinate. The one dimension given is the -size of the side of that square.

-

Note that although we are refering to VIAs, which for the purists are between two -metal layers, this table also describe contacts.

-

Example:

-
-TABLE MBK_TO_RDS_VIA
-
-    CONT_DIF_P RDS_PDIF  0.54 ALL \
-               RDS_CONT  0.18 ALL \
-               RDS_ALU1  0.36 ALL \
-               RDS_ACTIV 0.54 DRC \
-               RDS_PIMP  0.90 DRC
-
-    CONT_POLY  RDS_POLY  0.54 ALL \
-               RDS_CONT  0.18 ALL \
-               RDS_ALU1  0.36 ALL
-
-    CONT_VIA   RDS_ALU1  0.45 ALL \
-               RDS_VIA1  0.27 ALL \
-               RDS_ALU2  0.45 ALL
-
-END
-
-
-

Note

-

In CONT_DIF_P you may see that only three layers will be shown under -graal, but five will be generated in the gds layout.

-
-
-
-

The MBK_TO_RDS_BIGVIA_HOLE table

-

In s2r, when generating BIGVIAs, the matrix of holes they contains is -not draw relative to the position of the BIGVIA itself, but on a grid which -is common througout all the design real layout. This is to allow overlap -between two BIGVIA without risking the holes matrix to be not exactly overlapping. -As a consequence, when visualizing the gds file, the holes may not be centerend -inside one individual BIGVIA.

-

The MBK_TO_RDS_BIGVIA_HOLE table define the global hole matrix for the whole -design. The first number is the individual hole side and the second the grid step -(edge to edge). The figure below show the hole generation.

-

BIGVIA holes

-

Example of BIGVIA overlap:

-

BIGVIA holes overlap

-

Example:

-
-TABLE MBK_TO_RDS_BIGVIA_HOLE
-
-    CONT_VIA   RDS_VIA1 0.27 0.27 ALL
-    CONT_VIA2  RDS_VIA2 0.27 0.27 ALL
-    CONT_VIA3  RDS_VIA3 0.27 0.27 ALL
-    CONT_VIA4  RDS_VIA4 0.27 0.27 ALL
-    CONT_VIA5  RDS_VIA5 0.36 0.36 ALL
-
-END
-
-
-

Note

-

BIGVIA demotion. If the size of the bigvia is too small, there is -a possibility that no hole from the global matrix will be under it. -To avoid that case, if the either side of the BIGVIA is less than -1.5 * step, the BIGVIA is demoted to a simple VIA.

-
-


-
-
-

The MBK_TO_RDS_BIGVIA_METAL table

-

This table describe how the metal part of a BIGVIA is expanded (for the hole -part, see the previous table MBK_TO_RDS_BIGVIA_HOLE). The rule give for each -metal:

-
    -
  1. The delta-with (have to ask Franck).
    2. -
  2. The overhang, the length the real rectangle is expanded on each side from -the symbolic rectange.
    3. -
-

Example:

-
-TABLE MBK_TO_RDS_BIGVIA_METAL
-
-    CONT_VIA  RDS_ALU1 0.0 0.09  ALL \
-              RDS_ALU2 0.0 0.09  ALL
-
-    CONT_VIA2 RDS_ALU2 0.0 0.09  ALL \
-              RDS_ALU3 0.0 0.09  ALL
-
-    CONT_VIA3 RDS_ALU3 0.0 0.09  ALL \
-              RDS_ALU4 0.0 0.09  ALL
-
-    CONT_VIA4 RDS_ALU4 0.0 0.09  ALL \
-              RDS_ALU5 0.0 0.09  ALL
-
-    CONT_VIA5 RDS_ALU5 0.0 0.09  ALL \
-              RDS_ALU6 0.0 0.18  ALL
-
-END
-
-


-
-
-

The MBK_WIRESETTING table

-

From a strict standpoint this table shouldn't be here but put in a separate -configuration file, because it contains informations only used by the symbolic -layout tools (ocp, nero, ring).

-

This table defines the cell gauge the routing pitch and minimal (symbolic) -wire width and minimal spacing for the routers. They are patly redundant.

-

Example:

-
-TABLE MBK_WIRESETTING
-
-    X_GRID             10
-    Y_GRID             10
-    Y_SLICE           100
-    WIDTH_VDD          12
-    WIDTH_VSS          12
-    TRACK_WIDTH_ALU8    0
-    TRACK_WIDTH_ALU7    4
-    TRACK_WIDTH_ALU6    4
-    TRACK_WIDTH_ALU5    4
-    TRACK_WIDTH_ALU4    3
-    TRACK_WIDTH_ALU3    3
-    TRACK_WIDTH_ALU2    3
-    TRACK_WIDTH_ALU1    3
-    TRACK_SPACING_ALU8  0
-    TRACK_SPACING_ALU7  4
-    TRACK_SPACING_ALU6  4
-    TRACK_SPACING_ALU5  4
-    TRACK_SPACING_ALU4  4
-    TRACK_SPACING_ALU3  4
-    TRACK_SPACING_ALU2  4
-    TRACK_SPACING_ALU1  3
-
-END
-
-
-
-
-
- - diff --git a/documentation/RDS/RDS.pdf b/documentation/RDS/RDS.pdf new file mode 100644 index 00000000..607db0b0 Binary files /dev/null and b/documentation/RDS/RDS.pdf differ diff --git a/documentation/RDS/RDS_HTML.rst b/documentation/RDS/RDS_HTML.rst deleted file mode 100644 index c16f2565..00000000 --- a/documentation/RDS/RDS_HTML.rst +++ /dev/null @@ -1,5 +0,0 @@ - -.. -*- Mode: rst -*- - -.. include:: HTML_defs.rst -.. include:: RDS.rst diff --git a/documentation/RDS/RDS_LaTeX.rst b/documentation/RDS/RDS_LaTeX.rst deleted file mode 100644 index 87ae6c88..00000000 --- a/documentation/RDS/RDS_LaTeX.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. -*- Mode: rst -*- - -.. include:: LaTeX_defs.rst -.. include:: RDS.rst diff --git a/documentation/RDS/RDS.rst b/documentation/RDS/RDSpage.rst similarity index 93% rename from documentation/RDS/RDS.rst rename to documentation/RDS/RDSpage.rst index ab352843..be3aa644 100644 --- a/documentation/RDS/RDS.rst +++ b/documentation/RDS/RDSpage.rst @@ -1,18 +1,7 @@ .. -*- Mode: rst -*- -.. role:: ul -.. role:: cb -.. role:: sc -.. role:: fboxtt +.. include:: ../etc/definitions.rst -.. Acronyms & names. -.. |GNU| replace:: :sc:`gnu` -.. |LGPL| replace:: :sc:`lgpl` -.. |GPL| replace:: :sc:`gpl` -.. |UPMC| replace:: :sc:`upmc` -.. |Alliance| replace:: :sc:`Alliance` -.. |MBK| replace:: :sc:`mbk` -.. |RDS| replace:: :sc:`rds` .. Tools .. |ocp| replace:: ``ocp`` @@ -48,7 +37,6 @@ .. |PTIE| replace:: ``PTIE`` .. |NDIF| replace:: ``NDIF`` .. |PDIF| replace:: ``PDIF`` -.. |NWELL| replace:: ``NWELL`` .. |PWELL| replace:: ``PWELL`` .. |NTRANS| replace:: ``NTRANS`` .. |PTRANS| replace:: ``PTRANS`` @@ -68,26 +56,33 @@ .. |RDS_POLY| replace:: ``RDS_POLY`` .. |RDS_ALU1| replace:: ``RDS_ALU1`` +.. Stand-alone images. +.. |RDS_VW| image:: ./images/RDS_VW.png + :alt: RDS Variable Width Rule + :align: middle + :width: 60% -:Date: 26, september 2014 -:Authors: Jean-Paul Chaput -:Contact: -:Version: 0.2 +.. |RDS_LCW| image:: ./images/RDS_LCW.png + :alt: RDS Left Constant Width Rule + :align: middle + :width: 40% -|medskip| +.. |SegmentOrientation| image:: ./images/SegmentOrientation.png + :alt: Symbolic Segment Orientations + :align: middle + :width: 50% -**Disclaimer:** This document is still far from complete. +.. |BIGVIA_1| image:: ./images/bigvia-1.png + :alt: BIGVIA holes + :align: middle + :width: 40% -|medskip| - -========================================= -Symbolic to Real Conversion In Alliance -========================================= +.. |BIGVIA_2| image:: ./images/bigvia-2.png + :alt: BIGVIA holes overlap + :align: middle + :width: 40% -.. contents:: - -|medskip| |newpage| @@ -189,7 +184,7 @@ In |Alliance|, segments are oriented (up, down, left, right). This disambiguate the left or right side when using the ``LCW`` and ``RCW`` rules in the |RDS| file. It allows to generate, if needed, asymetric object in the real layout file. -|SegmentOrientation| +|bcenter| |SegmentOrientation| |ecenter| |newpage| @@ -261,14 +256,14 @@ The translation method of a symbolic segment is as follow: original one. In those rules, the third number is not used, it is only here to make the life easier for the parser... - |RDS_VW| + |bcenter| |RDS_VW| |ecenter| * |LCW| or |RCW| for Left/Right Constant Width, create an off-center rectangle of fixed width relatively to the real segment. Note that the ``SP`` number is the distance *between the edge* of the real segment and the edge of the generated real rectangle (*not* from the axis). It is often zero. - |RDS_LCW| + |bcenter| |RDS_LCW| |ecenter| |newpage| @@ -383,11 +378,11 @@ The |MBK_TO_RDS_BIGVIA_HOLE| table define the global hole matrix for the whole design. The first number is the individual hole side and the second the grid step (edge to edge). The figure below show the hole generation. -|BIGVIA_1| +|bcenter| |BIGVIA_1| |ecenter| Example of BIGVIA overlap: -|BIGVIA_2| +|bcenter| |BIGVIA_2| |ecenter| Example: :: @@ -407,8 +402,6 @@ Example: :: ``1.5 * step``, the BIGVIA is demoted to a simple VIA. -|newpage| - The |MBK_TO_RDS_BIGVIA_METAL| table ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -438,12 +431,9 @@ Example: :: CONT_VIA5 RDS_ALU5 0.0 0.09 ALL \ RDS_ALU6 0.0 0.18 ALL - END -|newpage| - The |MBK_WIRESETTING| table ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/documentation/RDS/SoC.css b/documentation/RDS/SoC.css deleted file mode 100644 index 3744b6b4..00000000 --- a/documentation/RDS/SoC.css +++ /dev/null @@ -1,750 +0,0 @@ - -html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 96%; - font-family: "Open Sans", verdana, sans-serif; -} - -p, li { - text-align: justify; -} - -.sc { - font-variant: small-caps; - font-size: 120%; -} - -h1, h2, h3, h4, h5, h6 { - font-family: "Open Sans", verdana, sans-serif; -} - -h1 { text-align: center; - border-top: 2px solid #09550b; - border-bottom: 2px solid #09550b; - padding-top: 7pt; - padding-bottom: 7pt; - } -h2, h3, h4, h5, h6 { text-align: left; } -h1, h2, h3 { font-family: "Open Sans"; - } -h1 { font-weight: normal; font-size: 170%; padding-top: 7pt; margin-top: 25pt; } -h2 { font-weight: normal; font-size: 140%; padding-top: 7pt; margin-top: 25pt; } -h3 { font-weight: bold; font-size: 118%; padding-top: 7pt; margin-top: 25pt; } -h4 { font-weight: bold; font-size: 100%; } -h5 { font-style: italic; font-size: 100%; } -h6 { font-variant: small-caps; font-size: 100%; } - -body { - color: black; - background: white; - /* - background: #09550B; - background-color: white; - */ - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin: 0 0 0 0; - padding: 20pt; - width: 550pt; - margin-right: auto; - margin-left: auto; - margin-top: 20pt; - margin-bottom: 20pt; - -moz-box-shadow: 4px 4px 5px 3px #ccc; - -webkit-box-shadow: 4px 4px 5px 3px #ccc; - box-shadow: 4px 4px 5px 3px #ccc; -} - -hr { - color: #09550b; - border: 1px dotted #09550b; - border-style: none none dotted; - padding-top: 10pt; - padding-bottom: 10pt; -} - -div#contents { - margin: 30pt; - padding: 2pt 10pt; - background-color: #fff676; - -moz-box-shadow: 4px 4px 5px 2px #ccc; - -webkit-box-shadow: 4px 4px 5px 2px #ccc; - box-shadow: 4px 4px 5px 2px #ccc; - -/* Shadow explanation: - * The shadow is a rectangle the same size as the box. It is then shifted - * blurred according to the following parameters. - * - * 1. The horizontal offset of the shadow, positive means the shadow will be - * on the right of the box, a negative offset will put the shadow on the - * left of the box. - * 2. The vertical offset of the shadow, a negative one means the box-shadow - * will be above the box, a positive one means the shadow will be below - * the box. - * 3. The blur radius (optional), if set to 0 the shadow will be sharp, - * the higher the number, the more blurred it will be. - * 4. The spread radius (optional), positive values increase the size of the - * shadow, negative values decrease the size. Default is 0 (the shadow is - * same size as blur). - * 5. Color - */ -} - - -div#centered { - margin-left: auto; - margin-right: auto; - text-align: center; -} - -pre, tt, code { - font-family: "courrier", "andale mono", monospace; - font-size: 100%; - white-space: pre; -} - -tt { - color: #09550b; -} - -pre.wiki, div.code, pre.literal-block { - font-size: 90%; - padding: 5pt; - margin-left: 4%; - margin-right: 4%; - border: dashed; - border-width: thin; - border-color: #FC8676; - background-color: #FCFCE1; -} - -a:link, a:active { - font-weight: normal; - text-decoration: none; - color: #09550b; - border-bottom: 1px dotted #09550b; -} - -a:hover, a:focus, a:visited { - font-weight: normal; - font-style: italic; - text-decoration: none; - /* - color: #A40010; - border-bottom: 1px dotted #A40010; - */ - color: #09550b; - border-bottom: 1px dotted #09550b; -} - -h1 a:link { - border-bottom: 0px; -} - -p.credit { - margin-left: 10%; - margin-right: 10%; - font-size: 110%; -} - -p.credit span.left { - float: left; - white-space: nowrap; -} - -p.credit span.right { - float: right; - white-space: nowrap; -} - -img.addborder { - border: 1px solid black; -} - -div#header { - margin: 0px; - padding: 0pt; - background-color: white; - display: inline-block; - width: 100%; -} - -div#header_logo { - margin: 0px; - padding: 10px 0px 10px 12pt; - background-color: white; - width: 40%; - float: left; -} - -div#header_menus { - background-color: white; - width: 55%; - float: right; - padding-top: 60pt; - padding-right: 10pt; - text-align: right; - font-size: 80%; -} - -div#header_menus ul { - padding-top: 45pt; - list-style: none; - text-align: right; - font-size: 80%; -} - -div#header_menus li { - padding: 0pt; - margin: 0pt; - display: inline; - white-space: nowrap; -} - -/* -div#header_menus a { - border-left: 1px solid #d7d7d7; - padding: 0 .75em; -} - -div#header_menus a.first { - border-left: none; -} -*/ - -div#header a:link, div#header a:active, div#header a:visited { - margin: 0pt; - padding: 0pt 5pt; - font-weight: normal; - color: black; - text-decoration: none; - border-bottom: 1px solid black; - border-left: 0px; - border-right: 0px; -} - -div#header a:hover, div#header a:focus { - margin: 0pt; - padding: 0pt 5pt; - font-weight: normal; - color: black; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; -} - -div#header a.current:link, div#header a.current:active, div#header a.current:visited { - margin: 0pt; - padding: 0pt 5pt; - font-weight: bold; - font-style: normal; - font-size: 120%; - color: white; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; - background-color: #09550b; -} - -div#header a.current:hover, div#header a.current:focus { - margin: 0pt; - padding: 0pt 5pt; - font-weight: bold; - font-style: normal; - font-size: 120%; - color: white; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; - background-color: #09550b; -} - -div#header_ancestors { - padding: 4px 0px 4px 12pt; - background-color: #09550B; - color: white; -} - -div#header_ancestors ul, div#header_ancestors * li { - display: inline; - list-style-type: none; - padding: 0px 0px 0px 0pt; -} - -div#header_ancestors a:link, div#header_ancestors a:active, div#header_ancestors a:visited { - font-weight: bold; - color: white; - text-decoration: none; - border-bottom: 0px; -} - -div#header_ancestors a:hover, div#header_ancestors a:focus { - font-weight: bold; - color: white; - text-decoration: underline; -} - -div#footer { - margin: 0px; - padding: 0px; - border-top: 1px dotted #09550b; - background-color: white; - display: inline-block; - width: 100%; - text-align: right; -} - -div#searchform { - width: 80%; - background-color: #ccffcd; - padding: 15pt 10pt 15pt 10pt; - margin-top: 50pt; - margin-bottom: 50pt; - margin-left: auto; - margin-right: auto; - text-align: center; -} - -div#searchform input#id_q { - background-color: white; - border: 1px solid #09550b; - padding: 2pt; - width: 80%; - font-size: 110%; - font-weight: bold; -} - -span.queryref { - font-weight: bold; -} - -div#searchform ul { - list-style: none; -} - -div#searchform li { - display: inline; -} - -hr#search_vs_results { - color: #09550b; - border: 2px dotted #09550b; - border-style: none none dotted; - margin-top: 0pt; - margin-bottom: 20pt; -} - -div#search_results { - width: 85%; - margin: auto; -} - -div#sidebar hr#separator { - color: white; - border: 0px; - margin-top: 0pt; - margin-bottom: 20pt; -} - -img.footer-logo { - height: 24px; - padding: 0px 2px; -} - -hr#site_vs_page { - color: white; - border: 3px dotted white; - border-style: none none dotted; - margin-top: 20pt; - margin-bottom: 20pt; -} - -div#sidebar { - /* - background: #09550B; - background: #ccffcd; - */ - background: white; -} - -div#sidebar div#sitemenu, div#sidebar div#pagemenu { - /* - background: white; - */ - background: #09550b; - width: 85%; - margin: auto; - padding: 5pt 10pt; -} - -div#sidebar * li { - text-align: left; -} - -div#sidebar * ul { - list-style-type: square; - padding-left: 12pt; -} - -div#sitemenu ul { - list-style-type: none; - padding-left: 0pt; -} - -div#sitemenu ul ul { - list-style-type: none; - padding-left: 0pt; -} - -div#sitemenu ul ul ul { - list-style-type: square; - padding-left: 12pt; -} - -div#sitemenu ul li ul li { - padding-top: 3pt; - padding-bottom: 5pt; - border-top: 1px dotted white; -} - -div#sitemenu ul li ul li ul li { - border-top: none; - padding-top: 1pt; - padding-bottom: 1pt; -} - -div#sitemenu ul li a:link, -div#sitemenu ul li a:active, -div#sitemenu ul lu a:visited -{ - font-size: 140%; - font-weight: bold; - border-bottom: none; -} - -div#sitemenu ul li a:focus, -div#sitemenu ul lu a:hover -{ - font-size: 140%; - font-weight: bold; - font-style: italic; - border-bottom: none; -} - -div#sitemenu ul ul li a:link, -div#sitemenu ul ul li a:active, -div#sitemenu ul ul lu a:visited, -div#sitemenu ul ul li a:focus, -div#sitemenu ul ul lu a:hover -{ - font-size: 90%; - font-weight: normal; - border-bottom: none; -/*border-bottom: 1px dotted white;*/ -} - -div#pagemenu ul { - list-style-type: none; - padding-left: 0pt; -} - -div#pagemenu ul ul { - list-style-type: none; - padding-left: 0pt; -} - -div#pagemenu ul ul ul { - padding-left: 12pt; -} - -div#pagemenu ul li ul li { - padding-top: 3pt; - padding-bottom: 5pt; - border-top: 1px dotted white; -} - -div#pagemenu ul li ul li ul li { - border-top: none; - padding-top: 1pt; - padding-bottom: 1pt; -} - -div#pagemenu ul li a:link, -div#pagemenu ul li a:active, -div#pagemenu ul lu a:visited -{ - font-size: 120%; - font-weight: bold; - border-bottom: none; -} - -div#pagemenu ul li a:focus, -div#pagemenu ul lu a:hover -{ - font-size: 120%; - font-weight: bold; - font-style: italic; - border-bottom: none; -} - -div#pagemenu ul ul li a:link, -div#pagemenu ul ul li a:active, -div#pagemenu ul ul lu a:visited, -div#pagemenu ul ul li a:focus, -div#pagemenu ul ul lu a:hover -{ - font-size: 90%; - font-weight: normal; - border-bottom: none; - /* - border-bottom: 1px dotted white; - */ -} - - -div#sidebar ul.ancestor * li { - padding-top: 0pt; -} - -div#sidebar ul { - padding-bottom: 8pt; -} - -div#sidebar a:link, div#sidebar a:active, div#sidebar a:visited { - /* - font-weight: normal; - */ - color: white; - text-align: left; - text-decoration: none; - border-bottom: 1px dotted white; -} - -div#sidebar a:hover, div#sidebar a:focus { - /* - font-weight: normal; - */ - color: white; - text-align: left; - text-decoration: none; - border-bottom: 1px dotted white; -} - -div#main { - border-left: 1px solid #09550b; -} - -div#main ul#summary { - list-style-type: square; - padding-left: 12pt; - font-size: 14pt; -} - -div#main ul#summary * ul { - padding-left: 12pt; - padding-bottom: 14pt; - font-size: 95%; -} - -div.code * { - background-color: #FCFCE1; -} - -div.note { - margin: 8px 2% 0px 2%; - border: 1px none #fff01c; - border-left-width: 4px; - border-left-style: solid; - padding: 1px 10pt 1px 55px; - background: #fff676 url('./images/clipboard.png') no-repeat 0% 50%;; - font-size: 90% -} - -div.error { - margin: 8px 2% 0px 2%; - border: 1px none #dd0000; - border-left-width: 4px; - border-left-style: solid; - padding: 1px 10pt 1px 55px; - background: #ffddcc url('./images/i-core.png') no-repeat 0% 50%;; - font-size: 90% -} - -p.admonition-title { - font-weight: bold; -} - -div.topic { - margin: 5pt; - padding: 2pt 10pt; - background-color: fff676; -} - -div.topic p.first { - font-weight: bold; -} - -table.wiki th, table th { - color: black; - background: #FFFFCC; -} - -table.docutils { - margin-left: 10%; - margin-right: 10%; -} - -table.wiki, table.wiki th, table.wiki td { border: 1px solid black; } -table.wiki th * p { text-align: center; } -table.wiki * p { margin: 0pt; } -table.wiki * blockquote { margin: 0pt; } -table { border-collapse: collapse; } -table th, table td { border: 1px solid black; - padding: 2px 10px 2px 10px; } - -table.docinfo { - margin-top: 10pt; - margin-left: auto; - margin-right: 0pt; - border: 10px solid #303030; - border-collapse: collapse; - background: #303030; - font-size: 90%; - font-family: sans-serif; -} - -table.docinfo tr { - border-bottom: 1px dotted white; -} - -th.docinfo-name, -table.docinfo td, -table.docinfo td a:link, -table.docinfo td a:active, -table.docinfo td a:visited, -table.docinfo td a:focus, -table.docinfo td a:hover -{ - border: 0px solid white; - background: #303030; - color: white; - text-align: left; - font-weight: bold; -} - -th.docinfo-name { - font-weight: normal; -} - -table.docinfo td { - font-weight: bold; -} - -span.ul { - text-decoration: underline; -} - -* span.smallcaps { - /*font-variant: "small-caps";*/ - text-transform: "uppercase"; - font-size: "smaller"; -} - - -span.cb { - font-family: "andale mono", monospace; - font-weight: bold; - white-space: pre; -} - -span.fboxtt { - border: 1px solid black; - padding: 0px 4px; - font-family: "andale mono", monospace; - font-weight: bold; - white-space: pre; -} - -#notice.system-message, .notice.system-message { - color: black; - background: #DDFFDD; - padding-top: 5pt; - padding-bottom: 5pt; - border: 1px none #55BB55; - border-top-width: 4px; - border-top-style: solid; -} - -#content.error .message, div.system-message { - color: #550000; - background: #ffddcc; - border: 2px none #dd0000; - border-top-width: 4px; - border-top-style: solid; - padding: .5em; - margin: 1em 0; -} - -#main { - float: right; - width: 70%; - padding: 0pt; - margin: 0pt; - min-height: 700px; - background: white; -} - -div#main h1 { - border-bottom: 2px solid #09550b; -} - -div#main div.section h1 { - border-bottom: none; -} - -#cmscontent { - padding: 0pt 4% 10pt 4%; - margin: 0pt; -} - -div#htmlerrorcontents { - padding: 10pt 4% 10pt 4%; - margin: 0pt; -} - -div#htmlerrorcontents span.cs { - font-size: 80%; - font-family: "andale mono", monospace; - white-space: pre; -} - -div#htmlerrorcontents hr.lang_separator { - border: 1px dotted black; - border-style: none none dotted; - margin-top: 20pt; - margin-bottom: 10pt; -} - -#embedcontent { - border: 0pt; - padding: 0pt; - margin: 0pt; -} - -#sidebar { - float: left; - width: 29.9%; - padding: 0 0 0 0; - margin: 0 0 0 0; - color: white; - background: #09550B; - /* - min-height: 300px; - background: #f2f2f2; - border-right: 1px solid #ccc; - padding: 0 0 0 10px; - */ -} diff --git a/documentation/RDS/images/RDS_LCW-eps-converted-to.pdf b/documentation/RDS/images/RDS_LCW-eps-converted-to.pdf deleted file mode 100644 index c78679f5..00000000 Binary files a/documentation/RDS/images/RDS_LCW-eps-converted-to.pdf and /dev/null differ diff --git a/documentation/RDS/images/RDS_LCW.eps b/documentation/RDS/images/RDS_LCW.eps deleted file mode 100644 index 78b0a9e1..00000000 --- a/documentation/RDS/images/RDS_LCW.eps +++ /dev/null @@ -1,238 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: RDS_LCW.fig -%%Creator: fig2dev Version 3.2 Patchlevel 5 -%%CreationDate: Mon Sep 15 18:23:48 2014 -%%For: jpc@lepka (Jean-Paul Chaput) -%%BoundingBox: 0 0 233 348 -%Magnification: 0.8000 -%%EndComments -/$F2psDict 200 dict def -$F2psDict begin -$F2psDict /mtrx matrix put -/col-1 {0 setgray} bind def -/col0 {0.000 0.000 0.000 srgb} bind def -/col1 {0.000 0.000 1.000 srgb} bind def -/col2 {0.000 1.000 0.000 srgb} bind def -/col3 {0.000 1.000 1.000 srgb} bind def -/col4 {1.000 0.000 0.000 srgb} bind def -/col5 {1.000 0.000 1.000 srgb} bind def -/col6 {1.000 1.000 0.000 srgb} bind def -/col7 {1.000 1.000 1.000 srgb} bind def -/col8 {0.000 0.000 0.560 srgb} bind def -/col9 {0.000 0.000 0.690 srgb} bind def -/col10 {0.000 0.000 0.820 srgb} bind def -/col11 {0.530 0.810 1.000 srgb} bind def -/col12 {0.000 0.560 0.000 srgb} bind def -/col13 {0.000 0.690 0.000 srgb} bind def -/col14 {0.000 0.820 0.000 srgb} bind def -/col15 {0.000 0.560 0.560 srgb} bind def -/col16 {0.000 0.690 0.690 srgb} bind def -/col17 {0.000 0.820 0.820 srgb} bind def -/col18 {0.560 0.000 0.000 srgb} bind def -/col19 {0.690 0.000 0.000 srgb} bind def -/col20 {0.820 0.000 0.000 srgb} bind def -/col21 {0.560 0.000 0.560 srgb} bind def -/col22 {0.690 0.000 0.690 srgb} bind def -/col23 {0.820 0.000 0.820 srgb} bind def -/col24 {0.500 0.190 0.000 srgb} bind def -/col25 {0.630 0.250 0.000 srgb} bind def -/col26 {0.750 0.380 0.000 srgb} bind def -/col27 {1.000 0.500 0.500 srgb} bind def -/col28 {1.000 0.630 0.630 srgb} bind def -/col29 {1.000 0.750 0.750 srgb} bind def -/col30 {1.000 0.880 0.880 srgb} bind def -/col31 {1.000 0.840 0.000 srgb} bind def - -end -save -newpath 0 348 moveto 0 0 lineto 233 0 lineto 233 348 lineto closepath clip newpath --114.1 389.4 translate -1 -1 scale - -/cp {closepath} bind def -/ef {eofill} bind def -/gr {grestore} bind def -/gs {gsave} bind def -/sa {save} bind def -/rs {restore} bind def -/l {lineto} bind def -/m {moveto} bind def -/rm {rmoveto} bind def -/n {newpath} bind def -/s {stroke} bind def -/sh {show} bind def -/slc {setlinecap} bind def -/slj {setlinejoin} bind def -/slw {setlinewidth} bind def -/srgb {setrgbcolor} bind def -/rot {rotate} bind def -/sc {scale} bind def -/sd {setdash} bind def -/ff {findfont} bind def -/sf {setfont} bind def -/scf {scalefont} bind def -/sw {stringwidth} bind def -/tr {translate} bind def -/tnt {dup dup currentrgbcolor - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} - bind def -/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul - 4 -2 roll mul srgb} bind def -/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def -/$F2psEnd {$F2psEnteredState restore end} def - -$F2psBegin -10 setmiterlimit -0 slj 0 slc - 0.04800 0.04800 sc -% -% Fig objects follow -% -% -% here starts figure with depth 60 -% Polyline -0 slj -0 slc -15.000 slw -n 3900 5700 m 3900 2700 l 4800 2700 l 4800 5700 l - cp gs col18 0.50 tnt ef gr gs col18 s gr -% here ends figure; -% -% here starts figure with depth 55 -% Polyline -0 slj -0 slc -15.000 slw -n 5100 6600 m 5100 1800 l 6300 1800 l 6300 6600 l - cp gs col7 1.00 shd ef gr gs col0 s gr -% here ends figure; -% -% here starts figure with depth 50 -% Polyline -0 slj -0 slc -45.000 slw -n 5625 1725 m - 5775 1875 l gs col0 s gr -% Polyline -n 5625 1875 m - 5775 1725 l gs col0 s gr -% Polyline -n 5625 6525 m - 5775 6675 l gs col0 s gr -% Polyline -n 5625 6675 m - 5775 6525 l gs col0 s gr -% Polyline -15.000 slw -n 2400 900 m 5775 900 l 5775 1275 l 2400 1275 l - cp gs col0 s gr -/Courier-Bold ff 300.00 scf sf -2550 1200 m -gs 1 -1 sc (LCW) col18 sh gr -/Courier-Bold ff 300.00 scf sf -3450 1200 m -gs 1 -1 sc (dL) col18 sh gr -/Courier-Bold ff 300.00 scf sf -5250 1200 m -gs 1 -1 sc (SP) col18 sh gr -/Courier-Bold ff 300.00 scf sf -4350 1200 m -gs 1 -1 sc (W) col18 sh gr -% Polyline - [90 45 15 45] 0 sd -n 5700 1800 m - 5700 6600 l gs col0 s gr [] 0 sd -% Polyline -7.500 slw -n 3225 2700 m - 3825 2700 l gs col0 s gr -% Polyline -n 5025 1800 m - 3225 1800 l gs col0 s gr -% Polyline -n 3825 5700 m - 3225 5700 l gs col0 s gr -% Polyline -n 5025 6600 m - 3225 6600 l gs col0 s gr -% Polyline -n 3900 5775 m - 3900 7575 l gs col0 s gr -% Polyline -n 4800 5775 m - 4800 7575 l gs col0 s gr -% Polyline -n 5100 6675 m 5100 6900 l 5400 7200 l - 5400 7575 l gs col0 s gr -% Polyline -gs clippath -3270 2564 m 3270 2715 l 3330 2715 l 3330 2564 l 3330 2564 l 3300 2684 l 3270 2564 l cp -3330 1936 m 3330 1785 l 3270 1785 l 3270 1936 l 3270 1936 l 3300 1816 l 3330 1936 l cp -eoclip -n 3300 1800 m - 3300 2700 l gs col0 s gr gr - -% arrowhead -n 3330 1936 m 3300 1816 l 3270 1936 l 3330 1936 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 3270 2564 m 3300 2684 l 3330 2564 l 3270 2564 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -3270 6464 m 3270 6615 l 3330 6615 l 3330 6464 l 3330 6464 l 3300 6584 l 3270 6464 l cp -3330 5836 m 3330 5685 l 3270 5685 l 3270 5836 l 3270 5836 l 3300 5716 l 3330 5836 l cp -eoclip -n 3300 5700 m - 3300 6600 l gs col0 s gr gr - -% arrowhead -n 3330 5836 m 3300 5716 l 3270 5836 l 3330 5836 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 3270 6464 m 3300 6584 l 3330 6464 l 3270 6464 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -4664 7530 m 4815 7530 l 4815 7470 l 4664 7470 l 4664 7470 l 4784 7500 l 4664 7530 l cp -4036 7470 m 3885 7470 l 3885 7530 l 4036 7530 l 4036 7530 l 3916 7500 l 4036 7470 l cp -eoclip -n 3900 7500 m - 4800 7500 l gs col0 s gr gr - -% arrowhead -n 4036 7470 m 3916 7500 l 4036 7530 l 4036 7470 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 4664 7530 m 4784 7500 l 4664 7470 l 4664 7530 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -5264 7530 m 5415 7530 l 5415 7470 l 5264 7470 l 5264 7470 l 5384 7500 l 5264 7530 l cp -4936 7470 m 4785 7470 l 4785 7530 l 4936 7530 l 4936 7530 l 4816 7500 l 4936 7470 l cp -eoclip -n 4800 7500 m - 5400 7500 l gs col0 s gr gr - -% arrowhead -n 4936 7470 m 4816 7500 l 4936 7530 l 4936 7470 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 5264 7530 m 5384 7500 l 5264 7470 l 5264 7530 l cp gs 0.00 setgray ef gr col0 s -% Polyline -n 2400 900 m 7200 900 l 7200 8100 l 2400 8100 l - cp gs col0 s gr -/Courier-Bold ff 200.00 scf sf -5100 7425 m -gs 1 -1 sc (SP) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -4350 7425 m -gs 1 -1 sc (W) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -3225 2250 m -gs 1 -1 sc 90.0 rot (dL) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -3225 6150 m -gs 1 -1 sc 90.0 rot (dL) dup sw pop 2 div neg 0 rm col0 sh gr -% here ends figure; -$F2psEnd -rs -showpage -%%Trailer -%EOF diff --git a/documentation/RDS/images/RDS_VW-eps-converted-to.pdf b/documentation/RDS/images/RDS_VW-eps-converted-to.pdf deleted file mode 100644 index 7051bba6..00000000 Binary files a/documentation/RDS/images/RDS_VW-eps-converted-to.pdf and /dev/null differ diff --git a/documentation/RDS/images/RDS_VW.eps b/documentation/RDS/images/RDS_VW.eps deleted file mode 100644 index 6761037f..00000000 --- a/documentation/RDS/images/RDS_VW.eps +++ /dev/null @@ -1,243 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: RDS_VW.fig -%%Creator: fig2dev Version 3.2 Patchlevel 5 -%%CreationDate: Mon Sep 15 18:24:04 2014 -%%For: jpc@lepka (Jean-Paul Chaput) -%%BoundingBox: 0 0 489 255 -%Magnification: 1.0000 -%%EndComments -/$F2psDict 200 dict def -$F2psDict begin -$F2psDict /mtrx matrix put -/col-1 {0 setgray} bind def -/col0 {0.000 0.000 0.000 srgb} bind def -/col1 {0.000 0.000 1.000 srgb} bind def -/col2 {0.000 1.000 0.000 srgb} bind def -/col3 {0.000 1.000 1.000 srgb} bind def -/col4 {1.000 0.000 0.000 srgb} bind def -/col5 {1.000 0.000 1.000 srgb} bind def -/col6 {1.000 1.000 0.000 srgb} bind def -/col7 {1.000 1.000 1.000 srgb} bind def -/col8 {0.000 0.000 0.560 srgb} bind def -/col9 {0.000 0.000 0.690 srgb} bind def -/col10 {0.000 0.000 0.820 srgb} bind def -/col11 {0.530 0.810 1.000 srgb} bind def -/col12 {0.000 0.560 0.000 srgb} bind def -/col13 {0.000 0.690 0.000 srgb} bind def -/col14 {0.000 0.820 0.000 srgb} bind def -/col15 {0.000 0.560 0.560 srgb} bind def -/col16 {0.000 0.690 0.690 srgb} bind def -/col17 {0.000 0.820 0.820 srgb} bind def -/col18 {0.560 0.000 0.000 srgb} bind def -/col19 {0.690 0.000 0.000 srgb} bind def -/col20 {0.820 0.000 0.000 srgb} bind def -/col21 {0.560 0.000 0.560 srgb} bind def -/col22 {0.690 0.000 0.690 srgb} bind def -/col23 {0.820 0.000 0.820 srgb} bind def -/col24 {0.500 0.190 0.000 srgb} bind def -/col25 {0.630 0.250 0.000 srgb} bind def -/col26 {0.750 0.380 0.000 srgb} bind def -/col27 {1.000 0.500 0.500 srgb} bind def -/col28 {1.000 0.630 0.630 srgb} bind def -/col29 {1.000 0.750 0.750 srgb} bind def -/col30 {1.000 0.880 0.880 srgb} bind def -/col31 {1.000 0.840 0.000 srgb} bind def - -end -save -newpath 0 255 moveto 0 0 lineto 489 0 lineto 489 255 lineto closepath clip newpath --106.7 306.7 translate -1 -1 scale - -/cp {closepath} bind def -/ef {eofill} bind def -/gr {grestore} bind def -/gs {gsave} bind def -/sa {save} bind def -/rs {restore} bind def -/l {lineto} bind def -/m {moveto} bind def -/rm {rmoveto} bind def -/n {newpath} bind def -/s {stroke} bind def -/sh {show} bind def -/slc {setlinecap} bind def -/slj {setlinejoin} bind def -/slw {setlinewidth} bind def -/srgb {setrgbcolor} bind def -/rot {rotate} bind def -/sc {scale} bind def -/sd {setdash} bind def -/ff {findfont} bind def -/sf {setfont} bind def -/scf {scalefont} bind def -/sw {stringwidth} bind def -/tr {translate} bind def -/tnt {dup dup currentrgbcolor - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} - bind def -/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul - 4 -2 roll mul srgb} bind def -/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def -/$F2psEnd {$F2psEnteredState restore end} def - -$F2psBegin -10 setmiterlimit -0 slj 0 slc - 0.06000 0.06000 sc -% -% Fig objects follow -% -% -% here starts figure with depth 60 -% Polyline -0 slj -0 slc -15.000 slw -n 2400 1800 m 8400 1800 l 8400 3600 l 2400 3600 l - cp gs col18 0.50 tnt ef gr gs col18 s gr -% here ends figure; -% -% here starts figure with depth 55 -% Polyline -0 slj -0 slc -15.000 slw -n 3000 2100 m 7800 2100 l 7800 3300 l 3000 3300 l - cp gs col7 1.00 shd ef gr gs col0 s gr -% here ends figure; -% -% here starts figure with depth 50 -% Polyline -0 slj -0 slc -15.000 slw -n 1800 900 m 5175 900 l 5175 1275 l 1800 1275 l - cp gs col0 s gr -/Courier-Bold ff 300.00 scf sf -1950 1200 m -gs 1 -1 sc (VW) col18 sh gr -/Courier-Bold ff 300.00 scf sf -2850 1200 m -gs 1 -1 sc (dL) col18 sh gr -/Courier-Bold ff 300.00 scf sf -3750 1200 m -gs 1 -1 sc (dW) col18 sh gr -/Courier-Bold ff 300.00 scf sf -4650 1200 m -gs 1 -1 sc (dX) col0 sh gr -% Polyline -7.500 slw -n 7875 2100 m - 9375 2100 l gs col0 s gr -% Polyline -n 8475 1800 m 8700 1800 l 9000 1500 l - 9375 1500 l gs col0 s gr -% Polyline -n 7875 3300 m - 9375 3300 l gs col0 s gr -% Polyline -n 8475 3600 m 8700 3600 l 9000 3900 l - 9375 3900 l gs col0 s gr -% Polyline -n 7800 3375 m - 7800 4575 l gs col0 s gr -% Polyline -n 8400 3675 m - 8400 4575 l gs col0 s gr -% Polyline -n 2400 3675 m - 2400 4575 l gs col0 s gr -% Polyline -n 3000 3375 m - 3000 4575 l gs col0 s gr -% Polyline -gs clippath -9270 1964 m 9270 2115 l 9330 2115 l 9330 1964 l 9330 1964 l 9300 2084 l 9270 1964 l cp -9330 1636 m 9330 1485 l 9270 1485 l 9270 1636 l 9270 1636 l 9300 1516 l 9330 1636 l cp -eoclip -n 9300 1500 m - 9300 2100 l gs col0 s gr gr - -% arrowhead -n 9330 1636 m 9300 1516 l 9270 1636 l 9330 1636 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 9270 1964 m 9300 2084 l 9330 1964 l 9270 1964 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -9270 3764 m 9270 3915 l 9330 3915 l 9330 3764 l 9330 3764 l 9300 3884 l 9270 3764 l cp -9330 3436 m 9330 3285 l 9270 3285 l 9270 3436 l 9270 3436 l 9300 3316 l 9330 3436 l cp -eoclip -n 9300 3300 m - 9300 3900 l gs col0 s gr gr - -% arrowhead -n 9330 3436 m 9300 3316 l 9270 3436 l 9330 3436 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 9270 3764 m 9300 3884 l 9330 3764 l 9270 3764 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -8264 4530 m 8415 4530 l 8415 4470 l 8264 4470 l 8264 4470 l 8384 4500 l 8264 4530 l cp -7936 4470 m 7785 4470 l 7785 4530 l 7936 4530 l 7936 4530 l 7816 4500 l 7936 4470 l cp -eoclip -n 7800 4500 m - 8400 4500 l gs col0 s gr gr - -% arrowhead -n 7936 4470 m 7816 4500 l 7936 4530 l 7936 4470 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 8264 4530 m 8384 4500 l 8264 4470 l 8264 4530 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -2864 4530 m 3015 4530 l 3015 4470 l 2864 4470 l 2864 4470 l 2984 4500 l 2864 4530 l cp -2536 4470 m 2385 4470 l 2385 4530 l 2536 4530 l 2536 4530 l 2416 4500 l 2536 4470 l cp -eoclip -n 2400 4500 m - 3000 4500 l gs col0 s gr gr - -% arrowhead -n 2536 4470 m 2416 4500 l 2536 4530 l 2536 4470 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 2864 4530 m 2984 4500 l 2864 4470 l 2864 4530 l cp gs 0.00 setgray ef gr col0 s -% Polyline -45.000 slw -n 2925 2625 m - 3075 2775 l gs col0 s gr -% Polyline -n 2925 2775 m - 3075 2625 l gs col0 s gr -% Polyline -n 7725 2625 m - 7875 2775 l gs col0 s gr -% Polyline -n 7725 2775 m - 7875 2625 l gs col0 s gr -% Polyline -15.000 slw - [90 45 15 45] 0 sd -n 3000 2700 m - 7800 2700 l gs col0 s gr [] 0 sd -% Polyline -7.500 slw -n 1800 900 m 9900 900 l 9900 5100 l 1800 5100 l - cp gs col0 s gr -/Courier-Bold ff 200.00 scf sf -2700 4425 m -gs 1 -1 sc (dL) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -8100 4425 m -gs 1 -1 sc (dL) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -9225 3600 m -gs 1 -1 sc 90.0 rot (dW/2) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -9225 1800 m -gs 1 -1 sc 90.0 rot (dW/2) dup sw pop 2 div neg 0 rm col0 sh gr -% here ends figure; -$F2psEnd -rs -showpage -%%Trailer -%EOF diff --git a/documentation/RDS/images/SegmentOrientation.eps b/documentation/RDS/images/SegmentOrientation.eps deleted file mode 100644 index 17802f3b..00000000 --- a/documentation/RDS/images/SegmentOrientation.eps +++ /dev/null @@ -1,283 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: SegmentOrientation.fig -%%Creator: fig2dev Version 3.2 Patchlevel 5 -%%CreationDate: Fri Sep 26 17:55:45 2014 -%%For: jpc@lepka (Jean-Paul Chaput) -%%BoundingBox: 0 0 507 471 -%Magnification: 1.0000 -%%EndComments -/$F2psDict 200 dict def -$F2psDict begin -$F2psDict /mtrx matrix put -/col-1 {0 setgray} bind def -/col0 {0.000 0.000 0.000 srgb} bind def -/col1 {0.000 0.000 1.000 srgb} bind def -/col2 {0.000 1.000 0.000 srgb} bind def -/col3 {0.000 1.000 1.000 srgb} bind def -/col4 {1.000 0.000 0.000 srgb} bind def -/col5 {1.000 0.000 1.000 srgb} bind def -/col6 {1.000 1.000 0.000 srgb} bind def -/col7 {1.000 1.000 1.000 srgb} bind def -/col8 {0.000 0.000 0.560 srgb} bind def -/col9 {0.000 0.000 0.690 srgb} bind def -/col10 {0.000 0.000 0.820 srgb} bind def -/col11 {0.530 0.810 1.000 srgb} bind def -/col12 {0.000 0.560 0.000 srgb} bind def -/col13 {0.000 0.690 0.000 srgb} bind def -/col14 {0.000 0.820 0.000 srgb} bind def -/col15 {0.000 0.560 0.560 srgb} bind def -/col16 {0.000 0.690 0.690 srgb} bind def -/col17 {0.000 0.820 0.820 srgb} bind def -/col18 {0.560 0.000 0.000 srgb} bind def -/col19 {0.690 0.000 0.000 srgb} bind def -/col20 {0.820 0.000 0.000 srgb} bind def -/col21 {0.560 0.000 0.560 srgb} bind def -/col22 {0.690 0.000 0.690 srgb} bind def -/col23 {0.820 0.000 0.820 srgb} bind def -/col24 {0.500 0.190 0.000 srgb} bind def -/col25 {0.630 0.250 0.000 srgb} bind def -/col26 {0.750 0.380 0.000 srgb} bind def -/col27 {1.000 0.500 0.500 srgb} bind def -/col28 {1.000 0.630 0.630 srgb} bind def -/col29 {1.000 0.750 0.750 srgb} bind def -/col30 {1.000 0.880 0.880 srgb} bind def -/col31 {1.000 0.840 0.000 srgb} bind def - -end -save -newpath 0 471 moveto 0 0 lineto 507 0 lineto 507 471 lineto closepath clip newpath --88.7 595.3 translate -1 -1 scale - -/cp {closepath} bind def -/ef {eofill} bind def -/gr {grestore} bind def -/gs {gsave} bind def -/sa {save} bind def -/rs {restore} bind def -/l {lineto} bind def -/m {moveto} bind def -/rm {rmoveto} bind def -/n {newpath} bind def -/s {stroke} bind def -/sh {show} bind def -/slc {setlinecap} bind def -/slj {setlinejoin} bind def -/slw {setlinewidth} bind def -/srgb {setrgbcolor} bind def -/rot {rotate} bind def -/sc {scale} bind def -/sd {setdash} bind def -/ff {findfont} bind def -/sf {setfont} bind def -/scf {scalefont} bind def -/sw {stringwidth} bind def -/tr {translate} bind def -/tnt {dup dup currentrgbcolor - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} - bind def -/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul - 4 -2 roll mul srgb} bind def - /DrawEllipse { - /endangle exch def - /startangle exch def - /yrad exch def - /xrad exch def - /y exch def - /x exch def - /savematrix mtrx currentmatrix def - x y tr xrad yrad sc 0 0 1 startangle endangle arc - closepath - savematrix setmatrix - } def - -/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def -/$F2psEnd {$F2psEnteredState restore end} def - -$F2psBegin -10 setmiterlimit -0 slj 0 slc - 0.06000 0.06000 sc -% -% Fig objects follow -% -% -% here starts figure with depth 60 -% Ellipse -15.000 slw -n 2775 4200 450 450 0 360 DrawEllipse gs col18 0.50 tnt ef gr gs col18 s gr - -% Polyline -0 slj -0 slc -45.000 slw -n 3300 2700 m 3900 2700 l 3900 5700 l 3300 5700 l - cp gs col0 s gr -% Polyline -7.500 slw - [60 30 15 30] 0 sd -n 3600 2700 m - 3600 5700 l gs col0 s gr [] 0 sd -% Polyline -45.000 slw -n 3450 5550 m - 3750 5850 l gs col0 s gr -% Polyline -n 3450 5850 m - 3750 5550 l gs col0 s gr -% Polyline -n 3600 2700 m - 3450 3000 l gs col0 s gr -% Polyline -n 3600 2700 m - 3750 3000 l gs col0 s gr -% Ellipse -15.000 slw -n 4425 4200 450 450 0 360 DrawEllipse gs col12 0.50 tnt ef gr gs col12 s gr - -% Polyline -45.000 slw -n 7500 5700 m 8100 5700 l 8100 2700 l 7500 2700 l - cp gs col0 s gr -% Polyline -7.500 slw - [60 30 15 30] 0 sd -n 7800 5700 m - 7800 2700 l gs col0 s gr [] 0 sd -% Polyline -45.000 slw -n 7650 2850 m - 7950 2550 l gs col0 s gr -% Polyline -n 7650 2550 m - 7950 2850 l gs col0 s gr -% Polyline -n 7800 5700 m - 7650 5400 l gs col0 s gr -% Polyline -n 7800 5700 m - 7950 5400 l gs col0 s gr -% Ellipse -15.000 slw -n 6975 4200 450 450 0 360 DrawEllipse gs col12 0.50 tnt ef gr gs col12 s gr - -% Ellipse -n 8625 4200 450 450 0 360 DrawEllipse gs col18 0.50 tnt ef gr gs col18 s gr - -% Polyline -45.000 slw -n 6300 8400 m 6300 7800 l 9300 7800 l 9300 8400 l - cp gs col0 s gr -% Polyline -7.500 slw - [60 30 15 30] 0 sd -n 6300 8100 m - 9300 8100 l gs col0 s gr [] 0 sd -% Polyline -45.000 slw -n 9150 8250 m - 9450 7950 l gs col0 s gr -% Polyline -n 9450 8250 m - 9150 7950 l gs col0 s gr -% Polyline -n 6300 8100 m - 6600 8250 l gs col0 s gr -% Polyline -n 6300 8100 m - 6600 7950 l gs col0 s gr -% Ellipse -15.000 slw -n 7800 8925 450 450 0 360 DrawEllipse gs col18 0.50 tnt ef gr gs col18 s gr - -% Ellipse -n 7800 7275 450 450 0 360 DrawEllipse gs col12 0.50 tnt ef gr gs col12 s gr - -% Polyline -45.000 slw -n 5100 7800 m 5100 8400 l 2100 8400 l 2100 7800 l - cp gs col0 s gr -% Polyline -7.500 slw - [60 30 15 30] 0 sd -n 5100 8100 m - 2100 8100 l gs col0 s gr [] 0 sd -% Polyline -45.000 slw -n 2250 7950 m - 1950 8250 l gs col0 s gr -% Polyline -n 1950 7950 m - 2250 8250 l gs col0 s gr -% Polyline -n 5100 8100 m - 4800 7950 l gs col0 s gr -% Polyline -n 5100 8100 m - 4800 8250 l gs col0 s gr -% Ellipse -15.000 slw -n 3525 7275 450 450 0 360 DrawEllipse gs col18 0.50 tnt ef gr gs col18 s gr - -% Ellipse -n 3525 8925 450 450 0 360 DrawEllipse gs col12 0.50 tnt ef gr gs col12 s gr - -% here ends figure; -% -% here starts figure with depth 50 -/Courier-Bold ff 200.00 scf sf -2775 4275 m -gs 1 -1 sc (left) dup sw pop 2 div neg 0 rm col18 sh gr -/Courier-Bold ff 200.00 scf sf -4425 4275 m -gs 1 -1 sc (right) dup sw pop 2 div neg 0 rm col12 sh gr -/Courier-Bold ff 200.00 scf sf -6975 4275 m -gs 1 -1 sc (right) dup sw pop 2 div neg 0 rm col12 sh gr -/Courier-Bold ff 200.00 scf sf -8625 4275 m -gs 1 -1 sc (left) dup sw pop 2 div neg 0 rm col18 sh gr -/Courier-Bold ff 200.00 scf sf -7800 9000 m -gs 1 -1 sc (left) dup sw pop 2 div neg 0 rm col18 sh gr -/Courier-Bold ff 200.00 scf sf -7800 7350 m -gs 1 -1 sc (right) dup sw pop 2 div neg 0 rm col12 sh gr -/Courier-Bold ff 200.00 scf sf -3525 7350 m -gs 1 -1 sc (left) dup sw pop 2 div neg 0 rm col18 sh gr -/Courier-Bold ff 200.00 scf sf -3525 9000 m -gs 1 -1 sc (right) dup sw pop 2 div neg 0 rm col12 sh gr -% Polyline -0 slj -0 slc -15.000 slw -n 5700 2100 m - 5700 9900 l gs col0 s gr -% Polyline -n 1500 6300 m - 9900 6300 l gs col0 s gr -% Polyline -n 1500 2100 m 9900 2100 l 9900 9900 l 1500 9900 l - cp gs col0 s gr -/Courier-Bold ff 266.67 scf sf -1650 2400 m -gs 1 -1 sc (Up) col0 sh gr -/Courier-Bold ff 266.67 scf sf -1650 6600 m -gs 1 -1 sc (Right) col0 sh gr -/Courier-Bold ff 266.67 scf sf -5850 6600 m -gs 1 -1 sc (Left) col0 sh gr -/Courier-Bold ff 266.67 scf sf -5850 2400 m -gs 1 -1 sc (Down) col0 sh gr -% here ends figure; -$F2psEnd -rs -showpage -%%Trailer -%EOF diff --git a/documentation/RDS/images/bigvia-1.eps b/documentation/RDS/images/bigvia-1.eps deleted file mode 100644 index 0e990719..00000000 --- a/documentation/RDS/images/bigvia-1.eps +++ /dev/null @@ -1,259 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: bigvia-1.fig -%%Creator: fig2dev Version 3.2 Patchlevel 5 -%%CreationDate: Fri Sep 26 22:43:59 2014 -%%For: jpc@lepka (Jean-Paul Chaput) -%%BoundingBox: 0 0 275 269 -%Magnification: 0.7000 -%%EndComments -/$F2psDict 200 dict def -$F2psDict begin -$F2psDict /mtrx matrix put -/col-1 {0 setgray} bind def -/col0 {0.000 0.000 0.000 srgb} bind def -/col1 {0.000 0.000 1.000 srgb} bind def -/col2 {0.000 1.000 0.000 srgb} bind def -/col3 {0.000 1.000 1.000 srgb} bind def -/col4 {1.000 0.000 0.000 srgb} bind def -/col5 {1.000 0.000 1.000 srgb} bind def -/col6 {1.000 1.000 0.000 srgb} bind def -/col7 {1.000 1.000 1.000 srgb} bind def -/col8 {0.000 0.000 0.560 srgb} bind def -/col9 {0.000 0.000 0.690 srgb} bind def -/col10 {0.000 0.000 0.820 srgb} bind def -/col11 {0.530 0.810 1.000 srgb} bind def -/col12 {0.000 0.560 0.000 srgb} bind def -/col13 {0.000 0.690 0.000 srgb} bind def -/col14 {0.000 0.820 0.000 srgb} bind def -/col15 {0.000 0.560 0.560 srgb} bind def -/col16 {0.000 0.690 0.690 srgb} bind def -/col17 {0.000 0.820 0.820 srgb} bind def -/col18 {0.560 0.000 0.000 srgb} bind def -/col19 {0.690 0.000 0.000 srgb} bind def -/col20 {0.820 0.000 0.000 srgb} bind def -/col21 {0.560 0.000 0.560 srgb} bind def -/col22 {0.690 0.000 0.690 srgb} bind def -/col23 {0.820 0.000 0.820 srgb} bind def -/col24 {0.500 0.190 0.000 srgb} bind def -/col25 {0.630 0.250 0.000 srgb} bind def -/col26 {0.750 0.380 0.000 srgb} bind def -/col27 {1.000 0.500 0.500 srgb} bind def -/col28 {1.000 0.630 0.630 srgb} bind def -/col29 {1.000 0.750 0.750 srgb} bind def -/col30 {1.000 0.880 0.880 srgb} bind def -/col31 {1.000 0.840 0.000 srgb} bind def - -end -save -newpath 0 269 moveto 0 0 lineto 275 0 lineto 275 269 lineto closepath clip newpath --3.2 331.3 translate -1 -1 scale - -/cp {closepath} bind def -/ef {eofill} bind def -/gr {grestore} bind def -/gs {gsave} bind def -/sa {save} bind def -/rs {restore} bind def -/l {lineto} bind def -/m {moveto} bind def -/rm {rmoveto} bind def -/n {newpath} bind def -/s {stroke} bind def -/sh {show} bind def -/slc {setlinecap} bind def -/slj {setlinejoin} bind def -/slw {setlinewidth} bind def -/srgb {setrgbcolor} bind def -/rot {rotate} bind def -/sc {scale} bind def -/sd {setdash} bind def -/ff {findfont} bind def -/sf {setfont} bind def -/scf {scalefont} bind def -/sw {stringwidth} bind def -/tr {translate} bind def -/tnt {dup dup currentrgbcolor - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} - bind def -/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul - 4 -2 roll mul srgb} bind def -/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def -/$F2psEnd {$F2psEnteredState restore end} def - -$F2psBegin -10 setmiterlimit -0 slj 0 slc - 0.04200 0.04200 sc -% -% Fig objects follow -% -% -% here starts figure with depth 60 -% Polyline -0 slj -0 slc -0.000 slw -n 900 6300 m 1500 6300 l 1500 6900 l 900 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 2400 6300 m 3000 6300 l 3000 6900 l 2400 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 3900 6300 m 4500 6300 l 4500 6900 l 3900 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 6300 m 6000 6300 l 6000 6900 l 5400 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 4800 m 1500 4800 l 1500 5400 l 900 5400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 3300 m 1500 3300 l 1500 3900 l 900 3900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 1800 m 1500 1800 l 1500 2400 l 900 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 2400 4800 m 3000 4800 l 3000 5400 l 2400 5400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 2400 3300 m 3000 3300 l 3000 3900 l 2400 3900 l - cp gs col7 0.00 shd ef gr -% Polyline -n 3900 3300 m 4500 3300 l 4500 3900 l 3900 3900 l - cp gs col7 0.00 shd ef gr -% Polyline -n 3900 4800 m 4500 4800 l 4500 5400 l 3900 5400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 2400 1800 m 3000 1800 l 3000 2400 l 2400 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 3900 1800 m 4500 1800 l 4500 2400 l 3900 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 1800 m 6000 1800 l 6000 2400 l 5400 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 3300 m 6000 3300 l 6000 3900 l 5400 3900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 4800 m 6000 4800 l 6000 5400 l 5400 5400 l - cp gs col7 0.80 shd ef gr -% Polyline -7.500 slw -n 5400 6900 m - 5400 7875 l gs col7 0.00 shd ef gr gs col0 s gr -% Polyline -n 6000 6900 m 6000 7200 l 6300 7500 l - 6300 7875 l gs col0 s gr -% Polyline -n 1500 5775 m - 1500 7875 l gs col0 s gr -% Polyline -n 1425 5700 m - 225 5700 l gs col0 s gr -% Polyline -n 1425 2700 m - 225 2700 l gs col0 s gr -% Polyline -gs clippath -270 5564 m 270 5715 l 330 5715 l 330 5564 l 330 5564 l 300 5684 l 270 5564 l cp -330 2836 m 330 2685 l 270 2685 l 270 2836 l 270 2836 l 300 2716 l 330 2836 l cp -eoclip -n 300 2700 m - 300 5700 l gs col0 s gr gr - -% arrowhead -n 330 2836 m 300 2716 l 270 2836 l 330 2836 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 270 5564 m 300 5684 l 330 5564 l 270 5564 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -4364 7830 m 4515 7830 l 4515 7770 l 4364 7770 l 4364 7770 l 4484 7800 l 4364 7830 l cp -1636 7770 m 1485 7770 l 1485 7830 l 1636 7830 l 1636 7830 l 1516 7800 l 1636 7770 l cp -eoclip -n 1500 7800 m - 4500 7800 l gs col0 s gr gr - -% arrowhead -n 1636 7770 m 1516 7800 l 1636 7830 l 1636 7770 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 4364 7830 m 4484 7800 l 4364 7770 l 4364 7830 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -5264 7830 m 5415 7830 l 5415 7770 l 5264 7770 l 5264 7770 l 5384 7800 l 5264 7830 l cp -4636 7770 m 4485 7770 l 4485 7830 l 4636 7830 l 4636 7830 l 4516 7800 l 4636 7770 l cp -eoclip -n 4500 7800 m - 5400 7800 l gs col0 s gr gr - -% arrowhead -n 4636 7770 m 4516 7800 l 4636 7830 l 4636 7770 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 5264 7830 m 5384 7800 l 5264 7770 l 5264 7830 l cp gs 0.00 setgray ef gr col0 s -% Polyline -gs clippath -6164 7830 m 6315 7830 l 6315 7770 l 6164 7770 l 6164 7770 l 6284 7800 l 6164 7830 l cp -5536 7770 m 5385 7770 l 5385 7830 l 5536 7830 l 5536 7830 l 5416 7800 l 5536 7770 l cp -eoclip -n 5400 7800 m - 6300 7800 l gs col0 s gr gr - -% arrowhead -n 5536 7770 m 5416 7800 l 5536 7830 l 5536 7770 l cp gs 0.00 setgray ef gr col0 s -% arrowhead -n 6164 7830 m 6284 7800 l 6164 7770 l 6164 7830 l cp gs 0.00 setgray ef gr col0 s -% Polyline -n 4500 5775 m - 4500 7875 l gs col0 s gr -/Courier-Bold ff 200.00 scf sf -3000 7725 m -gs 1 -1 sc (width) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -4950 7725 m -gs 1 -1 sc (step) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -5850 7725 m -gs 1 -1 sc (side) dup sw pop 2 div neg 0 rm col0 sh gr -/Courier-Bold ff 200.00 scf sf -225 4200 m -gs 1 -1 sc 90.0 rot (height) dup sw pop 2 div neg 0 rm col0 sh gr -% here ends figure; -% -% here starts figure with depth 50 -% Polyline -0 slj -0 slc -7.500 slw -gs clippath -6343 6960 m 6615 6960 l 6615 6840 l 6343 6840 l 6343 6840 l 6583 6900 l 6343 6960 l cp -eoclip -n 600 6900 m - 6600 6900 l gs col0 s gr gr - -% arrowhead -n 6343 6960 m 6583 6900 l 6343 6840 l col0 s -% Polyline -gs clippath -960 1757 m 960 1485 l 840 1485 l 840 1757 l 840 1757 l 900 1517 l 960 1757 l cp -eoclip -n 900 7200 m - 900 1500 l gs col0 s gr gr - -% arrowhead -n 960 1757 m 900 1517 l 840 1757 l col0 s -% Polyline -45.000 slw - [150 75 15 75] 0 sd -n 1500 2700 m 4500 2700 l 4500 5700 l 1500 5700 l - cp gs col0 s gr [] 0 sd -% here ends figure; -$F2psEnd -rs -showpage -%%Trailer -%EOF diff --git a/documentation/RDS/images/bigvia-2.eps b/documentation/RDS/images/bigvia-2.eps deleted file mode 100644 index 9073b7be..00000000 --- a/documentation/RDS/images/bigvia-2.eps +++ /dev/null @@ -1,184 +0,0 @@ -%!PS-Adobe-2.0 EPSF-2.0 -%%Title: bigvia-2.fig -%%Creator: fig2dev Version 3.2 Patchlevel 5 -%%CreationDate: Fri Sep 26 22:28:01 2014 -%%For: jpc@lepka (Jean-Paul Chaput) -%%BoundingBox: 0 0 254 254 -%Magnification: 0.7000 -%%EndComments -/$F2psDict 200 dict def -$F2psDict begin -$F2psDict /mtrx matrix put -/col-1 {0 setgray} bind def -/col0 {0.000 0.000 0.000 srgb} bind def -/col1 {0.000 0.000 1.000 srgb} bind def -/col2 {0.000 1.000 0.000 srgb} bind def -/col3 {0.000 1.000 1.000 srgb} bind def -/col4 {1.000 0.000 0.000 srgb} bind def -/col5 {1.000 0.000 1.000 srgb} bind def -/col6 {1.000 1.000 0.000 srgb} bind def -/col7 {1.000 1.000 1.000 srgb} bind def -/col8 {0.000 0.000 0.560 srgb} bind def -/col9 {0.000 0.000 0.690 srgb} bind def -/col10 {0.000 0.000 0.820 srgb} bind def -/col11 {0.530 0.810 1.000 srgb} bind def -/col12 {0.000 0.560 0.000 srgb} bind def -/col13 {0.000 0.690 0.000 srgb} bind def -/col14 {0.000 0.820 0.000 srgb} bind def -/col15 {0.000 0.560 0.560 srgb} bind def -/col16 {0.000 0.690 0.690 srgb} bind def -/col17 {0.000 0.820 0.820 srgb} bind def -/col18 {0.560 0.000 0.000 srgb} bind def -/col19 {0.690 0.000 0.000 srgb} bind def -/col20 {0.820 0.000 0.000 srgb} bind def -/col21 {0.560 0.000 0.560 srgb} bind def -/col22 {0.690 0.000 0.690 srgb} bind def -/col23 {0.820 0.000 0.820 srgb} bind def -/col24 {0.500 0.190 0.000 srgb} bind def -/col25 {0.630 0.250 0.000 srgb} bind def -/col26 {0.750 0.380 0.000 srgb} bind def -/col27 {1.000 0.500 0.500 srgb} bind def -/col28 {1.000 0.630 0.630 srgb} bind def -/col29 {1.000 0.750 0.750 srgb} bind def -/col30 {1.000 0.880 0.880 srgb} bind def -/col31 {1.000 0.840 0.000 srgb} bind def - -end -save -newpath 0 254 moveto 0 0 lineto 254 0 lineto 254 254 lineto closepath clip newpath --24.7 302.9 translate -1 -1 scale - -/cp {closepath} bind def -/ef {eofill} bind def -/gr {grestore} bind def -/gs {gsave} bind def -/sa {save} bind def -/rs {restore} bind def -/l {lineto} bind def -/m {moveto} bind def -/rm {rmoveto} bind def -/n {newpath} bind def -/s {stroke} bind def -/sh {show} bind def -/slc {setlinecap} bind def -/slj {setlinejoin} bind def -/slw {setlinewidth} bind def -/srgb {setrgbcolor} bind def -/rot {rotate} bind def -/sc {scale} bind def -/sd {setdash} bind def -/ff {findfont} bind def -/sf {setfont} bind def -/scf {scalefont} bind def -/sw {stringwidth} bind def -/tr {translate} bind def -/tnt {dup dup currentrgbcolor - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add - 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb} - bind def -/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul - 4 -2 roll mul srgb} bind def -/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def -/$F2psEnd {$F2psEnteredState restore end} def - -$F2psBegin -10 setmiterlimit -0 slj 0 slc - 0.04200 0.04200 sc -% -% Fig objects follow -% -% -% here starts figure with depth 60 -% Polyline -0 slj -0 slc -0.000 slw -n 900 6300 m 1500 6300 l 1500 6900 l 900 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 2400 6300 m 3000 6300 l 3000 6900 l 2400 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 3900 6300 m 4500 6300 l 4500 6900 l 3900 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 6300 m 6000 6300 l 6000 6900 l 5400 6900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 4800 m 1500 4800 l 1500 5400 l 900 5400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 3300 m 1500 3300 l 1500 3900 l 900 3900 l - cp gs col7 0.80 shd ef gr -% Polyline -n 900 1800 m 1500 1800 l 1500 2400 l 900 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 2400 4800 m 3000 4800 l 3000 5400 l 2400 5400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 2400 3300 m 3000 3300 l 3000 3900 l 2400 3900 l - cp gs col7 0.00 shd ef gr -% Polyline -n 3900 3300 m 4500 3300 l 4500 3900 l 3900 3900 l - cp gs col7 0.00 shd ef gr -% Polyline -n 3900 4800 m 4500 4800 l 4500 5400 l 3900 5400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 2400 1800 m 3000 1800 l 3000 2400 l 2400 2400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 5400 4800 m 6000 4800 l 6000 5400 l 5400 5400 l - cp gs col7 0.80 shd ef gr -% Polyline -n 3900 1800 m 4500 1800 l 4500 2400 l 3900 2400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 5400 1800 m 6000 1800 l 6000 2400 l 5400 2400 l - cp gs col7 0.00 shd ef gr -% Polyline -n 5400 3300 m 6000 3300 l 6000 3900 l 5400 3900 l - cp gs col7 0.00 shd ef gr -% here ends figure; -% -% here starts figure with depth 50 -% Polyline -0 slj -0 slc -7.500 slw -gs clippath -6343 6960 m 6615 6960 l 6615 6840 l 6343 6840 l 6343 6840 l 6583 6900 l 6343 6960 l cp -eoclip -n 600 6900 m - 6600 6900 l gs col0 s gr gr - -% arrowhead -n 6343 6960 m 6583 6900 l 6343 6840 l col0 s -% Polyline -gs clippath -960 1457 m 960 1185 l 840 1185 l 840 1457 l 840 1457 l 900 1217 l 960 1457 l cp -eoclip -n 900 7200 m - 900 1200 l gs col0 s gr gr - -% arrowhead -n 960 1457 m 900 1217 l 840 1457 l col0 s -% Polyline -45.000 slw - [150 75 15 75] 0 sd -n 1500 2700 m 4500 2700 l 4500 5700 l 1500 5700 l - cp gs col0 s gr [] 0 sd -% Polyline - [150 75 15 75] 0 sd -n 3600 1500 m 6300 1500 l 6300 4200 l 3600 4200 l - cp gs col0 s gr [] 0 sd -% here ends figure; -$F2psEnd -rs -showpage -%%Trailer -%EOF diff --git a/documentation/RDS/images/clipboard-eps-converted-to.pdf b/documentation/RDS/images/clipboard-eps-converted-to.pdf deleted file mode 100644 index 12640803..00000000 Binary files a/documentation/RDS/images/clipboard-eps-converted-to.pdf and /dev/null differ diff --git a/documentation/RDS/index.rst b/documentation/RDS/index.rst new file mode 100644 index 00000000..757d647e --- /dev/null +++ b/documentation/RDS/index.rst @@ -0,0 +1,26 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +:Date: 26, september 2014 +:Authors: Jean-Paul Chaput +:Contact: +:Version: 0.2 + + +**Disclaimer:** This document is still far from complete. + + +========================================= +Symbolic to Real Conversion in Alliance +========================================= + +Printable version of this document `RDS.pdf <../../../pdf/main/RDS.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + RDSpage.rst + diff --git a/documentation/RDS/pdfHeader.rst b/documentation/RDS/pdfHeader.rst new file mode 100644 index 00000000..4cce0e35 --- /dev/null +++ b/documentation/RDS/pdfHeader.rst @@ -0,0 +1,27 @@ +.. -*- mode: rst; explicit-buffer-name: "pdfHeader.rst" -*- + +.. include:: ../etc/definitions.rst + + +:Date: 26, september 2014 +:Authors: Jean-Paul Chaput +:Contact: +:Version: 0.2 + +|medskip| + +**Disclaimer:** This document is still far from complete. + +|medskip| + + +========================================= +Symbolic To Real Conversion in Alliance +========================================= + +|pagestylefancy| + + +.. contents:: + +|newpage| diff --git a/documentation/RDS/socstyle.tex b/documentation/RDS/socstyle.tex deleted file mode 100644 index af9f073e..00000000 --- a/documentation/RDS/socstyle.tex +++ /dev/null @@ -1,86 +0,0 @@ - - \usepackage[default,osfigures,scale=0.95]{opensans} - \usepackage{xspace} - \usepackage{fancyhdr} - \usepackage{graphicx} - \usepackage{enumitem} - \usepackage[sf,bf]{titlesec} - \usepackage{titletoc} - \usepackage[paper=a4paper,headheight=30pt,tmargin=1.5in,bmargin=1in]{geometry} -%\usepackage{layouts} - - \renewlist{itemize}{itemize}{9} - \setlist[itemize]{label=\textbullet} - -% The LaTeX Companion -- p. 204. -% Miniature display of the page layout. -%\newcommand{\showpage}{% -% \setlayoutscale{0.65}\setlabelfont{\tiny}% -% \printheadingsfalse\printparametersfalse% -% \currentpage\pagedesign% -%} - - \titlecontents{section}[0pc] - {\sffamily\bfseries} % above code. - {\contentslabel{1pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsection}[0pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsubsection}[1pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - - \newcommand{\key}[1]{\raisebox{-0.5\baselineskip}{\rule{0pt}{1.5\baselineskip}}\fbox{\textsf{#1}}} - - \newcommand{\DUroleul}[1]{\underline{#1}\xspace} - \newcommand{\DUrolesc}[1]{\textsc{#1}\xspace} - \newcommand{\DUrolecb}[1]{\textbf{\texttt{#1}}\xspace} - \newcommand{\DUrolefboxtt}[1]{\fbox{\texttt{#1}}\xspace} - - \newcommand{\DUtitlenote}[1]{\noindent\textbf{#1}\smallskip} - - \newcommand{\DUadmonitionnote}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5]{./images/clipboard.eps}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\DUtitleerror}[1]{\noindent\textbf{\color{red}#1}\smallskip} - - \newcommand{\DUadmonitionerror}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5]{./images/i-core.eps}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\UPMC} {\textsc{upmc}\xspace} - \newcommand{\LIP} {\textsc{lip6}\xspace} - \newcommand{\SoC} {\textsc{S}o\textsc{C}\xspace} - - \renewcommand{\headrulewidth}{0.2mm} - \renewcommand{\footrulewidth}{0.2mm} - \renewcommand{\sectionmark}[1]{\markboth{\thesection\ #1}{\thesection\ #1}} - \renewcommand{\subsectionmark}[1]{} - \lhead[]{\textsc{SoC} Documentation} - \rhead[]{September 2014} - \lfoot[]{\UPMC/\LIP/\SoC} - \rfoot[]{\thepage} - \cfoot[]{} - - \pagestyle{fancy} diff --git a/documentation/Stratus/Stratus.rst b/documentation/Stratus/Stratus.rst new file mode 100644 index 00000000..f61b2dac --- /dev/null +++ b/documentation/Stratus/Stratus.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +=================== +Stratus Reference +=================== + +The Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `Stratus `_ diff --git a/documentation/Unicorn/Unicorn.rst b/documentation/Unicorn/Unicorn.rst new file mode 100644 index 00000000..c972e5f0 --- /dev/null +++ b/documentation/Unicorn/Unicorn.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +=================== +Unicorn Reference +=================== + +The Unicorn C++ API reference is generated by Doxygen_ and is +available here: `Unicorn `_ diff --git a/documentation/UsersGuide/CMakeLists.txt b/documentation/UsersGuide/CMakeLists.txt deleted file mode 100644 index 870a0f14..00000000 --- a/documentation/UsersGuide/CMakeLists.txt +++ /dev/null @@ -1,36 +0,0 @@ -# -*- mode: CMAKE; explicit-buffer-name: "CMakeLists.txt" -*- - - set ( htmlInstallDir share/doc/coriolis2/en/html/users-guide ) - set ( latexInstallDir share/doc/coriolis2/en/latex/users-guide ) - - add_custom_target ( doc_HTML ALL - cd ${DOCUMENTATION_SOURCE_DIR}/UsersGuide - && rst2html --link-stylesheet --stylesheet=./SoC.css,./Pygments.css UsersGuide_HTML.rst UsersGuide.html ) - add_dependencies ( doc_HTML SoC.css Pygments.css UsersGuide_HTML.rst UsersGuide.rst ) - - add_custom_target ( doc_LaTeX ALL - cd ${DOCUMENTATION_SOURCE_DIR}/UsersGuide - && rst2latex --use-latex-toc --stylesheet=./socstyle.tex UsersGuide_LaTeX.rst UsersGuide-raw.tex - && sed 's, \\& \\\\multicolumn{2}{l|}{, \\& \\\\multicolumn{2}{p{0.6\\\\DUtablewidth}|}{,' UsersGuide-raw.tex > UsersGuide.tex - && latex UsersGuide - && latex UsersGuide - && latex UsersGuide - && dvipdfm UsersGuide - ) - add_dependencies ( doc_LaTeX socstyle.tex UsersGuide_LaTeX.rst UsersGuide.rst ) - - install ( DIRECTORY images/ - DESTINATION ${htmlInstallDir}/images - FILES_MATCHING PATTERN "*.png" ) - install ( FILES SoC.css - Pygments.css - UsersGuide.html DESTINATION ${htmlInstallDir} ) - - install ( DIRECTORY images/ - DESTINATION ${latexInstallDir}/images - FILES_MATCHING PATTERN "*.pdf" - PATTERN "*.eps" - PATTERN "*.bb" ) - - install ( FILES socstyle.tex - UsersGuide.tex DESTINATION ${latexInstallDir} ) diff --git a/documentation/UsersGuide/Configuration.rst b/documentation/UsersGuide/Configuration.rst new file mode 100644 index 00000000..e2da0de5 --- /dev/null +++ b/documentation/UsersGuide/Configuration.rst @@ -0,0 +1,342 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Coriolis Tools Documentation: file:///usr/share/doc/coriolis2/index.html + + + +.. |CoriolisSoftSchema| image:: ./images/Coriolis-Soft-Schema.png + :alt: Coriolis Software Schematic + :align: middle + :width: 60% + +|newpage| + + +Coriolis Configuration & Initialisation +======================================= + + +General Software Architecture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|Coriolis| has been build with respect of the classical paradigm that the +computational instensive parts have been written in C++, and almost +everything else in |Python|. To build the |Python| interface we used +two methods: + +* For self-contained modules :cb:`boost::python` (mainly in :cb:`vlsisapd`). +* For all modules based on |Hurricane|, we created our own wrappers due + to very specific requirements such as shared functions between modules + or C++/|Python| secure bi-directional object deletion. + +.. note:: **Python Documentation:** + Most of the documentation is related to the C++ API and implemetation of + the tools. However, the |Python| bindings have been created so they + mimic *as closely as possible* the C++ interface, so the documentation + applies to both languages with only minor syntactic changes. + +|bcenter| |CoriolisSoftSchema| |ecenter| + +All configuration & initialization files are Python scripts, despite their +|dot_conf| extention. From a syntactic point of view, there is no difference +between the system-wide configuration files and the user's configuration, +they may use the same Python helpers. +|medskip| + +Configuration is done in two stages: + +#. Selecting the symbolic technology. +#. Loading the complete configuration for the given technology. + +|newpage| + + +First Stage: Symbolic Technology Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|noindent| +The initialization process is done by executing, in order, the following +file(s): + ++-------+----------------------------------+----------------------------------------------+ +| Order | Meaning | File | ++=======+==================================+==============================================+ +| **1** | The system setting | :cb:`/etc/coriolis2/techno.conf` | ++-------+----------------------------------+----------------------------------------------+ +| **2** | The user's global setting | :cb:`${HOME}/.coriolis2/techno.py` | ++-------+----------------------------------+----------------------------------------------+ +| **3** | The user's local setting | :cb:`/.coriolis2/techno.py` | ++-------+----------------------------------+----------------------------------------------+ + +Thoses files must provides only two variables, the name of the symbolic technology +and the one of the real technology. For example: :: + + # -*- Mode:Python -*- + + symbolicTechno = 'cmos' + realTechno = 'hcmos9' + + +Second Stage: Technology Configuration Loading +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|noindent| +The :cb:`TECHNO` variable is set by the first stage and it's the name of the +symbolic technology. A directory of that name, with all the configuration files, +must exists in the configuration directory. In addition to the technology-specific +directories, a :cb:`common/` directory is there to provides a trunk for all the +identical datas across the various technologies. The initialization process is done +by executing, in order, the following file(s): + ++-------+----------------------------------+----------------------------------------------+ +| Order | Meaning | File | ++=======+==================================+==============================================+ +| **1** | The system initialization | :cb:`/etc/coriolis2//.conf` | ++-------+----------------------------------+----------------------------------------------+ +| **2** | The user's global initialization | :cb:`${HOME}/.coriolis2/settings.py` | ++-------+----------------------------------+----------------------------------------------+ +| **3** | The user's local initialization | :cb:`/.coriolis2/settings.py` | ++-------+----------------------------------+----------------------------------------------+ + +.. note:: *The loading policy is not hard-coded.* It is implemented + at Python level in :cb:`/etc/coriolis2/coriolisInit.py`, and thus may be easily be + amended to whatever site policy. + + The truly mandatory requirement is the existence of :cb:`coriolisInit.py` + which *must* contain a :cb:`coriolisConfigure()` function with no argument. + + +Configuration Helpers +~~~~~~~~~~~~~~~~~~~~~ + +To ease the writing of configuration files, a set of small helpers +is available. They allow to setup the configuration parameters through +simple assembly of tuples. The helpers are installed under the directory: :: + + /etc/coriolis2/ + +Where :cb:`/` is the root of the installation. + +|newpage| + + +.. _Alliance Helper: + +|Alliance| Helper +----------------- + +The configuration file must provide a :cb:`allianceConfig` tuple of +the form: :: + + cellsTop = '/usr/share/alliance/cells/' + + allianceConfig = \ + ( ( 'SYMBOLIC_TECHNOLOGY', helpers.sysConfDir+'/technology.symbolic.xml' ) + , ( 'REAL_TECHNOLOGY' , helpers.sysConfDir+'/technology.cmos130.s2r.xml') + , ( 'DISPLAY' , helpers.sysConfDir+'/display.xml' ) + , ( 'CATALOG' , 'CATAL') + , ( 'WORKING_LIBRARY' , '.') + , ( 'SYSTEM_LIBRARY' , ( (cellsTop+'sxlib' , Environment.Append) + , (cellsTop+'dp_sxlib', Environment.Append) + , (cellsTop+'ramlib' , Environment.Append) + , (cellsTop+'romlib' , Environment.Append) + , (cellsTop+'rflib' , Environment.Append) + , (cellsTop+'rf2lib' , Environment.Append) + , (cellsTop+'pxlib' , Environment.Append) ) ) + , ( 'SCALE_X' , 100) + , ( 'IN_LO' , 'vst') + , ( 'IN_PH' , 'ap') + , ( 'OUT_LO' , 'vst') + , ( 'OUT_PH' , 'ap') + , ( 'POWER' , 'vdd') + , ( 'GROUND' , 'vss') + , ( 'CLOCK' , '^ck.*') + , ( 'BLOCKAGE' , '^blockageNet*') + ) + + +|noindent| The example above shows the system configuration file, with all the +available settings. Some important remarks about thoses settings: + +* In it's configuration file, the user do not need to redefine all the settings, + just the one he wants to change. In most of the cases, the ``SYSTEM_LIBRARY``, + the ``WORKING_LIBRARY`` and the special net names (at this point there is not + much alternatives for the others settings). + +* ``SYSTEM_LIBRARY`` setting: Setting up the library search path. + Each library entry in the tuple will be added to the search path according + to the second parameter: + + * :cb:`Environment::Append`: append to the search path. + + * :cb:`Environment::Prepend`: insert in head of the search path. + + * :cb:`Environment::Replace`: look for a library of the same name and replace + it, whithout changing the search path order. If no library of that name + already exists, it is appended. + + A library is identified by it's name, this name is the last component of the + path name. For instance: ``/soc/alliance/sxlib`` will be named ``sxlib``. + Implementing the |Alliance| specification, when looking for a |Cell| ``name``, + the system will browse sequentially trought the library list and returns + the first |Cell| whose name match. + +* For ``POWER``, ``GROUND``, ``CLOCK`` and ``BLOCKAGE`` net names, a regular + expression (|GNU| regexp) is expected. + +* The ``helpers.sysConfDir`` variable is supplied by the helpers, it is the + directory in which the system-wide configuration files are locateds. + For a standard installation it would be: ``/soc/coriolis2``. + +.. * Trick and naming convention about ``SYMBOLIC_TECHNOLOGY``, ``REAL_TECHNOLOGY`` +.. and ``DISPLAY``. In the previous releases, thoses files where to read by +.. XML parsers, and still do if you triggers the XML compatibility mode. +.. But now, they have Python conterparts. In the configuration files, you +.. still have to name them as XML files, the Python file name will be +.. deduced from this one with thoses two translation rules: +.. +.. #. In the filename, all dots, except for the last (the file extention), +.. are replaced by underscores. +.. +.. #. The ``.xml`` extention is substituted by a ``.conf``. +.. +.. For the symbolic technology, it would give: :: +.. +.. /soc/coriolis2/technology.symbolic.xml +.. --> /soc/coriolis2/technology_symbolic.conf + +A typical user's configuration file would be: :: + + import os + + homeDir = os.getenv('HOME') + + allianceConfig = \ + ( ('WORKING_LIBRARY' , homeDir+'/worklib') + , ('SYSTEM_LIBRARY' , ( (homeDir+'/mylib', Environment.Append) ) ) + , ('POWER' , 'vdd.*') + , ('GROUND' , 'vss.*') + ) + + +Tools Configuration Helpers +--------------------------- + +All the tools uses the same helper to load their configuration (a.k.a. +*Configuration Helper*). Currently the following configuration system-wide +configuration files are defined: + +* :cb:`misc.conf`: commons settings or not belonging specifically to a tool. +* :cb:`etesian.conf`: for the |Etesian| tool. +* :cb:`kite.conf`: for the |Kite| tool. +* :cb:`stratus1.conf`: for the |stratus1| tool. + +Here is the contents of :cb:`etesian.conf`: :: + + # Etesian parameters. + parametersTable = \ + ( ('etesian.aspectRatio' , TypePercentage, 100 , { 'min':10, 'max':1000 } ) + , ('etesian.spaceMargin' , TypePercentage, 5 ) + , ('etesian.uniformDensity' , TypeBool , False ) + , ('etesian.routingDriven' , TypeBool , False ) + , ("etesian.effort" , TypeEnumerate , 2 + , { 'values':( ("Fast" , 1) + , ("Standard", 2) + , ("High" , 3) + , ("Extreme" , 4) ) } + ) + , ("etesian.graphics" , TypeEnumerate , 2 + , { 'values':( ("Show every step" , 1) + , ("Show lower bound" , 2) + , ("Show result only" , 3) ) } + ) + ) + + layoutTable = \ + ( (TypeTab , 'Etesian', 'etesian') + + , (TypeTitle , 'Placement area') + , (TypeOption, "etesian.aspectRatio" , "Aspect Ratio, X/Y (%)", 0 ) + , (TypeOption, "etesian.spaceMargin" , "Space Margin" , 1 ) + , (TypeRule ,) + , (TypeTitle , 'Etesian - Placer') + , (TypeOption, "etesian.uniformDensity", "Uniform density" , 0 ) + , (TypeOption, "etesian.routingDriven" , "Routing driven" , 0 ) + , (TypeOption, "etesian.effort" , "Placement effort" , 1 ) + , (TypeOption, "etesian.graphics" , "Placement view" , 1 ) + , (TypeRule ,) + ) + +|newpage| + + +Taxonomy of the file: + +* It must contains, at least, the two tables: + + * ``parametersTable``, defines & initialise the configuration variables. + + * ``layoutTables``, defines how the various parameters will be displayed + in the configuration window (:ref:`The Settings Tab`). + +* The ``parametersTable``, is a tuple (list) of tuples. Each entry in the list + describe a configuration parameter. In it's simplest form, it's a quadruplet + :cb:`(TypeOption, 'paramId', ParameterType, DefaultValue)` with: + + #. ``TypeOption``, tells that this tuple describe a parameter. + + #. ``paramId``, the identifier of the parameter. Identifiers are defined + by the tools. The list of parameters is detailed in each tool section. + + #. ``ParameterType``, the kind of parameter. Could be: + + * ``TypeBool``, boolean. + * ``TypeInt``, signed integer. + * ``TypeEnumerate``, enumerated type, needs extra entry. + * ``TypePercentage``, percentage, expressed between 0 and 100. + * ``TypeDouble``, float. + * ``TypeString``, character string. + + #. ``DefaultValue``, the default value for that parameter. + + +Hacking the Configuration Files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Asides from the symbols that gets used by the configuration helpers like +:cb:`allianceConfig` or :cb:`parametersTable`, you can put pretty much anything +in :cb:`/.coriolis2/settings.py` (that is, written in |Python|). + +For example: :: + + # -*- Mode:Python -*- + + defaultStyle = 'Alliance.Classic [black]' + + # Regular Coriolis configuration. + parametersTable = \ + ( ('misc.catchCore' , TypeBool , False ) + , ('misc.info' , TypeBool , False ) + , ('misc.paranoid' , TypeBool , False ) + , ('misc.bug' , TypeBool , False ) + , ('misc.logMode' , TypeBool , True ) + , ('misc.verboseLevel1' , TypeBool , False ) + , ('misc.verboseLevel2' , TypeBool , True ) + , ('misc.minTraceLevel' , TypeInt , 0 ) + , ('misc.maxTraceLevel' , TypeInt , 0 ) + ) + + # Some ordinary Python script... + import os + + print ' o Cleaning up ClockTree previous run.' + for fileName in os.listdir('.'): + if fileName.endswith('.ap') or (fileName.find('_clocked.') >= 0): + print ' - <%s>' % fileName + os.unlink(fileName) + + +See :ref:`Python Interface to Coriolis` for more details those capabilities. diff --git a/documentation/UsersGuide/HTML_defs.rst b/documentation/UsersGuide/HTML_defs.rst deleted file mode 100644 index 2d04ed45..00000000 --- a/documentation/UsersGuide/HTML_defs.rst +++ /dev/null @@ -1,49 +0,0 @@ - -.. -*- Mode: rst -*- - -.. role:: raw-html(raw) - :format: html - -.. 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 - -.. For HTML backend -.. |rightarrow| replace:: :raw-html:`

` -.. |menu_P&R| replace:: :raw-html:`

` -.. |menu_StepByStep| replace:: :raw-html:`

` -.. |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_KiteDetailedPreRoute| image:: ./images/PR-DetailedPreRoute.png -.. |menu_KiteFinalizeRoute| image:: ./images/PR-FinalizeRoute.png - -.. Stand-alone images. -.. |ViewerSnapshot_1| replace:: :raw-html:`
Viewer Basic Snapshot
` -.. |ControllerSnapshot_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerLook_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerFilter_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerLayersGos_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerNetlist_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ViewerNetlist_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerSelection_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_2| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_3| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerSettings_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |CoriolisSoftSchema| replace:: :raw-html:`
Coriolis Software Schematic
` -.. |ChipStructure-1| replace:: :raw-html:`
Chip Top Structure
` -.. |Etesian-1| replace:: :raw-html:`
Etesian Abutment Box
` - -.. |BigMouse| image:: ./images/ComputerMouse.png - :scale: 25% - -.. Direct LaTeX commands encapsulation. -.. |dotfill| replace:: :raw-html:`  ` -.. |noindent| replace:: :raw-html:`

` -.. |medskip| replace:: :raw-html:`
` -.. |newpage| replace:: :raw-html:`
` -.. |br| replace:: :raw-html:`
` - diff --git a/documentation/UsersGuide/Installation.rst b/documentation/UsersGuide/Installation.rst new file mode 100644 index 00000000..224ee5f4 --- /dev/null +++ b/documentation/UsersGuide/Installation.rst @@ -0,0 +1,230 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +|newpage| + + +Installation +============ + +.. note:: + As the sources are being released, the binary packaging is dropped. + You still may find older version here: http://asim.lip6.fr/pub/coriolis/2.0 . + +In a nutshell, building source consist in pulling the |git| repository then +running the |ccb| installer. + +Main building prerequisites: + +* cmake +* C++11-capable compiler +* RapidJSON_ +* python2.7 +* boost +* libxml2 +* bzip2 +* yacc & lex +* Qt 4 or Qt 5 + +Building documentation prerequisites: + +* doxygen +* latex +* latex2html +* python-docutils (for reStructuredText) + +Optional libraries: + +* LEF/DEF (from `SI2 `_) + +For other distributions, refer to their own packaging system. + +|newpage| + + +Fixed Directory Tree +~~~~~~~~~~~~~~~~~~~~ + +In order to simplificate the work of the |ccb| installer, the source, build +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 +building it (noted :fboxtt:`~/` or :fboxtt:`$HOME/`). Only the source +directory needs to be manually created by the user, all others will be +automatically created either by |ccb| or the build system. + ++--------------------------------------------------------------------------------------------------------------+ +| **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/ | +| | Linux, SL 6, 32b | | ~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/ | +| | Linux, SL 6, 64b | | ~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/ | +| | Linux, Fedora, 64b | | ~/coriolis-2.x/Linux.fc_64/Release.Shared/build/ | +| | Linux, Fedora, 32b | | ~/coriolis-2.x/Linux.fc/Release.Shared/build/ | +| | FreeBSD 8, 32b | | ~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/ | +| | FreeBSD 8, 64b | | ~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/ | +| | Windows 7, 32b | | ~/coriolis-2.x/Cygwin.W7/Release.Shared/build/ | +| | Windows 7, 64b | | ~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/ | +| | Windows 8.x, 32b | | ~/coriolis-2.x/Cygwin.W8/Release.Shared/build/ | +| | Windows 8.x, 64b | | ~/coriolis-2.x/Cygwin.W8_64/Release.Shared/build/ | ++------------------------------+-------------------------------------------------------------------------------+ +| **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// | +| | Configuration files | | .../install/etc/coriolis2/ | +| | Doc, by tool | | .../install/share/doc/coriolis2/en/html/ | ++------------------------------+-------------------------------------------------------------------------------+ + +.. 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. + + ``Static`` do not work because I don't know yet to mix statically linked binaries + and Python modules (which must be dynamic). + +|newpage| + + +Building Coriolis +~~~~~~~~~~~~~~~~~ + +First step is to install the prerequisites. Currently, only RapidJSON_. +As RapidJSON is evolving fast, if you encounter compatibility problems, +the exact version we compiled against is given below. :: + + dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support + dummy@lepka:~$ cd ~/coriolis-2.x/src/support + dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson + dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd + +The second step is to create the source directory and pull the |git| repository: :: + + dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src + dummy@lepka:~$ cd ~/coriolis-2.x/src + dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git + +Third and final step, build & install: :: + + dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + --project=coriolis \ + --make="-j4 install" + dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + --project=coriolis \ + --doc --make="-j1 install" + +We need to separate to perform a separate installation of the documentation because it +do not support to be generated with a parallel build. So we compile & install in a first +stage in ``-j4`` (or whatever) then we generate the documentation in ``-j1`` + +Under |RHEL6| or clones, you must build using the |devtoolset2|: :: + + dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + --devtoolset-2 --make="-j4 install" + +If you want to uses Qt 5 instead of Qt 4, you may add the ``--qt5`` argument. + +The complete list of |ccb| functionalities can be accessed with the ``--help`` argument. +It also may be run in graphical mode (``--gui``). + + +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:~$ git checkout devel + dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + --make="-j4 install" --debug + + Be aware that it may requires newer versions of the dependencies and may introduce + incompatibilites with the stable version. + + In the (unlikely) event of a crash of |cgt|, as it is a |Python| script, the right + command to run |gdb| on it is: :: + + dummy@lepka:work$ gdb python core.XXXX + +|newpage| + + +Additionnal Requirement under |MacOS| +------------------------------------- + +|Coriolis| make uses of the :cb:`boost::python` module, but the |macports| |boost| +seems unable to work with the |Python| bundled with |MacOS|. So you have to install +both of them from |macports|: :: + + dummy@macos:~$ port install boost +python27 + dummy@macos:~$ port select python python27 + dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks + +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 +~~~~~~~~~~~~~~~~~~ + +Packager should not uses |ccb|, instead ``bootstrap/Makefile.package`` is provided +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. + +Sligthly outaded packaging configuration files can also be found under ``bootstrap/``: + +* ``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. + +This is done by editing the one variable :cb:`cellsTop` in the |Alliance| helper +(see :ref:`Alliance Helper`). This variable must point to the directory of the +cells libraries. In a typical installation, this is generally +:cb:`/usr/share/alliance/cells`. + + +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.** + When used under |RHEL6| or clones, it needs to be run in the |devtoolset2| + 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`"' diff --git a/documentation/UsersGuide/LaTeX_defs.rst b/documentation/UsersGuide/LaTeX_defs.rst deleted file mode 100644 index 8d48f8e1..00000000 --- a/documentation/UsersGuide/LaTeX_defs.rst +++ /dev/null @@ -1,50 +0,0 @@ - -.. -*- Mode: rst -*- - -.. role:: raw-latex(raw) - :format: latex - -.. 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 - -.. |DONE| replace:: :raw-latex:`\marginpar{\fbox{\small\ding{56}}}` - -.. For LaTeX/PDF backend. -.. |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}}}}` -.. |menu_KiteDetailedPreRoute| replace:: :raw-latex:`\fbox{\textsf{\textbf{{\underline{D}etailed Pre-Route}}}}` -.. |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}` -.. |CoriolisSoftSchema| replace:: :raw-latex:`\begin{center}\includegraphics[width=.7\textwidth]{./images/Coriolis-Soft-Schema.eps}\end{center}` -.. |ChipStructure-1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.95\textwidth]{./images/chip-structure-1.eps}\end{center}` -.. |Etesian-1| replace:: :raw-latex:`\begin{center}\includegraphics[width=.95\textwidth]{./images/etesian-1.eps}\end{center}` - -.. |BigMouse| image:: ./images/ComputerMouse.eps - :scale: 25% - -.. Direct LaTeX commands encapsulation. -.. |dotfill| replace:: :raw-latex:`\dotfill` -.. |noindent| replace:: :raw-latex:`\noindent` -.. |medskip| replace:: :raw-latex:`\medskip` -.. |newpage| replace:: :raw-latex:`\newpage` -.. |br| replace:: :raw-latex:`\\` - diff --git a/documentation/UsersGuide/LicenseCredits.rst b/documentation/UsersGuide/LicenseCredits.rst new file mode 100644 index 00000000..3cf0eefe --- /dev/null +++ b/documentation/UsersGuide/LicenseCredits.rst @@ -0,0 +1,55 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +Credits & License +================= + +.. raw:: html + +

Hurricane + Rémy Escassut & + Christian Masson

+
+

Etesian + Gabriel Gouvine

+
+

Stratus + Sophie Belloeil

+
+

Knik + Damien Dupuis

+
+

Kite, + Unicorn + Jean-Paul Chaput

+
+ + +.. raw:: latex + + \begin{center}\begin{minipage}[t]{.8\textwidth} + \noindent\DUrole{sc}{Hurricane} \dotfill Rémy \DUrole{sc}{Escassut} \& + Christian \DUrole{sc}{Masson} \\ + \noindent\DUrole{sc}{Etesian} \dotfill Gabriel \DUrole{sc}{Gouvine} \\ + \noindent\DUrole{sc}{Stratus} \dotfill Sophie \DUrole{sc}{Belloeil} \\ + \noindent\DUrole{sc}{Knik} \dotfill Damien \DUrole{sc}{Dupuis} \\ + \noindent\DUrole{sc}{Kite}, + \DUrole{sc}{Unicorn} \dotfill Jean-Paul \DUrole{sc}{Chaput} \\ + \end{minipage}\end{center} + + +|medskip| + +The |Hurricane| data-base is copyright© |Bull| 2000-2016 and is +released under the terms of the |LGPL| license. All other tools are +copyright© |UPMC| 2008-2016 and released under the |GPL| +license. + +Others important contributors to |Coriolis| are Christophe |Alexandre|, +Hugo |Clement|, Marek |Sroka| and Wu |Yifei|. + +The |Knik| router makes use of the |Flute| software, which is +copyright© Chris C. N. |Chu| from the Iowa State University +(http://home.eng.iastate.edu/~cnchu/). diff --git a/documentation/UsersGuide/Pygments.css b/documentation/UsersGuide/Pygments.css deleted file mode 100644 index de3dc8fe..00000000 --- a/documentation/UsersGuide/Pygments.css +++ /dev/null @@ -1,41 +0,0 @@ -div.codeblock { font-size: 90%; - margin: 10pt; - padding: 5pt; - border: dashed; - border-width: thin; - background-color: #ffffcc; - border-color: #fc8676; - } -.codeblock * .hll { background-color: #ffffcc } -.codeblock * .c { color: #008000 } /* Comment */ -.codeblock * .err { border: 1px solid #FF0000 } /* Error */ -.codeblock * .k { color: #0000ff } /* Keyword */ -.codeblock * .cm { color: #008000 } /* Comment.Multiline */ -.codeblock * .cp { color: #0000ff } /* Comment.Preproc */ -.codeblock * .c1 { color: #008000 } /* Comment.Single */ -.codeblock * .cs { color: #008000 } /* Comment.Special */ -.codeblock * .ge { font-style: italic } /* Generic.Emph */ -.codeblock * .gh { font-weight: bold } /* Generic.Heading */ -.codeblock * .gp { font-weight: bold } /* Generic.Prompt */ -.codeblock * .gs { font-weight: bold } /* Generic.Strong */ -.codeblock * .gu { font-weight: bold } /* Generic.Subheading */ -.codeblock * .kc { color: #0000ff } /* Keyword.Constant */ -.codeblock * .kd { color: #0000ff } /* Keyword.Declaration */ -.codeblock * .kn { color: #0000ff } /* Keyword.Namespace */ -.codeblock * .kp { color: #0000ff } /* Keyword.Pseudo */ -.codeblock * .kr { color: #0000ff } /* Keyword.Reserved */ -.codeblock * .kt { color: #2b91af } /* Keyword.Type */ -.codeblock * .s { color: #a31515 } /* Literal.String */ -.codeblock * .nc { color: #2b91af } /* Name.Class */ -.codeblock * .ow { color: #0000ff } /* Operator.Word */ -.codeblock * .sb { color: #a31515 } /* Literal.String.Backtick */ -.codeblock * .sc { color: #a31515 } /* Literal.String.Char */ -.codeblock * .sd { color: #a31515 } /* Literal.String.Doc */ -.codeblock * .s2 { color: #a31515 } /* Literal.String.Double */ -.codeblock * .se { color: #a31515 } /* Literal.String.Escape */ -.codeblock * .sh { color: #a31515 } /* Literal.String.Heredoc */ -.codeblock * .si { color: #a31515 } /* Literal.String.Interpol */ -.codeblock * .sx { color: #a31515 } /* Literal.String.Other */ -.codeblock * .sr { color: #a31515 } /* Literal.String.Regex */ -.codeblock * .s1 { color: #a31515 } /* Literal.String.Single */ -.codeblock * .ss { color: #a31515 } /* Literal.String.Symbol */ diff --git a/documentation/UsersGuide/Releases.rst b/documentation/UsersGuide/Releases.rst new file mode 100644 index 00000000..c86243a1 --- /dev/null +++ b/documentation/UsersGuide/Releases.rst @@ -0,0 +1,102 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +Release Notes +============= + +Release 1.0.1475 +~~~~~~~~~~~~~~~~ + +This is the first preliminary release of the |Coriolis2| framework. + +This release mainly ships the global router |Knik| and the detailed router +|Kite|. Together they aim to replace the |Alliance| |Nero| router. +Unlike |Nero|, |Kite| is based on an innovating routing modeling and ad-hoc +algorithm. Although it is released under |GPL| license, the source code +will be avalaible later. +|medskip| + + +|noindent| Contents of this release: + +1. A graphical user interface (viewer only). +2. The |Knik| global router. +3. The |Kite| detailed router. + +|noindent| Supported input/output formats: + +* |Alliance| |vst| (netlist) & |ap| (physical) formats. +* Even if there are some references to the |Cadence| |LEFDEF| format, its + support is not included because it depends on a library only available + to |Si2| affiliated members. + + +Release 1.0.1963 +~~~~~~~~~~~~~~~~ + +Release 1963 is alpha. All the tools from |Coriolis1| have been ported into +this release. + +|noindent| Contents of this release: + +#. The |Stratus| netlist capture language (|GenLib| replacement). +#. The |Mauka| placer (still contains bugs). +#. A graphical user interface (viewer only). +#. The |Knik| global router. +#. The |Kite| detailed router. +#. Partially implemented python support for configuration files + (alternative to |XML|). +#. A documentation (imcomplete/obsoleted in |Hurricane|'s case). + + +Release 1.0.2049 +~~~~~~~~~~~~~~~~ + +Release `2049` is Alpha. + +|noindent| Changes of this release: + +#. The |Hurricane| documentation is now accurate. Documentation + for the Cell viewer and |CRLcore| has been added. +#. More extensive Python support for all the components of + |Coriolis|. +#. Configuration is now completly migrated under Python. + |XML| loaders can still be useds for compatibilty. +#. The |cgt| main has been rewritten in Python. + + +Release v2.0.1 +~~~~~~~~~~~~~~ + +#. Migrated the repository from |svn| to |git|, and release complete sources. + As a consequence, we drop the distribution packaging support and give + public read-only access to the repository. +#. Deep rewrite of the |Katabatic| database and |Kite| detailed router, + achieve a speedup factor greater than 20... + + +Release v2.1 +~~~~~~~~~~~~ + +#. Replace the old simulated annealing placer |Mauka| by the analytical placer + |Etesian| and its legalization and detailed placement tools. +#. Added a Blif format parser to process circuits generated by the Yosys and ABC + logic synthetizers. +#. The multiples user defined configuration files are now grouped under + a common hidden (dot) directory ``.coriolis2`` and the file extension + is back from ``.conf`` to ``.py``. + +.. #. Under |RHEL7| / |SL7|, there is a known bug in the graphical visualizer. +.. When shifting to the left, the right-half part of the screen gets +.. badly redrawn. Uses |CTRL_L| to refresh. It will be corrected as soon +.. as possible. + + +**Release v2.2** +~~~~~~~~~~~~~~~~ + +#. Added JSON import/export of the whole Hurricane DataBase. Two save mode + are supported: *Cell* mode (standalone) or *Blob* mode, which dump the + whole design down and including the standard cells. diff --git a/documentation/UsersGuide/ScriptsPlugins.rst b/documentation/UsersGuide/ScriptsPlugins.rst new file mode 100644 index 00000000..2e9e3d0c --- /dev/null +++ b/documentation/UsersGuide/ScriptsPlugins.rst @@ -0,0 +1,332 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Stratus Documentation: file:///usr/share/doc/coriolis2/en/html/stratus/index.html + +.. |ChipStructure-1| image:: ./images/chip-structure-1.png + :alt: Chip Top Structure + :align: middle + :width: 90% + + +.. _Python Interface to Coriolis: + +Python Interface for |Hurricane| / |Coriolis| +============================================= + +The (almost) complete interface of |Hurricane| is exported as a |Python| module +and some part of the other components of |Coriolis| (each one in a separate +module). The interface has been made to mirror as closely as possible the +C++ one, so the C++ doxygen documentation could be used to write code with +either languages. + +`Summary of the C++ Documentation `_ + +A script could be run directly in text mode from the command line or through +the graphical interface (see :ref:`Python Scripts in Cgt`). + +Asides for this requirement, the python script can contain anything valid +in |Python|, so don't hesitate to use any package or extention. + +Small example of Python/Stratus script: :: + + from Hurricane import * + from Stratus import * + + def doSomething (): + # ... + return + + def ScriptMain ( **kw ): + editor = None + if kw.has_key('editor') and kw['editor']: + editor = kw['editor'] + stratus.setEditor( editor ) + + doSomething() + return + + if __name__ == "__main__" : + kw = {} + success = ScriptMain( **kw ) + shellSuccess = 0 + if not success: shellSuccess = 1 + + sys.exit( shellSuccess ) + ScriptMain () + +This typical script can be executed in two ways: + +#. Run directly as a |Python| script, thanks to the :: + + if __name__ == "__main__" : + + part (this is standart |Python|). It is a simple adapter that will + calls :cb:`ScriptMain()`. +#. Through |cgt|, either in text or graphical mode. In that case, the + :cb:`ScriptMain()` is directly called trough a sub-interpreter. + The arguments of the script are passed through the ``**kw`` dictionnary. + + +----------------------+-----------------------------------------------+ + | \*\*kw Dictionnary | + +----------------------+-----------------------------------------------+ + | Parameter Key/Name | Contents type | + +======================+===============================================+ + | ``'cell'`` | A Hurricane cell on which to work. Depending | + | | on the context, it may be ``None``. | + | | For example, when run from |cgt|, it the cell | + | | currently loaded in the viewer, if any. | + +----------------------+-----------------------------------------------+ + | ``'editor'`` | The viewer from which the script is run, when | + | | lauched through |cgt|. | + +----------------------+-----------------------------------------------+ + + +Plugins +~~~~~~~ + +Plugins are |Python| scripts specially crafted to integrate with |cgt|. +Their entry point is a :cb:`ScriptMain()` method as described in +`Python Interface to Coriolis`_. They can be called by user scripts +through this method. + + + +Chip Placement +-------------- + +Automatically perform the placement of a complete chip. This plugin, as well +as the other P&R tools expect a specific top-level hierarchy for the design. +The top-level hierarchy must contains the instances of all the I/O pads and +**exactly one** instance of the chip's core model. + +|bcenter| |ChipStructure-1| |ecenter| + +The designer must provide a configuration file that define the rules for the +placement of the top-level hierarchy (that is, the pads and the core). +This file must be named after the chip's name, by appending ``_chip.py`` +(obviously, it is a |Python| file). For instance if the chip netlist file +is called ``amd2901_crl.vst``, then the configuration file must be named +``amd2901_crl_chip.vst``. + +Example of chip placement configuration file (for ``AM2901``): :: + + chip = \ + { 'pads.south' : [ 'p_a3' , 'p_a2' , 'p_a1' , 'p_r0' + , 'p_vddick0', 'p_vssick0', 'p_a0' , 'p_i6' + , 'p_i8' , 'p_i7' , 'p_r3' ] + , 'pads.east' : [ 'p_zero' , 'p_i0' , 'p_i1' , 'p_i2' + , 'p_vddeck0', 'p_vsseck0', 'p_q3' , 'p_b0' + , 'p_b1' , 'p_b2' , 'p_b3' ] + , 'pads.north' : [ 'p_noe' , 'p_y3' , 'p_y2' , 'p_y1' + , 'p_y0' , 'p_vddeck1', 'p_vsseck1', 'p_np' + , 'p_ovr' , 'p_cout' , 'p_ng' ] + , 'pads.west' : [ 'p_cin' , 'p_i4' , 'p_i5' , 'p_i3' + , 'p_ck' , 'p_d0' , 'p_d1' , 'p_d2' + , 'p_d3' , 'p_q0' , 'p_f3' ] + , 'core.size' : ( 1500, 1500 ) + , 'chip.size' : ( 3000, 3000 ) + , 'chip.clockTree' : True + } + +The file must contain *one dictionnary* named ``chip``. + ++----------------------+-------------------------------------------------------+ +| Chip Dictionnary | ++----------------------+-------------------------------------------------------+ +| Parameter Key/Name | Value/Contents type | ++======================+=======================================================+ +| ``'pad.south'`` | Ordered list (left to right) of pad instances names | +| | to put on the south side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.east'`` | Ordered list (down to up) of pad instances names | +| | to put on the east side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.north'`` | Ordered list (left to right) of pad instances names | +| | to put on the north side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.west'`` | Ordered list (down to up) of pad instances names | +| | to put on the west side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'core.size'`` | The size of the core (to be used by the placer) | ++----------------------+-------------------------------------------------------+ +| ``'chip.size'`` | The size of the whole chip. The sides must be great | +| | enough to accomodate all the pads | ++----------------------+-------------------------------------------------------+ +| ``'chip.clockTree'`` | Whether to generate a clock tree or not. This calls | +| | the ClockTree plugin | ++----------------------+-------------------------------------------------------+ + +Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Chip Plugin Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.count`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | The minimum number of rails around the core | +| | block. Must be odd and suppérior to 5. | +| | One rail for the clock and at least two pairs | +| | of power/grounds | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.hWidth`` | TypeInt | :cb:`12` | +| +------------------+----------------------------+ +| | The horizontal with of the rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.vWidth`` | TypeInt | :cb:`12` | +| +------------------+----------------------------+ +| | The vertical with of the rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.hSpacing`` | TypeInt | :cb:`6` | +| +------------------+----------------------------+ +| | The spacing, *edge to edge* of two adjacent | +| | horizontal rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.vSpacing`` | TypeInt | :cb:`6` | +| +------------------+----------------------------+ +| | The spacing, *edge to edge* of two adjacent | +| | vertical rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pck`` | TypeString | :cb:`pck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | chip external clock | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvddeck`` | TypeString | :cb:`pvddeck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vdde`` (external power) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvsseck`` | TypeString | :cb:`pvsseck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vsse`` (external ground) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvddick`` | TypeString | :cb:`pvddick_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vddi`` (internal power) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvssick`` | TypeString | :cb:`pvssick_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vssi`` (internal ground) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ + +.. note:: + If no clock tree is generated, then the clock rail is *not* created. + So even if the requested number of rails ``chip.block.rails.count`` is, say 5, + only four rails (2* ``power``, 2* ``ground``) will be generateds. + + +Clock Tree +---------- + +Insert a clock tree into a block. The clock tree uses the H strategy. +The clock net is splitted into sub-nets, one for each branch of the +tree. + +* On **chips** design, the sub-nets are createds in the model of the + core block (then trans-hierarchically flattened to be shown at + chip level). +* On **blocks**, the sub nets are created directly in the top block. +* The sub-nets are named according to a simple geometrical scheme. + A common prefix ``ck_htree``, then one postfix by level telling + on which quarter of plane the sub-clock is located: + + #. ``_bl``: bottom left plane quarter. + #. ``_br``: bottom right plane quarter. + #. ``_tl``: top left plane quarter. + #. ``_tr``: top right plane quarter. + + We can have ``ck_htree_bl``, ``ck_htree_bl_bl``, ``ch_htree_bl_tl`` and so on. + +The clock tree plugin works in four steps: + +#. Build the clock tree: creates the top-block abutment box, compute the + levels of H tree neededs and place the clock buffers. +#. Once the clock buffers are placed, calls the placer (|etesian|) to place + the ordinary standart cells, whithout disturbing clock H-tree buffers. +#. At this point we know the exact positions of all the DFFs, so we can + connect them to the nearest H-tree leaf clock signal. +#. Leaf clock signals that are not connecteds to any DFFs are removed. + +Netlist reorganisation: + +* Obviously the top block or chip core model netlist is modificated to + contains all the clock sub-nets. The interface is *not* changed. +* If the top block contains instances of other models *and* those models + contains DFFs that get re-connecteds to the clock sub-nets (from the + top level). Change both the model netlist and interface to propagate + the relevant clock sub-nets to the instanciated model. The new model + with the added clock signal is renamed with a ``_clocked`` suffix. + For example, the sub-block model ``ram.vst`` will become ``ram_clocked.vst``. + +.. note:: + If you are to re-run the clock tree plugin on a netlist, be careful + to erase any previously generated ``_clocked`` file (both netlist and + layout: ``rm *.clocked.{ap,vst}``). And restart |cgt| to clear it's + memory cache. + +Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **ClockTree Plugin Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.minimumSide`` | TypeInt | :cb:`300` | +| +------------------+----------------------------+ +| | The minimum size below which the clock tree | +| | will stop to perform quadri-partitions | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.buffer`` | TypeString | :cb:`buf_x2` | +| +------------------+----------------------------+ +| | The buffer model to use to drive sub-nets | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.placerEngine`` | TypeString | :cb:`Etesian` | +| +------------------+----------------------------+ +| | The placer to use. Other value is ``Mauka`` | +| | the simulated annealing placer which will go | +| | into retirement very soon | ++-----------------------------------+------------------+----------------------------+ + + +Recursive-Save (RSave) +---------------------- + +Perform a recursive top down save of all the models from the top cell +loaded in |cgt|. Force a write of any non-terminal model. This plugin is used +by the clock tree plugin after the netlist clock sub-nets creation. + + +A Simple Example: AM2901 +~~~~~~~~~~~~~~~~~~~~~~~~ + +To illustrate the capabilities of |Coriolis| tools and |Python| scripting, a small +example, derived from the |Alliance| :cb:`AM2901` is supplied. + +This example contains only the synthetized netlists and the :cb:`doChip.py` script +which perform the whole P&R of the design. + +You can generate the chip using one of the following method: + +#. **Command line mode:** directly run the script: :: + + dummy@lepka:AM2901$ ./doChip -V --cell=amd2901 + +#. **Graphic mode:** launch |cgt|, load chip netlist ``amd2901`` (the top cell) + then run the |Python| script :cb:`doChip.py`. + +.. note:: + Between two consecutive run, be sure to erase the netlist/layout generateds: :: + + dummy@lepka:AM2901$ rm *_clocked*.vst *.ap diff --git a/documentation/UsersGuide/SoC.css b/documentation/UsersGuide/SoC.css deleted file mode 100644 index 4bca9453..00000000 --- a/documentation/UsersGuide/SoC.css +++ /dev/null @@ -1,796 +0,0 @@ - -html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 96%; - font-family: "Open Sans", verdana, sans-serif; -} - -body { - color: black; - background: white; - /* - background: #09550B; - background-color: white; - */ - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin: 0 0 0 0; - padding: 20pt; - width: 550pt; - margin-right: 10%; - margin-left: 30%; - -moz-box-shadow: 4px 4px 5px 3px #ccc; - -webkit-box-shadow: 4px 4px 5px 3px #ccc; - box-shadow: 4px 4px 5px 3px #ccc; -} - -body.gsummary { - margin-right: 10%; - margin-left: 10%; -} - -h1, h2, h3, h4, h5, h6 { font-family: "Open Sans", verdana, sans-serif; } -h1 { text-align: center; - border-top: 2px solid #09550b; - border-bottom: 2px solid #09550b; - padding-top: 7pt; - padding-bottom: 7pt; - } -h2, h3, h4, h5, h6 { text-align: left; } -h1, h2, h3 { font-family: "Open Sans"; - } -h1 { font-weight: normal; font-size: 170%; padding-top: 7pt; margin-top: 25pt; } -h2 { font-weight: normal; font-size: 140%; padding-top: 7pt; margin-top: 25pt; } -h3 { font-weight: bold; font-size: 118%; padding-top: 7pt; margin-top: 25pt; } -h4 { font-weight: bold; font-size: 100%; } -h5 { font-style: italic; font-size: 100%; } -h6 { font-variant: small-caps; font-size: 100%; } - -body.gsummary h1 { text-align: center; font-size: 220%; } - -h1 a:link { border-bottom: 0px; } - - -hr { - color: #09550b; - border: 1px dotted #09550b; - border-style: none none dotted; - padding-top: 10pt; - padding-bottom: 10pt; -} - -div#contents { - margin: 30pt; - padding: 2pt 10pt; - background-color: #fff676; -} - -div#centered { - margin-left: auto; - margin-right: auto; - text-align: center; -} - -p, li { - text-align: justify; -} - -.sc { - font-variant: small-caps; - font-size: 110%; -} - -pre, tt, code { - font-family: "courrier", "andale mono", monospace; - font-size: 100%; - white-space: pre; -} - -tt { - color: #09550b; -} - -pre.wiki, div.code, pre.literal-block { - font-size: 90%; - padding: 5pt; - margin-left: 4%; - margin-right: 4%; - border: dashed; - border-width: thin; - border-color: #FC8676; - background-color: #FCFCE1; -} - -a:link, a:active { - font-weight: normal; - text-decoration: none; - color: #09550b; - border-bottom: 1px dotted #09550b; -} - -a:hover, a:focus, a:visited { - font-weight: normal; - font-style: italic; - text-decoration: none; - /* - color: #A40010; - border-bottom: 1px dotted #A40010; - */ - color: #09550b; - border-bottom: 1px dotted #09550b; -} - -body.gsummary a:link, a:active { - font-size: 140%; - font-weight: bold; - text-decoration: none; - color: #09550b; - border-bottom: none; - /* - border-bottom: 1px dotted #09550b; - */ -} - -body.gsummary a:hover, a:focus, a:visited { - font-size: 120%; - font-weight: bold; - font-style: italic; - text-decoration: none; - /* - color: #A40010; - border-bottom: 1px dotted #A40010; - */ - color: #09550b; - /* - border-bottom: 1px dotted #09550b; - */ -} - -p.credit { - margin-left: 10%; - margin-right: 10%; - font-size: 110%; -} - -p.credit span.left { - float: left; - white-space: nowrap; -} - -p.credit span.right { - float: right; - white-space: nowrap; -} - -img.addborder { - border: 1px solid black; -} - -div#header { - margin: 0px; - padding: 0pt; - background-color: white; - display: inline-block; - width: 100%; -} - -div#header_logo { - margin: 0px; - padding: 10px 0px 10px 12pt; - background-color: white; - width: 40%; - float: left; -} - -div#header_menus { - background-color: white; - width: 55%; - float: right; - padding-top: 60pt; - padding-right: 10pt; - text-align: right; - font-size: 80%; -} - -div#header_menus ul { - padding-top: 45pt; - list-style: none; - text-align: right; - font-size: 80%; -} - -div#header_menus li { - padding: 0pt; - margin: 0pt; - display: inline; - white-space: nowrap; -} - -/* -div#header_menus a { - border-left: 1px solid #d7d7d7; - padding: 0 .75em; -} - -div#header_menus a.first { - border-left: none; -} -*/ - -div#header a:link, div#header a:active, div#header a:visited { - margin: 0pt; - padding: 0pt 5pt; - font-weight: normal; - color: black; - text-decoration: none; - border-bottom: 1px solid black; - border-left: 0px; - border-right: 0px; -} - -div#header a:hover, div#header a:focus { - margin: 0pt; - padding: 0pt 5pt; - font-weight: normal; - color: black; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; -} - -div#header a.current:link, div#header a.current:active, div#header a.current:visited { - margin: 0pt; - padding: 0pt 5pt; - font-weight: bold; - font-style: normal; - font-size: 120%; - color: white; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; - background-color: #09550b; -} - -div#header a.current:hover, div#header a.current:focus { - margin: 0pt; - padding: 0pt 5pt; - font-weight: bold; - font-style: normal; - font-size: 120%; - color: white; - text-decoration: none; - border-bottom: 4px solid #09550b; - border-left: 0px; - border-right: 0px; - background-color: #09550b; -} - -div#header_ancestors { - padding: 4px 0px 4px 12pt; - background-color: #09550B; - color: white; -} - -div#header_ancestors ul, div#header_ancestors * li { - display: inline; - list-style-type: none; - padding: 0px 0px 0px 0pt; -} - -div#header_ancestors a:link, div#header_ancestors a:active, div#header_ancestors a:visited { - font-weight: bold; - color: white; - text-decoration: none; - border-bottom: 0px; -} - -div#header_ancestors a:hover, div#header_ancestors a:focus { - font-weight: bold; - color: white; - text-decoration: underline; -} - -div#footer { - margin: 0px; - padding: 0px; - border-top: 1px dotted #09550b; - background-color: white; - display: inline-block; - width: 100%; - text-align: right; -} - -div#searchform { - width: 80%; - background-color: #ccffcd; - padding: 15pt 10pt 15pt 10pt; - margin-top: 50pt; - margin-bottom: 50pt; - margin-left: auto; - margin-right: auto; - text-align: center; -} - -div#searchform input#id_q { - background-color: white; - border: 1px solid #09550b; - padding: 2pt; - width: 80%; - font-size: 110%; - font-weight: bold; -} - -span.queryref { - font-weight: bold; -} - -div#searchform ul { - list-style: none; -} - -div#searchform li { - display: inline; -} - -hr#search_vs_results { - color: #09550b; - border: 2px dotted #09550b; - border-style: none none dotted; - margin-top: 0pt; - margin-bottom: 20pt; -} - -div#search_results { - width: 85%; - margin: auto; -} - -div#sidebar hr#separator { - color: white; - border: 0px; - margin-top: 0pt; - margin-bottom: 20pt; -} - -img.footer-logo { - height: 24px; - padding: 0px 2px; -} - -hr#site_vs_page { - color: white; - border: 3px dotted white; - border-style: none none dotted; - margin-top: 20pt; - margin-bottom: 20pt; -} - -div#sidebar { - /* - background: #09550B; - background: #ccffcd; - */ - background: white; -} - -div#sidebar div#sitemenu, div#sidebar div#pagemenu { - /* - background: white; - */ - background: #09550b; - width: 85%; - margin: auto; - padding: 5pt 10pt; -} - -div#sidebar * li { - text-align: left; -} - -div#sidebar * ul { - list-style-type: square; - padding-left: 12pt; -} - -div#sitemenu ul { - list-style-type: none; - padding-left: 0pt; -} - -div#sitemenu ul ul { - list-style-type: none; - padding-left: 0pt; -} - -div#sitemenu ul ul ul { - list-style-type: square; - padding-left: 12pt; -} - -div#sitemenu ul li ul li { - padding-top: 3pt; - padding-bottom: 5pt; - border-top: 1px dotted white; -} - -div#sitemenu ul li ul li ul li { - border-top: none; - padding-top: 1pt; - padding-bottom: 1pt; -} - -div#sitemenu ul li a:link, -div#sitemenu ul li a:active, -div#sitemenu ul lu a:visited -{ - font-size: 140%; - font-weight: bold; - border-bottom: none; -} - -div#sitemenu ul li a:focus, -div#sitemenu ul lu a:hover -{ - font-size: 140%; - font-weight: bold; - font-style: italic; - border-bottom: none; -} - -div#sitemenu ul ul li a:link, -div#sitemenu ul ul li a:active, -div#sitemenu ul ul lu a:visited, -div#sitemenu ul ul li a:focus, -div#sitemenu ul ul lu a:hover -{ - font-size: 90%; - font-weight: normal; - border-bottom: none; -/*border-bottom: 1px dotted white;*/ -} - -div#pagemenu ul { - list-style-type: none; - padding-left: 0pt; -} - -div#pagemenu ul ul { - list-style-type: none; - padding-left: 0pt; -} - -div#pagemenu ul ul ul { - padding-left: 12pt; -} - -div#pagemenu ul li ul li { - padding-top: 3pt; - padding-bottom: 5pt; - border-top: 1px dotted white; -} - -div#pagemenu ul li ul li ul li { - border-top: none; - padding-top: 1pt; - padding-bottom: 1pt; -} - -div#pagemenu ul li a:link, -div#pagemenu ul li a:active, -div#pagemenu ul lu a:visited -{ - font-size: 120%; - font-weight: bold; - border-bottom: none; -} - -div#pagemenu ul li a:focus, -div#pagemenu ul lu a:hover -{ - font-size: 120%; - font-weight: bold; - font-style: italic; - border-bottom: none; -} - -div#pagemenu ul ul li a:link, -div#pagemenu ul ul li a:active, -div#pagemenu ul ul lu a:visited, -div#pagemenu ul ul li a:focus, -div#pagemenu ul ul lu a:hover -{ - font-size: 90%; - font-weight: normal; - border-bottom: none; - /* - border-bottom: 1px dotted white; - */ -} - - -div#sidebar ul.ancestor * li { - padding-top: 0pt; -} - -div#sidebar ul { - padding-bottom: 8pt; -} - -div#sidebar a:link, div#sidebar a:active, div#sidebar a:visited { - /* - font-weight: normal; - */ - color: white; - text-align: left; - text-decoration: none; - border-bottom: 1px dotted white; -} - -div#sidebar a:hover, div#sidebar a:focus { - /* - font-weight: normal; - */ - color: white; - text-align: left; - text-decoration: none; - border-bottom: 1px dotted white; -} - -div#main { - border-left: 1px solid #09550b; -} - -div#main ul#summary { - list-style-type: square; - padding-left: 12pt; - font-size: 14pt; -} - -div#main ul#summary * ul { - padding-left: 12pt; - padding-bottom: 14pt; - font-size: 95%; -} - -div.code * { - background-color: #FCFCE1; -} - -div.note { - margin: 8px 2% 0px 2%; - border: 1px none #fff01c; - border-left-width: 4px; - border-left-style: solid; - padding: 1px 10pt 1px 55px; - background: #fff676 url('./images/clipboard.png') no-repeat 0% 50%;; - font-size: 90% -} - -div.error { - margin: 8px 2% 0px 2%; - border: 1px none #dd0000; - border-left-width: 4px; - border-left-style: solid; - padding: 1px 10pt 1px 55px; - background: #ffddcc url('./images/i-core.png') no-repeat 0% 50%;; - font-size: 90% -} - -p.admonition-title { - font-weight: bold; -} - -div.topic { - margin: 5pt; - padding: 2pt 10pt; - background-color: fff676; -} - -div.topic p.first { - font-weight: bold; -} - -body.gsummary table { - border-collapse: collapse; - border-color: transparent; - width: 60%; - margin-left: auto; - margin-right: auto; -} - -/* -body.gsummary table th { -} -*/ - -body.gsummary table td { - border: none; -} - -/* -body.gsummary table tr td ul { - margin: 0pt; - border-left: 1px solid black; -} -*/ - -/* -body.gsummary table tr td ul li { - border-bottom: 2px dotted black; -} -*/ - -body.gsummary li { - padding: 0%; - list-style-type: none; -} - -body.gsummary ul { - padding: 0px 0px 10px 0px; - margin: 0%; - border-bottom: 1px dotted black; -} - -table.wiki th, table th { - color: black; - background: #FFFFCC; -} - -table.docutils { - margin-left: 5%; - margin-right: 5%; -} - -table.wiki, table.wiki th, table.wiki td { border: 1px solid black; } -table.wiki th * p { text-align: center; } -table.wiki * p { margin: 0pt; } -table.wiki * blockquote { margin: 0pt; } -table { border-collapse: collapse; } -table th, table td { border: 1px solid black; - padding: 2px 10px 2px 10px; } - -table.docinfo { - margin-top: 10pt; - margin-left: auto; - margin-right: 0pt; - border: 10px solid #303030; - border-collapse: collapse; - background: #303030; - font-size: 90%; - font-family: sans-serif; -} - -table.docinfo tr { - border-bottom: 1px dotted white; -} - -th.docinfo-name, -table.docinfo td, -table.docinfo td a:link, -table.docinfo td a:active, -table.docinfo td a:visited, -table.docinfo td a:focus, -table.docinfo td a:hover -{ - border: 0px solid white; - background: #303030; - color: white; - text-align: left; - font-weight: bold; -} - -th.docinfo-name { - font-weight: normal; -} - -table.docinfo td { - font-weight: bold; -} - -span.ul { - text-decoration: underline; -} - -* span.smallcaps { - /*font-variant: "small-caps";*/ - text-transform: "uppercase"; - font-size: "smaller"; -} - - -span.cb { - font-family: "andale mono", monospace; - font-weight: bold; - white-space: pre; -} - -span.fboxtt { - border: 1px solid black; - padding: 0px 4px; - font-family: "andale mono", monospace; - font-weight: bold; - white-space: pre; -} - -#notice.system-message, .notice.system-message { - color: black; - background: #DDFFDD; - padding-top: 5pt; - padding-bottom: 5pt; - border: 1px none #55BB55; - border-top-width: 4px; - border-top-style: solid; -} - -#content.error .message, div.system-message { - color: #550000; - background: #ffddcc; - border: 2px none #dd0000; - border-top-width: 4px; - border-top-style: solid; - padding: .5em; - margin: 1em 0; -} - -#main { - float: right; - width: 70%; - padding: 0pt; - margin: 0pt; - min-height: 700px; - background: white; -} - -div#main h1 { - border-bottom: 2px solid #09550b; -} - -div#main div.section h1 { - border-bottom: none; -} - -#cmscontent { - padding: 0pt 4% 10pt 4%; - margin: 0pt; -} - -div#htmlerrorcontents { - padding: 10pt 4% 10pt 4%; - margin: 0pt; -} - -div#htmlerrorcontents span.cs { - font-size: 80%; - font-family: "andale mono", monospace; - white-space: pre; -} - -div#htmlerrorcontents hr.lang_separator { - border: 1px dotted black; - border-style: none none dotted; - margin-top: 20pt; - margin-bottom: 10pt; -} - -#embedcontent { - border: 0pt; - padding: 0pt; - margin: 0pt; -} - -#sidebar { - float: left; - width: 29.9%; - padding: 0 0 0 0; - margin: 0 0 0 0; - color: white; - background: #09550B; - /* - min-height: 300px; - background: #f2f2f2; - border-right: 1px solid #ccc; - padding: 0 0 0 10px; - */ -} diff --git a/documentation/UsersGuide/UsersGuide.html b/documentation/UsersGuide/UsersGuide.html deleted file mode 100644 index b22602be..00000000 --- a/documentation/UsersGuide/UsersGuide.html +++ /dev/null @@ -1,2096 +0,0 @@ - - - - - - - - - - - -
- - - - - - - - - - - - - - -


-
-

Coriolis User's Guide

-


-
- The pdf version of this document is available here:
- Coriolis User's Guide -
-

-
-

Credits & License

-

Hurricane -Rémy Escassut & - Christian Masson

-
-

Etesian -Gabriel Gouvine

-
-

Stratus -Sophie Belloeil

-
-

Knik -Damien Dupuis

-
-

Kite, - Unicorn -Jean-Paul Chaput

-


-

The Hurricane data-base is copyright© Bull 2000-2016 and is -released under the terms of the lgpl license. All other tools are -copyright© upmc 2008-2016 and released under the gpl -license.

-

Others important contributors to Coriolis are Christophe Alexandre, -Hugo Clement, Marek Sroka and Wu Yifei.

-

The Knik router makes use of the Flute software, which is -copyright© Chris C. N. Chu from the Iowa State University -(http://home.eng.iastate.edu/~cnchu/).

-

-
-
-

Release Notes

-
-

Release 1.0.1475

-

This is the first preliminary release of the Coriolis 2 framework.

-

This release mainly ships the global router Knik and the detailed router -Kite. Together they aim to replace the Alliance Nero router. -Unlike Nero, Kite is based on an innovating routing modeling and ad-hoc -algorithm. Although it is released under gpl license, the source code -will be avalaible later. -

-

Contents of this release:

-
    -
  1. A graphical user interface (viewer only).
    2. -
  2. The Knik global router.
    3. -
  3. The Kite detailed router.
    4. -
-

Supported input/output formats:

-
    -
  • Alliance vst (netlist) & ap (physical) formats.
    • -
  • Even if there are some references to the Cadence lefdef format, its -support is not included because it depends on a library only available -to Si2 affiliated members.
    • -
-
-
-

Release 1.0.1963

-

Release 1963 is alpha. All the tools from Coriolis 1 have been ported into -this release.

-

Contents of this release:

-
    -
  1. The Stratus netlist capture language (GenLib replacement).
    2. -
  2. The Mauka placer (still contains bugs).
    3. -
  3. A graphical user interface (viewer only).
    4. -
  4. The Knik global router.
    5. -
  5. The Kite detailed router.
    6. -
  6. Partially implemented python support for configuration files -(alternative to xml).
    7. -
  7. A documentation (imcomplete/obsoleted in Hurricane's case).
    8. -
-
-
-

Release 1.0.2049

-

Release 2049 is Alpha.

-

Changes of this release:

-
    -
  1. The Hurricane documentation is now accurate. Documentation -for the Cell viewer and CRLcore has been added.
    2. -
  2. More extensive Python support for all the components of -Coriolis.
    3. -
  3. Configuration is now completly migrated under Python. -xml loaders can still be useds for compatibilty.
    4. -
  4. The cgt main has been rewritten in Python.
    5. -
-
-
-

Release v2.0.1

-
    -
  1. Migrated the repository from svn to git, and release complete sources. -As a consequence, we drop the distribution packaging support and give -public read-only access to the repository.
    2. -
  2. Deep rewrite of the Katabatic database and Kite detailed router, -achieve a speedup factor greater than 20...
    3. -
-
-
-

Release v2.1

-
    -
  1. Replace the old simulated annealing placer Mauka by the analytical placer -Etesian and its legalization and detailed placement tools.
    2. -
  2. Added a Blif format parser to process circuits generated by the Yosys and ABC -logic synthetizers.
    3. -
  3. The multiples user defined configuration files are now grouped under -a common hidden (dot) directory .coriolis2 and the file extension -is back from .conf to .py.
    4. -
- - - - -
-
-

Release v2.2

-
    -
  1. Added JSON import/export of the whole Hurricane DataBase. Two save mode -are supported: Cell mode (standalone) or Blob mode, which dump the -whole design down and including the standard cells.
    2. -
-

-
-
-
-

Installation

-
-

Note

-

As the sources are being released, the binary packaging is dropped. -You still may find older version here: http://asim.lip6.fr/pub/coriolis/2.0 .

-
-

In a nutshell, building source consist in pulling the git repository then -running the ccb installer.

-

Main building prerequisites:

-
    -
  • cmake
    • -
  • C++11-capable compiler
    • -
  • RapidJSON
    • -
  • python2.7
    • -
  • boost
    • -
  • libxml2
    • -
  • bzip2
    • -
  • yacc & lex
    • -
  • Qt 4 or Qt 5
    • -
-

Building documentation prerequisites:

-
    -
  • doxygen
    • -
  • latex
    • -
  • latex2html
    • -
  • python-docutils (for reStructuredText)
    • -
-

Optional libraries:

-
    -
  • LEF/DEF (from SI2)
    • -
-

For other distributions, refer to their own packaging system.

-

-
-

Fixed Directory Tree

-

In order to simplificate the work of the ccb installer, the source, build -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 -building it (noted ~/ or $HOME/). Only the source -directory needs to be manually created by the user, all others will be -automatically created either by ccb or the build system.

- ---- - - - - - - - - - - - - - - - - - - - - - - -
Sources
-
Sources root
-
under git
-
-
-
~/coriolis-2.x/src
-
~/coriolis-2.x/src/coriolis
-
-
Architecture Dependant Build
-
Linux, SL 7, 64 bits
-
Linux, SL 6, 32 bits
-
Linux, SL 6, 64 bits
-
Linux, Fedora, 64 bits
-
Linux, Fedora, 32 bits
-
FreeBSD 8, 32 bits
-
FreeBSD 8, 64 bits
-
Windows 7, 32 bits
-
Windows 7, 64 bits
-
Windows 8.x, 32 bits
-
Windows 8.x, 64 bits
-
-
-
~/coriolis-2.x/Linux.el7_64/Release.Shared/build/<tool>
-
~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/<tool>
-
~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/<tool>
-
~/coriolis-2.x/Linux.fc_64/Release.Shared/build/<tool>
-
~/coriolis-2.x/Linux.fc/Release.Shared/build/<tool>
-
~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/<tool>
-
~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/<tool>
-
~/coriolis-2.x/Cygwin.W7/Release.Shared/build/<tool>
-
~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/<tool>
-
~/coriolis-2.x/Cygwin.W8/Release.Shared/build/<tool>
-
~/coriolis-2.x/Cygwin.W8_64/Release.Shared/build/<tool>
-
-
Architecture Dependant Install
Linux, SL 6, 32 bits~/coriolis-2.x/Linux.slsoc6x/Release.Shared/install/
FHS Compliant Structure under Install
-
Binaries
-
Libraries (Python)
-
Include by tool
-
Configuration files
-
Doc, by tool
-
-
-
.../install/bin
-
.../install/lib
-
.../install/include/coriolis2/<project>/<tool>
-
.../install/etc/coriolis2/
-
.../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.

-

Static do not work because I don't know yet to mix statically linked binaries -and Python modules (which must be dynamic).

-
-

-
-
-

Building Coriolis

-

First step is to install the prerequisites. Currently, only RapidJSON. -As RapidJSON is evolving fast, if you encounter compatibility problems, -the exact version we compiled against is given below.

-
-dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support
-dummy@lepka:~$ cd ~/coriolis-2.x/src/support
-dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson
-dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd
-
-

The second step is to create the source directory and pull the git repository:

-
-dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src
-dummy@lepka:~$ cd ~/coriolis-2.x/src
-dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git
-
-

Third and final step, build & install:

-
-dummy@lepka:src$ ./bootstrap/ccb.py --project=support  \
-                                    --project=coriolis \
-                                    --make="-j4 install"
-dummy@lepka:src$ ./bootstrap/ccb.py --project=support  \
-                                    --project=coriolis \
-                                    --doc --make="-j1 install"
-
-

We need to separate to perform a separate installation of the documentation because it -do not support to be generated with a parallel build. So we compile & install in a first -stage in -j4 (or whatever) then we generate the documentation in -j1

-

Under rhel6 or clones, you must build using the devtoolset2:

-
-dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \
-                                    --devtoolset-2 --make="-j4 install"
-
-

If you want to uses Qt 5 instead of Qt 4, you may add the --qt5 argument.

-

The complete list of ccb functionalities can be accessed with the --help argument. -It also may be run in graphical mode (--gui).

-
-

Building the Devel Branch

-

In the Coriolis git repository, two branches are present:

-
    -

  • The master branch, which contains the latest stable version. This is the -one used by default if you follow the above instructions.

    -
    • -

  • The devel branch, which obviously contains the latest commits from the -development team. To use it instead of the master one, do the following -command just after the first step:

    -
    -dummy@lepka:~$ git checkout devel
-dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \
-                                    --make="-j4 install" --debug
-
    -

    Be aware that it may requires newer versions of the dependencies and may introduce -incompatibilites with the stable version.

    -

    In the (unlikely) event of a crash of cgt, as it is a Python script, the right -command to run gdb on it is:

    -
    -dummy@lepka:work$ gdb python core.XXXX
-
    -
    • -
-

-
-
-

Additionnal Requirement under MacOS

-

Coriolis make uses of the boost::python module, but the MacPorts boost -seems unable to work with the Python bundled with MacOS. So you have to install -both of them from MacPorts:

-
-dummy@macos:~$ port install boost +python27
-dummy@macos:~$ port select python python27
-dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks
-
-

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

-

Packager should not uses ccb, instead bootstrap/Makefile.package is provided -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.

-

Sligthly outaded packaging configuration files can also be found under bootstrap/:

-
    -
  • 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.

-

This is done by editing the one variable cellsTop in the Alliance helper -(see Alliance Helper). This variable must point to the directory of the -cells libraries. In a typical installation, this is generally -/usr/share/alliance/cells.

-
-
-

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. -When used under rhel6 or clones, it needs to be run in the devtoolset2 -environement. The script then launch a new shell, which may cause an -infinite loop if it's called again in, say ~/.bashrc.

-

Instead you may want to create an alias:

-
-alias c2r='eval "`~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`"'
-
-
-

-
-
-
-

Documentation

-

The general index of the documentation for the various parts of Coriolis -are avalaibles here Coriolis Tools Documentation.

-
-

Note

-

Python Documentation: -Most of the documentation is related to the C++ API and implemetation of -the tools. However, the Python bindings have been created so they -mimic as closely as possible the C++ interface, so the documentation -applies to both languages with only minor syntactic changes.

-
-
-

General Software Architecture

-

Coriolis has been build with respect of the classical paradigm that the -computational instensive parts have been written in C++, and almost -everything else in Python. To build the Python interface we used -two methods:

-
    -
  • For self-contained modules boost::python (mainly in vlsisapd).
    • -
  • For all modules based on Hurricane, we created our own wrappers due -to very specific requirements such as shared functions between modules -or C++/Python secure bi-directional object deletion.
    • -
-

Coriolis Software Schematic

-
-
-
-

Coriolis Configuration & Initialisation

-

All configuration & initialization files are Python scripts, despite their -.conf extention. From a syntactic point of view, there is no difference -between the system-wide configuration files and the user's configuration, -they may use the same Python helpers. -

-

Configuration is done in two stages:

-
    -
  1. Selecting the symbolic technology.
    2. -
  2. Loading the complete configuration for the given technology.
    3. -
-
-

First Stage: Symbolic Technology Selection

-

-The initialization process is done by executing, in order, the following -file(s):

- ----- - - - - - - - - - - - - - - - - - - - - -
OrderMeaningFile
1The system setting/etc/coriolis2/techno.conf
2The user's global setting${HOME}/.coriolis2/techno.py
3The user's local setting<CWD>/.coriolis2/techno.py
-

Thoses files must provides only two variables, the name of the symbolic technology -and the one of the real technology. For example:

-
-# -*- Mode:Python -*-
-
-symbolicTechno = 'cmos'
-realTechno     = 'hcmos9'
-
-
-
-

Second Stage: Technology Configuration Loading

-

-The TECHNO variable is set by the first stage and it's the name of the -symbolic technology. A directory of that name, with all the configuration files, -must exists in the configuration directory. In addition to the technology-specific -directories, a common/ directory is there to provides a trunk for all the -identical datas across the various technologies. The initialization process is done -by executing, in order, the following file(s):

- ----- - - - - - - - - - - - - - - - - - - - - -
OrderMeaningFile
1The system initialization/etc/coriolis2/<TECHNO>/<TOOL>.conf
2The user's global initialization${HOME}/.coriolis2/settings.py
3The user's local initialization<CWD>/.coriolis2/settings.py
-
-

Note

-

The loading policy is not hard-coded. It is implemented -at Python level in /etc/coriolis2/coriolisInit.py, and thus may be easily be -amended to whatever site policy.

-

The truly mandatory requirement is the existence of coriolisInit.py -which must contain a coriolisConfigure() function with no argument.

-
-
-
-

Configuration Helpers

-

To ease the writing of configuration files, a set of small helpers -is available. They allow to setup the configuration parameters through -simple assembly of tuples. The helpers are installed under the directory:

-
-<install>/etc/coriolis2/
-
-

Where <install>/ is the root of the installation.

-

-
-

Alliance Helper

-

The configuration file must provide a allianceConfig tuple of -the form:

-
-cellsTop = '/usr/share/alliance/cells/'
-
-allianceConfig = \
-    ( ( 'SYMBOLIC_TECHNOLOGY', helpers.sysConfDir+'/technology.symbolic.xml'   )
-    , ( 'REAL_TECHNOLOGY'    , helpers.sysConfDir+'/technology.cmos130.s2r.xml')
-    , ( 'DISPLAY'            , helpers.sysConfDir+'/display.xml'               )
-    , ( 'CATALOG'            , 'CATAL')
-    , ( 'WORKING_LIBRARY'    , '.')
-    , ( 'SYSTEM_LIBRARY'     , ( (cellsTop+'sxlib'   , Environment.Append)
-                               , (cellsTop+'dp_sxlib', Environment.Append)
-                               , (cellsTop+'ramlib'  , Environment.Append)
-                               , (cellsTop+'romlib'  , Environment.Append)
-                               , (cellsTop+'rflib'   , Environment.Append)
-                               , (cellsTop+'rf2lib'  , Environment.Append)
-                               , (cellsTop+'pxlib'   , Environment.Append) ) )
-    , ( 'SCALE_X'            , 100)
-    , ( 'IN_LO'              , 'vst')
-    , ( 'IN_PH'              , 'ap')
-    , ( 'OUT_LO'             , 'vst')
-    , ( 'OUT_PH'             , 'ap')
-    , ( 'POWER'              , 'vdd')
-    , ( 'GROUND'             , 'vss')
-    , ( 'CLOCK'              , '^ck.*')
-    , ( 'BLOCKAGE'           , '^blockageNet*')
-    )
-
-

The example above shows the system configuration file, with all the -available settings. Some important remarks about thoses settings:

-
    -

  • In it's configuration file, the user do not need to redefine all the settings, -just the one he wants to change. In most of the cases, the SYSTEM_LIBRARY, -the WORKING_LIBRARY and the special net names (at this point there is not -much alternatives for the others settings).

    -
    • -

  • SYSTEM_LIBRARY setting: Setting up the library search path. -Each library entry in the tuple will be added to the search path according -to the second parameter:

    -
      -
    • Environment::Append: append to the search path.
      • -
    • Environment::Prepend: insert in head of the search path.
      • -
    • Environment::Replace: look for a library of the same name and replace -it, whithout changing the search path order. If no library of that name -already exists, it is appended.
      • -
    -

    A library is identified by it's name, this name is the last component of the -path name. For instance: /soc/alliance/sxlib will be named sxlib. -Implementing the Alliance specification, when looking for a Cell name, -the system will browse sequentially trought the library list and returns -the first Cell whose name match.

    -
    • -

  • For POWER, GROUND, CLOCK and BLOCKAGE net names, a regular -expression (gnu regexp) is expected.

    -
    • -

  • The helpers.sysConfDir variable is supplied by the helpers, it is the -directory in which the system-wide configuration files are locateds. -For a standard installation it would be: /soc/coriolis2.

    -
    • -
- - - - - - - - - - - - - - - - -

A typical user's configuration file would be:

-
-import os
-
-homeDir = os.getenv('HOME')
-
-allianceConfig = \
-    ( ('WORKING_LIBRARY'    , homeDir+'/worklib')
-    , ('SYSTEM_LIBRARY'     , ( (homeDir+'/mylib', Environment.Append) ) )
-    , ('POWER'              , 'vdd.*')
-    , ('GROUND'             , 'vss.*')
-    )
-
-
-
-

Tools Configuration Helpers

-

All the tools uses the same helper to load their configuration (a.k.a. -Configuration Helper). Currently the following configuration system-wide -configuration files are defined:

-
    -
  • misc.conf: commons settings or not belonging specifically to a tool.
    • -
  • etesian.conf: for the Etesian tool.
    • -
  • kite.conf: for the Kite tool.
    • -
  • stratus1.conf: for the Stratus1 tool.
    • -
-

Here is the contents of etesian.conf:

-
-# Etesian parameters.
-parametersTable = \
-    ( ('etesian.aspectRatio'    , TypePercentage, 100    , { 'min':10, 'max':1000 } )
-    , ('etesian.spaceMargin'    , TypePercentage, 5      )
-    , ('etesian.uniformDensity' , TypeBool      , False  )
-    , ('etesian.routingDriven'  , TypeBool      , False  )
-    , ("etesian.effort"         , TypeEnumerate , 2
-      , { 'values':( ("Fast"    , 1)
-                   , ("Standard", 2)
-                   , ("High"    , 3)
-                   , ("Extreme" , 4) ) }
-      )
-    , ("etesian.graphics"       , TypeEnumerate , 2
-      , { 'values':( ("Show every step"  , 1)
-                   , ("Show lower bound" , 2)
-                   , ("Show result only" , 3) ) }
-      )
-    )
-
-layoutTable = \
-    ( (TypeTab   , 'Etesian', 'etesian')
-
-    , (TypeTitle , 'Placement area')
-    , (TypeOption, "etesian.aspectRatio"   , "Aspect Ratio, X/Y (%)", 0 )
-    , (TypeOption, "etesian.spaceMargin"   , "Space Margin"         , 1 )
-    , (TypeRule  ,)
-    , (TypeTitle , 'Etesian - Placer')
-    , (TypeOption, "etesian.uniformDensity", "Uniform density"      , 0 )
-    , (TypeOption, "etesian.routingDriven" , "Routing driven"       , 0 )
-    , (TypeOption, "etesian.effort"        , "Placement effort"     , 1 )
-    , (TypeOption, "etesian.graphics"      , "Placement view"       , 1 )
-    , (TypeRule  ,)
-    )
-
-

Taxonomy of the file:

-
    -
  • It must contains, at least, the two tables:
      -
    • parametersTable, defines & initialise the configuration variables.
      • -
    • layoutTables, defines how the various parameters will be displayed -in the configuration window (The Settings Tab).
      • -
    -
    • -
  • The parametersTable, is a tuple (list) of tuples. Each entry in the list -describe a configuration parameter. In it's simplest form, it's a quadruplet -(TypeOption, 'paramId', ParameterType, DefaultValue) with:
      -
    1. TypeOption, tells that this tuple describe a parameter.
      2. -
    2. paramId, the identifier of the parameter. Identifiers are defined -by the tools. The list of parameters is detailed in each tool section.
      3. -
    3. ParameterType, the kind of parameter. Could be:
        -
      • TypeBool, boolean.
        • -
      • TypeInt, signed integer.
        • -
      • TypeEnumerate, enumerated type, needs extra entry.
        • -
      • TypePercentage, percentage, expressed between 0 and 100.
        • -
      • TypeDouble, float.
        • -
      • TypeString, character string.
        • -
      -
      4. -
    4. DefaultValue, the default value for that parameter.
      5. -
    -
    • -
-
-
-
-

Hacking the Configuration Files

-

Asides from the symbols that gets used by the configuration helpers like -allianceConfig or parametersTable, you can put pretty much anything -in <CWD>/.coriolis2/settings.py (that is, written in Python).

-

For example:

-
-# -*- Mode:Python -*-
-
-defaultStyle = 'Alliance.Classic [black]'
-
-# Regular Coriolis configuration.
-parametersTable = \
-    ( ('misc.catchCore'           , TypeBool      , False  )
-    , ('misc.info'                , TypeBool      , False  )
-    , ('misc.paranoid'            , TypeBool      , False  )
-    , ('misc.bug'                 , TypeBool      , False  )
-    , ('misc.logMode'             , TypeBool      , True   )
-    , ('misc.verboseLevel1'       , TypeBool      , False  )
-    , ('misc.verboseLevel2'       , TypeBool      , True   )
-    , ('misc.minTraceLevel'       , TypeInt       , 0      )
-    , ('misc.maxTraceLevel'       , TypeInt       , 0      )
-    )
-
-# Some ordinary Python script...
-import os
-
-print '       o  Cleaning up ClockTree previous run.'
-for fileName in os.listdir('.'):
-  if fileName.endswith('.ap') or (fileName.find('_clocked.') >= 0):
-    print '          - <%s>' % fileName
-    os.unlink(fileName)
-
-

See Python Interface to Coriolis for more details those capabilities.

-
-
-
-

CGT - The Graphical Interface

-

The Coriolis graphical interface is split up into two windows.

-
    -
  • The Viewer, with the following features:
      -
    • Basic load/save capabilities.
      • -
    • Display the current working cell. Could be empty if the design -is not yet placed.
      • -
    • Execute Stratus Scripts.
      • -
    • Menu to run the tools (placement, routage).
      • -
    -
    • -
-

Features are detailed in Viewer & Tools.

-

Viewer Basic Snapshot

-
    -
  • The Controller, which allows:
      -
    • Tweak what is displayer by the Viewer. Through the Look, -Filter and Layers&Gos tabs.
      • -
    • Browse the netlist with eponym tab.
      • -
    • Show the list of selected objects (if any) with selection
      • -
    • Walk through the Database, the Cell or the Selection with Inspector. -This is an advanced feature, reserved for experimented users.
      • -
    • The tab Settings which give access to all the settings. -They are closely related to Configuration & Initialisation.
      • -
    -
    • -
-

Controller Basic Snapshot

-
-
-

Viewer & Tools

-
-

Stratus Netlist Capture

-

Stratus is the replacement for GenLib procedural netlist capture language. -It is designed as a set of Python classes, and comes with it's own documentation -(Stratus Documentation)

-
-
-

The Hurricane Data-Base

-

The Alliance flow is based on the mbk data-base, which has one data-structure -for each view. That is, Lofig for the logical view and Phfig for the physical -view. The place and route tools were responsible for maintaining (or not) the -coherency between views. Reflecting this weak coupling between views, each one -was stored in a separate file with a specific format. The logical view is stored -in a vst file in vhdl format and the physical in an ap file in an ad-hoc format.

-

The Coriolis flow is based on the Hurricane data-base, which has a unified -structure for logical and physical view. That data structure is the Cell object. -The Cell can have any state between pure netlist and completly placed and -routed design. Although the memory representation of the views has deeply -changed we still use the Alliance files format, but they now really represent -views of the same object. The point is that one must be very careful about -view coherency when going to and from Coriolis.

-

As for the second release, Coriolis can be used only for three purposes :

-
    -
  • Placing a design, in which case the netlist view must be present.
    • -
  • Routing a design, in that case the netlist -view and the layout view must be present and layout view must contain -a placement. Both views must have the same name. When saving the routed design, -it is advised to change the design name otherwise the original unrouted placement -in the layout view will be overwritten.
    • -
  • Viewing a design, the netlist view must be present, if a layout -view is present it still must have the same name but it can be in any -state.
    • -
-
-
-

Synthetizing and loading a design

-

Coriolis supports several file formats. It can load all file format -from the Alliance toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), -BLIF netlist format as well as benchmark formats from the ISPD contests.

-

It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license -and may not be compiled in your version of the software.

-
-

Synthesis under Yosys

-

You can create a BLIF file from the Yosys synthetizer, which can be imported under Coriolis. -Most libraries are specified as a .lib liberty file and a .lef LEF file. -Yosys opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2. -If Coriolis hasn't been compiled against it, the library is given in Alliance .ap format. -Some free libraries already provide both .ap and .lib files.

-

Once you have installed a common library under Yosys and Coriolis, just synthetize your design -with Yosys and import it (as Blif without the extension) under Coriolis to perform place&route.

-
-
-

Synthesis under Alliance

-

Alliance is an older toolchain but has been extensively used for years. Coriolis can import -and write Alliance designs and libraries directly.

-
-
-
-

Etesian -- Placer

-

The Etesian placer is a state of the art (as of 2015) analytical placer. It is -within 5% of other placers' solutions, but is normally a bit worse than ePlace. -This Coriolis tool is actually an encapsulation of Coloquinte which is the placer.

-
-

Note

-

Instance Uniquification Unsupported: a same logical instance cannot have -two different placements. So, either you manually make a clone of it or you -supply a placement for it. We need to implement uniquification in the -Hurricane database.

-
-

-Hierarchical Placement

-

The placement area is defined by the top cell abutment box.

-

When placing a complete hierarchy, the abutment boxes of the cells (models) other than -the top cell are sets identical to the one of the top cell and their instances are -all placed at position (0,0,ID). That is, all the abutments boxes, whatever the -hierarchical level, defines the same area (they are exactly superposed).

-

We choose this scheme because the placer will see all the instances as virtually -flattened, so they can be placed anywhere inside the top-cell abutment box.

-

Etesian Abutment Box

-

-Computing the Placement Area

-

The placement area is computed using the etesian.aspectRatio and etesian.spaceMargin -parameters only if the top-cell has an empty abutment box. If the top-cell abutment -box has to be set, then it is propagated to all the instances models recursively.

-

-Reseting the Placement

-

Once a placement has been done, the placer cannot reset it (will be implemented -later). To perform a new placement, you must restart cgt. In addition, if you -have saved the placement on disk, you must erase any .ap file, which are -automatically reloaded along with the netlist (.vst).

-

-Limitations

-

Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version, -it doesn't support movable macros, and you must place every macro beforehand. -Timing and routability analysis are not included either, and the returned placement -may be unroutable.

-

-
-

Etesian Configuration Parameters

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter IdentifierTypeDefault
Etesian Parameters
etesian.aspectRatioTypePercentage100
Define the height on width H/W aspect -ratio, can be comprised between 10 and 1000
etesian.spaceMarginTypePercentage5
The extra white space added to the total area -of the standard cells
etesian.uniformDensityTypeBoolFalse
Whether the cells will be spread envenly -across the area or allowed to form denser -clusters
etesian.effortTypeInt2
Sets the balance between the speed of the -placer and the solution quality
etesian.routingDrivenTypeBoolFalse
Whether the tool will try routing iterations -and whitespace allocation to improve -routability; to be implemented
etesian.graphicsTypeInt2

How often the display will be refreshed -More refreshing slows the placer.

-
    -
  • 1 shows both upper and lower bounds
    • -
  • 2 only shows lower bound results
    • -
  • 3 only shows the final results
    • -
-
-
-
-
-

Knik -- Global Router

-

The quality of Knik global routing solutions are equivalent to those of FGR 1.0. -For an in-depth description of Knik algorithms, you may download the thesis of -D. Dupuis avalaible from here~: Knik Thesis.

-

The global router is (not yet) deterministic. To circumvent this limitation, -a global routing solution can be saved to disk and reloaded for later uses.

-

A global routing is saved into a file with the same name as the design and a -kgr extention. It is in Box Router output format.

-

Menus:

-
    -

  •

    menu_KiteSaveGlobalRouting.
    • -

  •

    menu_KiteLoadGlobalRouting.
    • -
-
-
-

Kite -- Detailed Router

-

Kite no longer suffers from the limitations of Nero. It can route big designs -as its runtime and memory footprint is almost linear (with respect to the number -of gates). It has successfully routed design of more than 150K gates. -

-

However, this first release comes with the temporary the following -restrictions:

-
    -
  • Works only with SxLib standard cell gauge.
    • -
  • Works always with 4 routing metal layers (M2 through M5).
    • -
  • Do not allow (take into account) pre-routed wires on signals -other than power or ground.
    • -
-
-

Note

-

Slow Layer Assignment. Most of the time, the layer assignment stage is -fast (less than a dozen seconds), but in some instances it can take more -than a dozen minutes. This is a known bug and will be corrected in later -releases.

-
-

After each run, Kite displays a set of completion ratios which must all -be equal to 100% if the detailed routing has been successfull. -In the event of a failure, on a saturated design, you may decrease the -edge saturation ratio (argument --edge) to balance more evenly the design -saturation. That is, the maximum saturation decrease at the price of a wider -saturated area and increased wirelength. This is the saturation of the -global router Knik, and you may increase/decrease by steps of 5%, -which represent one track. The maximum capacity of the SxLib gauge is -10 tracks in two layers, that makes 20 tracks by Knik edge.

-

Routing a design is done in four ordered steps:

-
    -
  1. Detailed pre-route

    menu_KiteDetailedPreRoute.
    2. -
  2. Global routing

    menu_KiteGlobalRoute.
    3. -
  3. Detailed routing

    menu_KiteDetailedRoute.
    4. -
  4. Finalize routing

    menu_KiteFinalizeRoute.
    5. -
-

It is possible to supply to the router a complete wiring for some nets that the user's -wants to be routed according to a specific topology. The supplied topology must respect -the building rules of the Katabatic database (contacts must be, terminals, turns, h-tee -& v-tee only). During the first step Detailed Pre-Route the router will solve -overlaps between the segments, without making any dogleg. If no pre-routed topologies -are present, this step may be ommited. Any net routed at this step is then fixed and -become unmovable for the later stages.

-

After the detailed routing step the Kite data-structure is still active -(the Hurricane wiring is decorated). The finalize step performs the removal of -the Kite data-structure, and it is not advisable to save the design before -that step.

-

You may visualize the density (saturation) of either Knik (on edges) or -Kite (on GCells) until the routing is finalized. Special layers appears -to that effect in the The Layers&Go Tab.

-
-

Kite Configuration Parameters

-

As Knik is only called through Kite, it's parameters also have -the kite. prefix.

-

The Katabatic parameters control the layer assignment step.

-

All the defaults value given below are from the default Alliance technology -(cmos and SxLib cell gauge/routing gauge).

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter IdentifierTypeDefault
Katabatic Parameters
katabatic.topRoutingLayerTypeStringMETAL5
Define the highest metal layer that will be -used for routing (inclusive).
katabatic.globalLengthThresholdTypeInt1450
This parameter is used by a layer assignment -method which is no longer used (did not give -good results)
katabatic.saturateRatioTypePercentage80
If M(x) density is above this ratio, -move up feedthru global segments up from -depth x to x+2
katabatic.saturateRpTypeInt8
If a GCell contains more terminals -(RoutingPad) than that number, force a -move up of the connecting segments to those -in excess
Knik Parameters
kite.hTracksReservedLocalTypeInt3
To take account the tracks needed inside a -GCell to build the local routing, decrease -the capacity of the edges of the global -router. Horizontal and vertical locally -reserved capacity can be distinguished for -more accuracy.
kite.vTracksReservedLocalTypeInt3
cf. kite.hTracksReservedLocal
Kite Parameters
kite.eventsLimitTypeInt4000002
The maximum number of segment displacements, -this is a last ditch safety against infinite -loop. It's perhaps a little too low for big -designs
kite.ripupCostTypeInt3
Differential introduced between two ripup -cost to avoid a loop between two ripped up -segments
kite.strapRipupLimitTypeInt16
Maximum number of ripup for strap segments
kite.localRipupLimitTypeInt9
Maximum number of ripup for local segments
kite.globalRipupLimitTypeInt5
Maximum number of ripup for global segments, -when this limit is reached, triggers topologic -modification
kite.longGlobalRipupLimitTypeInt5
Maximum number of ripup for long global -segments, when this limit is reached, triggers -topological modification
-
-
-
-

Executing Python Scripts in Cgt

-

Python/Stratus scripts can be executed either in text or graphical mode.

-
-

Note

-

How Cgt Locates Python Scripts: -cgt uses the Python import mechanism to load Python scripts. -So you must give the name of your script whitout .py extention and -it must be reachable through the PYTHONPATH. You may uses the -dotted module notation.

-
-

A Python/Stratus script must contains a function called ScriptMain() -with one optional argument, the graphical editor into which it may be -running (will be set to None in text mode). The Python interface to -the editor (type: CellViewer) is limited to basic capabilities -only.

-

Any script given on the command line will be run immediatly after the -initializations and before any other argument is processed.

-

For more explanation on Python scripts see Python Interface to Coriolis.

-
-
-

Printing & Snapshots

-

Printing or saving into a pdf is fairly simple, just uses the File -> Print -menu or the CTRL+P shortcut to open the dialog box.

-

The print functionality uses exactly the same rendering mechanism as for the -screen, beeing almost WYSIWYG. Thus, to obtain the best results it is advisable -to select the Coriolis.Printer look (in the Controller), which uses a -white background and much suited for high resolutions 32x32 pixels patterns

-

There is also two mode of printing selectable through the Controller -Settings -> Misc -> Printer/Snapshot Mode:

- ----- - - - - - - - - - - - - - - -
ModeDPI (approx.)Intended Usage
Cell Mode150For single Cell printing or very small designs. -Patterns will be bigger and more readable.
Design Mode300For designs (mostly commposed of wires and cells -outlines).
-
-

Note

-

The pdf file size -Be aware that the generated pdf files are indeed only pixmaps. -So they can grew very large if you select paper format above A2 -or similar.

-
-

-Saving into an image is subject to the same remarks as for pdf.

-
-
-

Memento of Shortcuts in Graphic Mode

-

The main application binary is cgt.

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CategoryKeysAction
Moves
-
Up, -Down
-
Left, -Right
-
-		Shift the view in the according direction
FitfFit to the Cell abutment box
RefreshCTRL+LTriggers a complete display redraw
Gotogapperture is the minimum side of the area -displayed around the point to go to. It's an -alternative way of setting the zoom level
Zoomz, -mRespectively zoom by a 2 factor and unzoom -by a 2 factor
-
BigMouse
-
Area Zoom
-
-		You can perform a zoom to an area. -Define the zoom area by holding down the left -mouse button while moving the mouse.
Selection
-
BigMouse
-
Area Selection
-
-		You can select displayed objects under an area. -Define the selection area by holding down the -right mouse button while moving the mouse.
-
BigMouse
-
Toggle Selection
-
-		You can toggle the selection of one object under -the mouse position by pressing CTRL and -pressing down the right mouse button. A popup -list of what's under the position shows up into -which you can toggle the selection state of one -item.
SToggle the selection visibility
ControllerCTRL+I

Show/hide the controller window.

-

It's the Swiss Army Knife of the viewer. -From it, you can fine-control the display and -inspect almost everything in your design.

-
Rulersk, -ESCOne stroke on k enters the ruler mode, in -which you can draw one ruler. You can exit the -ruler mode by pressing ESC. Once in ruler -mode, the first click on the left mouse button -sets the ruler's starting point and the second -click the ruler's end point. The second click -exits automatically the ruler mode.
KClears all the drawn rulers
PrintCTRL+PCurrently rather crude. It's a direct copy of -what's displayed in pixels. So the resulting -picture will be a little blurred due to -anti-aliasing mechanism.
Open/CloseCTRL+OOpens a new design. The design name must be -given without path or extention.
CTRL+WClose the current viewer window, but do not quit -the application.
CTRL+QCTRL+Q quit the application -(closing all windows).
HierarchyCTRL+DownGo one hierarchy level down. That is, if there -is an instance under the cursor position, load -it's model Cell in place of the current one.
CTRL+UpGo one hierarchy level up. if we have entered -the current model through CTRL+Down -reload the previous model (the one -in which this model is instanciated).
-
-
-

Cgt Command Line Options

-

Appart from the obvious --text options, all can be used for text and graphical mode.

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentsMeaning
-t|--textInstruct cgt to run in text mode.
-L|--log-modeDisable the uses of ansi escape sequence on -the tty. Useful when the output is -redirected to a file.
-c <cell>|--cell=<cell>The name of the design to load, without -leading path or extention.
-g|--load-globalReload a global routing solution from disk. -The file containing the solution must be named -<cell>.kgr.
--save-globalSave the global routing solution, into a file -named <design>.kgr.
-e <ratio>|--edge=<ratio>Change the edge capacity for the global -router, between 0 and 1 (Knik).
-G|--global-routeRun the global router (Knik).
-R|--detailed-routeRun the detailed router (Kite).
-s|--save-design=<routed>The design into which the routed layout will -be saved. It is strongly recommanded to choose -a different name from the source (unrouted) -design.
--events-limit=<count>The maximal number of events after which the -router will stops. This is mainly a failsafe -against looping. The limit is sets to 4 -millions of iteration which should suffice to -any design of 100K. gates. For bigger -designs you may wants to increase this limit.
--stratus-script=<module>Run the Python/Stratus script module. -See Python Scripts in Cgt.
-

Some Examples :

-
    -

  • Run both global and detailed router, then save the routed design :

    -
    -> cgt -v -t -G -R --cell=design --save-design=design_kite
-
    -
    • -

  • Load a previous global solution, run the detailed router, then save the -routed design :

    -
    -> cgt -v -t --load-global -R --cell=design --save-design=design_kite
-
    -
    • -

  • Run the global router, then save the global routing solution :

    -
    -> cgt -v -t -G --save-global --cell=design
-
    -
    • -
-
-
-

Miscellaneous Settings

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter IdentifierTypeDefault
Verbosity/Log Parameters
misc.infoTypeBoolFalse
Enable display of info level message -(cinfo stream)
misc.bugTypeBoolFalse
Enable display of bug level message -(cbug stream), messages can be a little -scarry
misc.logModeTypeBoolFalse
If enabled, assume that the output device -is not a tty and suppress any escaped -sequences
misc.verboseLevel1TypeBoolTrue
First level of verbosity, disable level 2
misc.verboseLevel2TypeBoolFalse
Second level of verbosity
Development/Debug Parameters
misc.minTraceLevelTypeInt0
misc.maxTraceLevelTypeInt0
Display trace information between those two -levels (cdebug stream)
misc.catchCoreTypeBoolFalse
By default, cgt do not dump core. -To generate one set this flag to True
-

-
-
-
-

The Controller

-

The Controller window is composed of seven tabs:

-
    -
  1. The Look Tab to select the display style.
    2. -
  2. The Filter Tab the hierarchical levels to be displayed, the look of -rubbers and the dimension units.
    3. -
  3. The Layers&Go Tab to selectively hide/display layers.
    4. -
  4. The Netlist Tab to browse through the netlist. Works in association -with the Selection tab.
    5. -
  5. The Selection Tab allow to view all the currently selected elements.
    6. -
  6. The Inspector Tab browse through either the DataBase, the Cell or -the current selection.
    7. -
  7. The Settings Tab access all the tool's configuration settings.
    8. -
-
-

The Look Tab

-

You can select how the layout will be displayed. There is a special one -Printer.Coriolis specifically designed for Printing & Snapshots. -You should select it prior to calling the print or snapshot dialog boxes.

-

Controller Basic Snapshot

-
-
-

The Filter Tab

-

The filter tab let you select what hierarchical levels of your design will be -displayed. Hierarchy level are numbered top-down: the level 0 correspond to -the top-level cell, the level one to the instances of the top-level Cell and -so on.

-

There are also check boxes to enable/disable the processing of Terminal Cell, -Master Cells and Compnents. The processing of Terminal Cell (hierarchy leaf -cells) is disabled by default when you load a hierarchical design and enabled -when you load a single Cell.

-

You can choose what kind of form to give to the rubbers and the type of -unit used to display coordinates.

-
-

Note

-

What are Rubbers: Hurricane uses Rubbers to materialize -physical gaps in net topology. That is, if some wires are missing to -connect two or more parts of net, a rubber will be drawn between them -to signal the gap.

-

For example, after the detailed routing no rubbers should remains. -They have been made very visibles as big violet lines...

-
-

Controller Basic Snapshot

-
-
-

The Layers&Go Tab

-

Control the individual display of all layers and Gos.

-
    -
  • Layers correspond to a true physical layer. From a Hurricane point of -view they are all the BasicLayers (could be matched to GDSII).
    • -
  • Gos stands from Graphical Objects, they are drawings that have no -physical existence but are added by the various tools to display extra -information. One good exemple is the density map of the detailed router, -to easily locate congested areas.
    • -
-

For each layer/Go there are two check boxes:

-
    -
  • The normal one triggers the display.
    • -
  • The red-outlined allows objects of that layer to be selectable or not.
    • -
-

Controller Basic Snapshot

-
-
-

The Netlist Tab

-

The Netlist tab shows the list of nets... By default the tab is not -synched with the displayed Cell. To see the nets you must check the -Sync Netlist checkbox. You can narrow the set of displayed nets by -using the filter pattern (supports regular expressions).

-

An very useful feature is to enable the Sync Selection, which will -automatically select all the components of the selected net(s). You can -select multiple nets. In the figure the net auxsc35 is selected and -is highlited in the Viewer.

-

Controller Basic Snapshot
-
Controller Basic Snapshot

-
-
-

The Selection Tab

-

The Selection tab list all the components currently selecteds. They -can be filtered thanks to the filter pattern.

-

Used in conjunction with the Netlist Sync Selection you will all see -all the components part of net.

-

In this list, you can toggle individually the selection of component by -pressing the t key. When unselected in this way a component is not -removed from the the selection list but instead displayed in red italic. -To see where a component is you may make it blink by repeatedly press -the t key...

-

Controller Basic Snapshot

-
-
-

The Inspector Tab

-

This tab is very useful, but mostly for Coriolis developpers. It allows -to browse through the live DataBase. The Inspector provide three entry points:

-
    -
  • DataBase: Starts from the whole Hurricane DataBase.
    • -
  • Cell: Inspect the currently loaded Cell.
    • -
  • Selection: Inspect the object currently highlited in the Selection tab.
    • -
-

Once an entry point has been activated, you may recursively expore all -it's fields using the right/left arrows.

-
-

Note

-

Do not put your fingers in the socket: when inspecting -anything, do not modify the DataBase. If any object under inspection -is deleted, you will crash the application...

-
-
-

Note

-

Implementation Detail: the inspector support is done with -Slot, Record and getString().

-
-

Controller Basic Snapshot
-
Controller Basic Snapshot
 -
Controller Basic Snapshot

-
-
-

The Settings Tab

-

Here comes the description of the Settings tab.

-

Controller Basic Snapshot

-
-
-
-

Python Interface for Hurricane / Coriolis

-

The (almost) complete interface of Hurricane is exported as a Python module -and some part of the other components of Coriolis (each one in a separate -module). The interface has been made to mirror as closely as possible the -C++ one, so the C++ doxygen documentation could be used to write code with -either languages.

-

Summary of the C++ Documentation

-

A script could be run directly in text mode from the command line or through -the graphical interface (see Python Scripts in Cgt).

-

Asides for this requirement, the python script can contain anything valid -in Python, so don't hesitate to use any package or extention.

-

Small example of Python/Stratus script:

-
-from Hurricane import *
-from Stratus   import *
-
-def doSomething ():
-    # ...
-    return
-
-def ScriptMain ( **kw ):
-  editor = None
-  if kw.has_key('editor') and kw['editor']:
-    editor = kw['editor']
-    stratus.setEditor( editor )
-
-  doSomething()
-  return
-
-if __name__ == "__main__" :
-  kw           = {}
-  success      = ScriptMain( **kw )
-  shellSuccess = 0
-  if not success: shellSuccess = 1
-
-  sys.exit( shellSuccess )
-      ScriptMain ()
-
-

This typical script can be executed in two ways:

-
    -

  1. Run directly as a Python script, thanks to the

    -
    -if __name__ == "__main__" :
-
    -

    part (this is standart Python). It is a simple adapter that will -calls ScriptMain().

    -
    2. -

  2. Through cgt, either in text or graphical mode. In that case, the -ScriptMain() is directly called trough a sub-interpreter. -The arguments of the script are passed through the **kw dictionnary.

    - ---- - - - - - - - - - - - - - - - -
    **kw Dictionnary
    Parameter Key/NameContents type
    'cell'A Hurricane cell on which to work. Depending -on the context, it may be None. -For example, when run from cgt, it the cell -currently loaded in the viewer, if any.
    'editor'The viewer from which the script is run, when -lauched through cgt.
    -
    3. -
-
-
-

Plugins

-

Plugins are Python scripts specially crafted to integrate with cgt. -Their entry point is a ScriptMain() method as described in -Python Interface to Coriolis. They can be called by user scripts -through this method.

-
-

Chip Placement

-

Automatically perform the placement of a complete chip. This plugin, as well -as the other P&R tools expect a specific top-level hierarchy for the design. -The top-level hierarchy must contains the instances of all the I/O pads and -exactly one instance of the chip's core model.

-

Chip Top Structure

-

The designer must provide a configuration file that define the rules for the -placement of the top-level hierarchy (that is, the pads and the core). -This file must be named after the chip's name, by appending _chip.py -(obviously, it is a Python file). For instance if the chip netlist file -is called amd2901_crl.vst, then the configuration file must be named -amd2901_crl_chip.vst.

-

Example of chip placement configuration file (for AM2901):

-
-chip = \
-  { 'pads.south'     : [ 'p_a3'     , 'p_a2'     , 'p_a1'     , 'p_r0'
-                       , 'p_vddick0', 'p_vssick0', 'p_a0'     , 'p_i6'
-                       , 'p_i8'     , 'p_i7'     , 'p_r3'     ]
-  , 'pads.east'      : [ 'p_zero'   , 'p_i0'     , 'p_i1'     , 'p_i2'
-                       , 'p_vddeck0', 'p_vsseck0', 'p_q3'     , 'p_b0'
-                       , 'p_b1'     , 'p_b2'     , 'p_b3'     ]
-  , 'pads.north'     : [ 'p_noe'    , 'p_y3'     , 'p_y2'     , 'p_y1'
-                       , 'p_y0'     , 'p_vddeck1', 'p_vsseck1', 'p_np'
-                       , 'p_ovr'    , 'p_cout'   , 'p_ng'     ]
-  , 'pads.west'      : [ 'p_cin'    , 'p_i4'     , 'p_i5'     , 'p_i3'
-                       , 'p_ck'     , 'p_d0'     , 'p_d1'     , 'p_d2'
-                       , 'p_d3'     , 'p_q0'     , 'p_f3'     ]
-  , 'core.size'      : ( 1500, 1500 )
-  , 'chip.size'      : ( 3000, 3000 )
-  , 'chip.clockTree' : True
-  }
-
-

The file must contain one dictionnary named chip.

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Chip Dictionnary
Parameter Key/NameValue/Contents type
'pad.south'Ordered list (left to right) of pad instances names -to put on the south side of the chip
'pad.east'Ordered list (down to up) of pad instances names -to put on the east side of the chip
'pad.north'Ordered list (left to right) of pad instances names -to put on the north side of the chip
'pad.west'Ordered list (down to up) of pad instances names -to put on the west side of the chip
'core.size'The size of the core (to be used by the placer)
'chip.size'The size of the whole chip. The sides must be great -enough to accomodate all the pads
'chip.clockTree'Whether to generate a clock tree or not. This calls -the ClockTree plugin
-

Configuration parameters, defaults are defined in etc/coriolis2/<STECHNO>/plugins.conf.

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter IdentifierTypeDefault
Chip Plugin Parameters
chip.block.rails.countTypeInt5
The minimum number of rails around the core -block. Must be odd and suppérior to 5. -One rail for the clock and at least two pairs -of power/grounds
chip.block.rails.hWidthTypeInt12
The horizontal with of the rails
chip.block.rails.vWidthTypeInt12
The vertical with of the rails
chip.block.rails.hSpacingTypeInt6
The spacing, edge to edge of two adjacent -horizontal rails
chip.block.rails.vSpacingTypeInt6
The spacing, edge to edge of two adjacent -vertical rails
chip.pad.pckTypeStringpck_px
The model name of the pad connected to the -chip external clock
chip.pad.pvddeckTypeStringpvddeck_px
The model name of the pad connected to the -vdde (external power) and suppling it to -the core
chip.pad.pvsseckTypeStringpvsseck_px
The model name of the pad connected to the -vsse (external ground) and suppling it to -the core
chip.pad.pvddickTypeStringpvddick_px
The model name of the pad connected to the -vddi (internal power) and suppling it to -the core
chip.pad.pvssickTypeStringpvssick_px
The model name of the pad connected to the -vssi (internal ground) and suppling it to -the core
-
-

Note

-

If no clock tree is generated, then the clock rail is not created. -So even if the requested number of rails chip.block.rails.count is, say 5, -only four rails (2* power, 2* ground) will be generateds.

-
-
-
-

Clock Tree

-

Insert a clock tree into a block. The clock tree uses the H strategy. -The clock net is splitted into sub-nets, one for each branch of the -tree.

-
    -

  • On chips design, the sub-nets are createds in the model of the -core block (then trans-hierarchically flattened to be shown at -chip level).

    -
    • -

  • On blocks, the sub nets are created directly in the top block.

    -
    • -

  • The sub-nets are named according to a simple geometrical scheme. -A common prefix ck_htree, then one postfix by level telling -on which quarter of plane the sub-clock is located:

    -
      -
    1. _bl: bottom left plane quarter.
      2. -
    2. _br: bottom right plane quarter.
      3. -
    3. _tl: top left plane quarter.
      4. -
    4. _tr: top right plane quarter.
      5. -
    -

    We can have ck_htree_bl, ck_htree_bl_bl, ch_htree_bl_tl and so on.

    -
    • -
-

The clock tree plugin works in four steps:

-
    -
  1. Build the clock tree: creates the top-block abutment box, compute the -levels of H tree neededs and place the clock buffers.
    2. -
  2. Once the clock buffers are placed, calls the placer (Etesian) to place -the ordinary standart cells, whithout disturbing clock H-tree buffers.
    3. -
  3. At this point we know the exact positions of all the DFFs, so we can -connect them to the nearest H-tree leaf clock signal.
    4. -
  4. Leaf clock signals that are not connecteds to any DFFs are removed.
    5. -
-

Netlist reorganisation:

-
    -
  • Obviously the top block or chip core model netlist is modificated to -contains all the clock sub-nets. The interface is not changed.
    • -
  • If the top block contains instances of other models and those models -contains DFFs that get re-connecteds to the clock sub-nets (from the -top level). Change both the model netlist and interface to propagate -the relevant clock sub-nets to the instanciated model. The new model -with the added clock signal is renamed with a _clocked suffix. -For example, the sub-block model ram.vst will become ram_clocked.vst.
    • -
-
-

Note

-

If you are to re-run the clock tree plugin on a netlist, be careful -to erase any previously generated _clocked file (both netlist and -layout: rm *.clocked.{ap,vst}). And restart cgt to clear it's -memory cache.

-
-

Configuration parameters, defaults are defined in etc/coriolis2/<STECHNO>/plugins.conf.

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter IdentifierTypeDefault
ClockTree Plugin Parameters
clockTree.minimumSideTypeInt300
The minimum size below which the clock tree -will stop to perform quadri-partitions
clockTree.bufferTypeStringbuf_x2
The buffer model to use to drive sub-nets
clockTree.placerEngineTypeStringEtesian
The placer to use. Other value is Mauka -the simulated annealing placer which will go -into retirement very soon
-
-
-

Recursive-Save (RSave)

-

Perform a recursive top down save of all the models from the top cell -loaded in cgt. Force a write of any non-terminal model. This plugin is used -by the clock tree plugin after the netlist clock sub-nets creation.

-
-
-
-

A Simple Example: AM2901

-

To illustrate the capabilities of Coriolis tools and Python scripting, a small -example, derived from the Alliance AM2901 is supplied.

-

This example contains only the synthetized netlists and the doChip.py script -which perform the whole P&R of the design.

-

You can generate the chip using one of the following method:

-
    -

  1. Command line mode: directly run the script:

    -
    -dummy@lepka:AM2901$ ./doChip -V --cell=amd2901
-
    -
    2. -

  2. Graphic mode: launch cgt, load chip netlist amd2901 (the top cell) -then run the Python script doChip.py.

    -
    3. -
-
-

Note

-

Between two consecutive run, be sure to erase the netlist/layout generateds:

-
-dummy@lepka:AM2901$ rm *_clocked*.vst *.ap
-
-
-
-
-
- - diff --git a/documentation/UsersGuide/UsersGuide.pdf b/documentation/UsersGuide/UsersGuide.pdf index 181cb75f..d578d261 100644 Binary files a/documentation/UsersGuide/UsersGuide.pdf and b/documentation/UsersGuide/UsersGuide.pdf differ diff --git a/documentation/UsersGuide/UsersGuide.rst b/documentation/UsersGuide/UsersGuide.rst deleted file mode 100644 index 3b058989..00000000 --- a/documentation/UsersGuide/UsersGuide.rst +++ /dev/null @@ -1,2007 +0,0 @@ - -.. -*- Mode: rst -*- - -.. role:: ul -.. role:: cb -.. role:: sc -.. role:: fboxtt - -.. Acronyms & names. -.. |GNU| replace:: :sc:`gnu` -.. |LGPL| replace:: :sc:`lgpl` -.. |GPL| replace:: :sc:`gpl` -.. |UPMC| replace:: :sc:`upmc` -.. |Bull| replace:: :sc:`Bull` -.. |Cadence| replace:: :sc:`Cadence` -.. |Si2| replace:: :sc:`Si2` -.. |LEFDEF| replace:: :sc:`lefdef` -.. |Flute| replace:: :sc:`Flute` -.. |MacOS| replace:: :sc:`MacOS` -.. |RHEL6| replace:: :sc:`rhel6` -.. |RHEL7| replace:: :sc:`rhel7` -.. |SL6| replace:: :sc:`Scientific Linux 6` -.. |SL7| replace:: :sc:`Scientific Linux 7` -.. |Scientific Linux| replace:: :sc:`Scientific Linux` -.. |RedHat| replace:: :sc:`RedHat` -.. |Fedora| replace:: :sc:`Fedora` -.. |FC13| replace:: :sc:`fc13` -.. |Debian| replace:: :sc:`Debian` -.. |Ubuntu| replace:: :sc:`Ubuntu` - -.. |Alexandre| replace:: :sc:`Alexandre` -.. |Belloeil| replace:: :sc:`Belloeil` -.. |Chaput| replace:: :sc:`Chaput` -.. |Chu| replace:: :sc:`Chu` -.. |Clement| replace:: :sc:`Clement` -.. |Dupuis| replace:: :sc:`Dupuis` -.. |Escassut| replace:: :sc:`Escassut` -.. |Gouvine| replace:: :sc:`Gouvine` -.. |Masson| replace:: :sc:`Masson` -.. |Sroka| replace:: :sc:`Sroka` -.. |Yifei| replace:: :sc:`Yifei` - -.. |ANSI| replace:: :sc:`ansi` -.. |MIPS| replace:: :sc:`mips` -.. |Am2901| replace:: :sc:`Am2901` -.. |Hurricane| replace:: :sc:`Hurricane` -.. |HurricaneAMS| replace:: :sc:`HurricaneAMS` -.. |Alliance| replace:: :sc:`Alliance` -.. |Yosys| replace:: :sc:`Yosys` -.. |GenLib| replace:: :sc:`GenLib` -.. |Nero| replace:: :sc:`Nero` -.. |Druc| replace:: :cb:`Druc` -.. |Coloquinte| replace:: :sc:`Coloquinte` -.. |Coriolis| replace:: :sc:`Coriolis` -.. |Coriolis1| replace:: :sc:`Coriolis 1` -.. |Coriolis2| replace:: :sc:`Coriolis 2` -.. |VLSISAPD| replace:: :sc:`vlsisapd` -.. |CRLcore| replace:: :sc:`CRLcore` -.. |Cyclop| replace:: :sc:`Cyclop` -.. |Nimbus| replace:: :sc:`Nimbus` -.. |hMetis| replace:: :sc:`hMetis` -.. |Mauka| replace:: :sc:`Mauka` -.. |Etesian| replace:: :sc:`Etesian` -.. |Knik| replace:: :sc:`Knik` -.. |Katabatic| replace:: :sc:`Katabatic` -.. |Kite| replace:: :sc:`Kite` -.. |Stratus| replace:: :sc:`Stratus` -.. |Stratus1| replace:: :sc:`Stratus1` -.. |Stratus2| replace:: :sc:`Stratus2` -.. |Unicorn| replace:: :sc:`Unicorn` -.. |ccb| replace:: :cb:`ccb` -.. |cgt| replace:: :cb:`cgt` -.. |Chams| replace:: :sc:`Chams` -.. |OpenChams| replace:: :sc:`OpenChams` -.. |Pharos| replace:: :cb:`Pharos` -.. |API| replace:: :sc:`api` -.. |STL| replace:: :sc:`stl` -.. |XML| replace:: :sc:`xml` -.. |pdf| replace:: :sc:`pdf` -.. |UTF-8| replace:: :sc:`utf-8` -.. |Python| replace:: :sc:`Python` -.. |Linux| replace:: :sc:`Linux` -.. |MacPorts| replace:: :sc:`MacPorts` -.. |devtoolset2| replace:: :cb:`devtoolset2` -.. |boost| replace:: :cb:`boost` -.. |Qt| replace:: :sc:`qt` -.. |tty| replace:: :cb:`tty` -.. |svn| replace:: :cb:`svn` -.. |git| replace:: :cb:`git` -.. |rpm| replace:: :cb:`rpm` -.. |gdb| replace:: :cb:`gdb` - -.. |KeyUp| replace:: :fboxtt:`Up` -.. |KeyDown| replace:: :fboxtt:`Down` -.. |KeyLeft| replace:: :fboxtt:`Left` -.. |KeyRight| replace:: :fboxtt:`Right` -.. |KeyF| replace:: :fboxtt:`f` -.. |KeyL| replace:: :fboxtt:`l` -.. |KeyG| replace:: :fboxtt:`g` -.. |KeyZ| replace:: :fboxtt:`z` -.. |KeyM| replace:: :fboxtt:`m` -.. |KeyI| replace:: :fboxtt:`i` -.. |KeyK| replace:: :fboxtt:`k` -.. |KeyP| replace:: :fboxtt:`p` -.. |KeyO| replace:: :fboxtt:`o` -.. |KeyW| replace:: :fboxtt:`w` -.. |KeyQ| replace:: :fboxtt:`q` -.. |KeyCapK| replace:: :fboxtt:`K` -.. |KeyCapS| replace:: :fboxtt:`S` -.. |Plus| replace:: :fboxtt:`+` -.. |KeyESC| replace:: :fboxtt:`ESC` -.. |CTRL| replace:: :fboxtt:`CTRL` -.. |CTRL_L| replace:: :fboxtt:`CTRL+L` -.. |CTRL_I| replace:: :fboxtt:`CTRL+I` -.. |CTRL_P| replace:: :fboxtt:`CTRL+P` -.. |CTRL_O| replace:: :fboxtt:`CTRL+O` -.. |CTRL_W| replace:: :fboxtt:`CTRL+W` -.. |CTRL_Q| replace:: :fboxtt:`CTRL+Q` -.. |CTRL_Down| replace:: :fboxtt:`CTRL+Down` -.. |CTRL_Up| replace:: :fboxtt:`CTRL+Up` -.. |CTRL_Left| replace:: :fboxtt:`CTRL+Left` -.. |CTRL_Right| replace:: :fboxtt:`CTRL+Right` - -.. URLs -.. _FGR: http://vlsicad.eecs.umich.edu/BK/FGR/ -.. _Box Router: http://www.cerc.utexas.edu/~thyeros/boxrouter/boxrouter.htm -.. _hMETIS: http://glaros.dtc.umn.edu/gkhome/views/metis -.. _Knik Thesis: http://www-soc.lip6.fr/en/users/damiendupuis/PhD/ -.. _RapidJSON: http://miloyip.github.io/rapidjson/ - -.. _coriolis2-1.0.2049-1.slsoc6.i686.rpm: http://asim.lip6.fr/pub/coriolis/2.0/coriolis2-1.0.2049-1.slsoc6.i686.rpm -.. _coriolis2-1.0.2049-1.slsoc6.x86_64.rpm: http://asim.lip6.fr/pub/coriolis/2.0/coriolis2-1.0.2049-1.slsoc6.x86_64.rpm -.. _coriolis2-1.0.2049-1.fc16.i686.rpm: http://asim.lip6.fr/pub/coriolis/2.0/coriolis2-1.0.2049-1.fc16.i686.rpm -.. _coriolis2-1.0.2049-1.fc16.x86_64.rpm: http://asim.lip6.fr/pub/coriolis/2.0/coriolis2-1.0.2049-1.fc16.x86_64.rpm -.. _coriolis2_1.0-2049-1_.i386.rpm (10.04): http://asim.lip6.fr/pub/coriolis/2.0/Ubuntu/10.04/coriolis2_1.0-2049-1_i386.rpm -.. _coriolis2_1.0-2049-1_.amd64.rpm (10.04): http://asim.lip6.fr/pub/coriolis/2.0/Ubuntu/10.04/coriolis2_1.0-2049-1_i386.rpm -.. _coriolis2_1.0-2049-1_.i386.rpm (12.04): http://asim.lip6.fr/pub/coriolis/2.0/Ubuntu/12.04/coriolis2_1.0-2049-1_i386.rpm -.. _coriolis2_1.0-2049-1_.amd64.rpm (12.04): http://asim.lip6.fr/pub/coriolis/2.0/Ubuntu/12.04/coriolis2_1.0-2049-1_i386.rpm - -.. Standard CAO/VLSI Concepts. -.. |netlist| replace:: *netlist* -.. |netlists| replace:: *netlists* -.. |layout| replace:: *layout* -.. |layouts| replace:: *layouts* -.. |CMOS| replace:: :sc:`cmos` -.. |VHDL| replace:: :sc:`vhdl` -.. |NWELL| replace:: :sc:`nwell` -.. |POWER| replace:: :sc:`power` -.. |GROUND| replace:: :sc:`ground` - -.. MBK Concepts -.. |MBK| replace:: :sc:`mbk` -.. |LOFIG| replace:: :cb:`Lofig` -.. |PHFIG| replace:: :cb:`Phfig` -.. |SxLib| replace:: :sc:`SxLib` - -.. Hurricane Concepts. -.. |hypernet| replace:: *hypernet* -.. |hypernets| replace:: *hypernets* -.. |Cell| replace:: *Cell* -.. |Rings| replace:: *Rings* -.. |QuadTrees| replace:: *QuadTrees* -.. |Collections| replace:: *Collections* -.. |ap| replace:: :cb:`ap` -.. |vst| replace:: :cb:`vst` -.. |kgr| replace:: :cb:`kgr` -.. |dot_conf| replace:: :cb:`.conf` - - -|medskip| - -===================== -Coriolis User's Guide -===================== - -|medskip| - -.. raw:: html - -
- The pdf version of this document is available here:
- Coriolis User's Guide -
- -.. contents:: - -|newpage| - - -Credits & License -================= - -.. raw:: html - -

Hurricane - Rémy Escassut & - Christian Masson

-
-

Etesian - Gabriel Gouvine

-
-

Stratus - Sophie Belloeil

-
-

Knik - Damien Dupuis

-
-

Kite, - Unicorn - Jean-Paul Chaput

-
- - -.. raw:: latex - - \begin{center}\begin{minipage}[t]{.8\textwidth} - \noindent\DUrole{sc}{Hurricane} \dotfill Rémy \DUrole{sc}{Escassut} \& - Christian \DUrole{sc}{Masson} \\ - \noindent\DUrole{sc}{Etesian} \dotfill Gabriel \DUrole{sc}{Gouvine} \\ - \noindent\DUrole{sc}{Stratus} \dotfill Sophie \DUrole{sc}{Belloeil} \\ - \noindent\DUrole{sc}{Knik} \dotfill Damien \DUrole{sc}{Dupuis} \\ - \noindent\DUrole{sc}{Kite}, - \DUrole{sc}{Unicorn} \dotfill Jean-Paul \DUrole{sc}{Chaput} \\ - \end{minipage}\end{center} - - -|medskip| - -The |Hurricane| data-base is copyright© |Bull| 2000-2016 and is -released under the terms of the |LGPL| license. All other tools are -copyright© |UPMC| 2008-2016 and released under the |GPL| -license. - -Others important contributors to |Coriolis| are Christophe |Alexandre|, -Hugo |Clement|, Marek |Sroka| and Wu |Yifei|. - -The |Knik| router makes use of the |Flute| software, which is -copyright© Chris C. N. |Chu| from the Iowa State University -(http://home.eng.iastate.edu/~cnchu/). - -|newpage| - - -Release Notes -============= - -Release 1.0.1475 -~~~~~~~~~~~~~~~~ - -This is the first preliminary release of the |Coriolis2| framework. - -This release mainly ships the global router |Knik| and the detailed router -|Kite|. Together they aim to replace the |Alliance| |Nero| router. -Unlike |Nero|, |Kite| is based on an innovating routing modeling and ad-hoc -algorithm. Although it is released under |GPL| license, the source code -will be avalaible later. -|medskip| - - -|noindent| Contents of this release: - -1. A graphical user interface (viewer only). -2. The |Knik| global router. -3. The |Kite| detailed router. - -|noindent| Supported input/output formats: - -* |Alliance| |vst| (netlist) & |ap| (physical) formats. -* Even if there are some references to the |Cadence| |LEFDEF| format, its - support is not included because it depends on a library only available - to |Si2| affiliated members. - - -Release 1.0.1963 -~~~~~~~~~~~~~~~~ - -Release 1963 is alpha. All the tools from |Coriolis1| have been ported into -this release. - -|noindent| Contents of this release: - -#. The |Stratus| netlist capture language (|GenLib| replacement). -#. The |Mauka| placer (still contains bugs). -#. A graphical user interface (viewer only). -#. The |Knik| global router. -#. The |Kite| detailed router. -#. Partially implemented python support for configuration files - (alternative to |XML|). -#. A documentation (imcomplete/obsoleted in |Hurricane|'s case). - - -Release 1.0.2049 -~~~~~~~~~~~~~~~~ - -Release `2049` is Alpha. - -|noindent| Changes of this release: - -#. The |Hurricane| documentation is now accurate. Documentation - for the Cell viewer and |CRLcore| has been added. -#. More extensive Python support for all the components of - |Coriolis|. -#. Configuration is now completly migrated under Python. - |XML| loaders can still be useds for compatibilty. -#. The |cgt| main has been rewritten in Python. - - -Release v2.0.1 -~~~~~~~~~~~~~~ - -#. Migrated the repository from |svn| to |git|, and release complete sources. - As a consequence, we drop the distribution packaging support and give - public read-only access to the repository. -#. Deep rewrite of the |Katabatic| database and |Kite| detailed router, - achieve a speedup factor greater than 20... - - -Release v2.1 -~~~~~~~~~~~~ - -#. Replace the old simulated annealing placer |Mauka| by the analytical placer - |Etesian| and its legalization and detailed placement tools. -#. Added a Blif format parser to process circuits generated by the Yosys and ABC - logic synthetizers. -#. The multiples user defined configuration files are now grouped under - a common hidden (dot) directory ``.coriolis2`` and the file extension - is back from ``.conf`` to ``.py``. - -.. #. Under |RHEL7| / |SL7|, there is a known bug in the graphical visualizer. -.. When shifting to the left, the right-half part of the screen gets -.. badly redrawn. Uses |CTRL_L| to refresh. It will be corrected as soon -.. as possible. - - -**Release v2.2** -~~~~~~~~~~~~~~~~ - -#. Added JSON import/export of the whole Hurricane DataBase. Two save mode - are supported: *Cell* mode (standalone) or *Blob* mode, which dump the - whole design down and including the standard cells. - - -|newpage| - - -Installation -============ - -.. note:: - As the sources are being released, the binary packaging is dropped. - You still may find older version here: http://asim.lip6.fr/pub/coriolis/2.0 . - -In a nutshell, building source consist in pulling the |git| repository then -running the |ccb| installer. - -Main building prerequisites: - -* cmake -* C++11-capable compiler -* RapidJSON_ -* python2.7 -* boost -* libxml2 -* bzip2 -* yacc & lex -* Qt 4 or Qt 5 - -Building documentation prerequisites: - -* doxygen -* latex -* latex2html -* python-docutils (for reStructuredText) - -Optional libraries: - -* LEF/DEF (from `SI2 `_) - -For other distributions, refer to their own packaging system. - -|newpage| - - -Fixed Directory Tree -~~~~~~~~~~~~~~~~~~~~ - -In order to simplificate the work of the |ccb| installer, the source, build -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 -building it (noted :fboxtt:`~/` or :fboxtt:`$HOME/`). Only the source -directory needs to be manually created by the user, all others will be -automatically created either by |ccb| or the build system. - -+--------------------------+-----------------------------------------------------------------------------+ -| **Sources** | -+--------------------------+-----------------------------------------------------------------------------+ -| | Sources root | | ~/coriolis-2.x/src | -| | **under git** | | ~/coriolis-2.x/src/coriolis | -+--------------------------+-----------------------------------------------------------------------------+ -| **Architecture Dependant Build** | -+--------------------------+-----------------------------------------------------------------------------+ -| | Linux, SL 7, 64 bits | | ~/coriolis-2.x/Linux.el7_64/Release.Shared/build/ | -| | Linux, SL 6, 32 bits | | ~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/ | -| | Linux, SL 6, 64 bits | | ~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/ | -| | Linux, Fedora, 64 bits | | ~/coriolis-2.x/Linux.fc_64/Release.Shared/build/ | -| | Linux, Fedora, 32 bits | | ~/coriolis-2.x/Linux.fc/Release.Shared/build/ | -| | FreeBSD 8, 32 bits | | ~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/ | -| | FreeBSD 8, 64 bits | | ~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/ | -| | Windows 7, 32 bits | | ~/coriolis-2.x/Cygwin.W7/Release.Shared/build/ | -| | Windows 7, 64 bits | | ~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/ | -| | Windows 8.x, 32 bits | | ~/coriolis-2.x/Cygwin.W8/Release.Shared/build/ | -| | Windows 8.x, 64 bits | | ~/coriolis-2.x/Cygwin.W8_64/Release.Shared/build/ | -+--------------------------+-----------------------------------------------------------------------------+ -| **Architecture Dependant Install** | -+--------------------------+-----------------------------------------------------------------------------+ -| Linux, SL 6, 32 bits | ~/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// | -| | Configuration files | | .../install/etc/coriolis2/ | -| | Doc, by tool | | .../install/share/doc/coriolis2/en/html/ | -+--------------------------+-----------------------------------------------------------------------------+ - -.. 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. - - ``Static`` do not work because I don't know yet to mix statically linked binaries - and Python modules (which must be dynamic). - -|newpage| - - -Building Coriolis -~~~~~~~~~~~~~~~~~ - -First step is to install the prerequisites. Currently, only RapidJSON_. -As RapidJSON is evolving fast, if you encounter compatibility problems, -the exact version we compiled against is given below. :: - - dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support - dummy@lepka:~$ cd ~/coriolis-2.x/src/support - dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson - dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd - -The second step is to create the source directory and pull the |git| repository: :: - - dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src - dummy@lepka:~$ cd ~/coriolis-2.x/src - dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git - -Third and final step, build & install: :: - - dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ - --project=coriolis \ - --make="-j4 install" - dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ - --project=coriolis \ - --doc --make="-j1 install" - -We need to separate to perform a separate installation of the documentation because it -do not support to be generated with a parallel build. So we compile & install in a first -stage in ``-j4`` (or whatever) then we generate the documentation in ``-j1`` - -Under |RHEL6| or clones, you must build using the |devtoolset2|: :: - - dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ - --devtoolset-2 --make="-j4 install" - -If you want to uses Qt 5 instead of Qt 4, you may add the ``--qt5`` argument. - -The complete list of |ccb| functionalities can be accessed with the ``--help`` argument. -It also may be run in graphical mode (``--gui``). - - -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:~$ git checkout devel - dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ - --make="-j4 install" --debug - - Be aware that it may requires newer versions of the dependencies and may introduce - incompatibilites with the stable version. - - In the (unlikely) event of a crash of |cgt|, as it is a |Python| script, the right - command to run |gdb| on it is: :: - - dummy@lepka:work$ gdb python core.XXXX - -|newpage| - - -Additionnal Requirement under |MacOS| -------------------------------------- - -|Coriolis| make uses of the :cb:`boost::python` module, but the |macports| |boost| -seems unable to work with the |Python| bundled with |MacOS|. So you have to install -both of them from |macports|: :: - - dummy@macos:~$ port install boost +python27 - dummy@macos:~$ port select python python27 - dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks - -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 -~~~~~~~~~~~~~~~~~~ - -Packager should not uses |ccb|, instead ``bootstrap/Makefile.package`` is provided -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. - -Sligthly outaded packaging configuration files can also be found under ``bootstrap/``: - -* ``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. - -This is done by editing the one variable :cb:`cellsTop` in the |Alliance| helper -(see `Alliance Helper`_). This variable must point to the directory of the -cells libraries. In a typical installation, this is generally -:cb:`/usr/share/alliance/cells`. - - -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.** - When used under |RHEL6| or clones, it needs to be run in the |devtoolset2| - 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`"' - - -|newpage| - - -Documentation -============= - -The general index of the documentation for the various parts of Coriolis -are avalaibles here `Coriolis Tools Documentation`_. - -.. note:: **Python Documentation:** - Most of the documentation is related to the C++ API and implemetation of - the tools. However, the |Python| bindings have been created so they - mimic *as closely as possible* the C++ interface, so the documentation - applies to both languages with only minor syntactic changes. - -General Software Architecture -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -|Coriolis| has been build with respect of the classical paradigm that the -computational instensive parts have been written in C++, and almost -everything else in |Python|. To build the |Python| interface we used -two methods: - -* For self-contained modules :cb:`boost::python` (mainly in :cb:`vlsisapd`). -* For all modules based on |Hurricane|, we created our own wrappers due - to very specific requirements such as shared functions between modules - or C++/|Python| secure bi-directional object deletion. - -|CoriolisSoftSchema| - - -Coriolis Configuration & Initialisation -======================================= - -All configuration & initialization files are Python scripts, despite their -|dot_conf| extention. From a syntactic point of view, there is no difference -between the system-wide configuration files and the user's configuration, -they may use the same Python helpers. -|medskip| - -Configuration is done in two stages: - -#. Selecting the symbolic technology. -#. Loading the complete configuration for the given technology. - - -First Stage: Symbolic Technology Selection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -|noindent| -The initialization process is done by executing, in order, the following -file(s): - -+-------+----------------------------------+----------------------------------------------+ -| Order | Meaning | File | -+=======+==================================+==============================================+ -| **1** | The system setting | :cb:`/etc/coriolis2/techno.conf` | -+-------+----------------------------------+----------------------------------------------+ -| **2** | The user's global setting | :cb:`${HOME}/.coriolis2/techno.py` | -+-------+----------------------------------+----------------------------------------------+ -| **3** | The user's local setting | :cb:`/.coriolis2/techno.py` | -+-------+----------------------------------+----------------------------------------------+ - -Thoses files must provides only two variables, the name of the symbolic technology -and the one of the real technology. For example: :: - - # -*- Mode:Python -*- - - symbolicTechno = 'cmos' - realTechno = 'hcmos9' - - -Second Stage: Technology Configuration Loading -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -|noindent| -The :cb:`TECHNO` variable is set by the first stage and it's the name of the -symbolic technology. A directory of that name, with all the configuration files, -must exists in the configuration directory. In addition to the technology-specific -directories, a :cb:`common/` directory is there to provides a trunk for all the -identical datas across the various technologies. The initialization process is done -by executing, in order, the following file(s): - -+-------+----------------------------------+----------------------------------------------+ -| Order | Meaning | File | -+=======+==================================+==============================================+ -| **1** | The system initialization | :cb:`/etc/coriolis2//.conf` | -+-------+----------------------------------+----------------------------------------------+ -| **2** | The user's global initialization | :cb:`${HOME}/.coriolis2/settings.py` | -+-------+----------------------------------+----------------------------------------------+ -| **3** | The user's local initialization | :cb:`/.coriolis2/settings.py` | -+-------+----------------------------------+----------------------------------------------+ - -.. note:: *The loading policy is not hard-coded.* It is implemented - at Python level in :cb:`/etc/coriolis2/coriolisInit.py`, and thus may be easily be - amended to whatever site policy. - - The truly mandatory requirement is the existence of :cb:`coriolisInit.py` - which *must* contain a :cb:`coriolisConfigure()` function with no argument. - - -Configuration Helpers -~~~~~~~~~~~~~~~~~~~~~ - -To ease the writing of configuration files, a set of small helpers -is available. They allow to setup the configuration parameters through -simple assembly of tuples. The helpers are installed under the directory: :: - - /etc/coriolis2/ - -Where :cb:`/` is the root of the installation. - -|newpage| - - -.. _Alliance Helper: - -|Alliance| Helper ------------------ - -The configuration file must provide a :cb:`allianceConfig` tuple of -the form: :: - - cellsTop = '/usr/share/alliance/cells/' - - allianceConfig = \ - ( ( 'SYMBOLIC_TECHNOLOGY', helpers.sysConfDir+'/technology.symbolic.xml' ) - , ( 'REAL_TECHNOLOGY' , helpers.sysConfDir+'/technology.cmos130.s2r.xml') - , ( 'DISPLAY' , helpers.sysConfDir+'/display.xml' ) - , ( 'CATALOG' , 'CATAL') - , ( 'WORKING_LIBRARY' , '.') - , ( 'SYSTEM_LIBRARY' , ( (cellsTop+'sxlib' , Environment.Append) - , (cellsTop+'dp_sxlib', Environment.Append) - , (cellsTop+'ramlib' , Environment.Append) - , (cellsTop+'romlib' , Environment.Append) - , (cellsTop+'rflib' , Environment.Append) - , (cellsTop+'rf2lib' , Environment.Append) - , (cellsTop+'pxlib' , Environment.Append) ) ) - , ( 'SCALE_X' , 100) - , ( 'IN_LO' , 'vst') - , ( 'IN_PH' , 'ap') - , ( 'OUT_LO' , 'vst') - , ( 'OUT_PH' , 'ap') - , ( 'POWER' , 'vdd') - , ( 'GROUND' , 'vss') - , ( 'CLOCK' , '^ck.*') - , ( 'BLOCKAGE' , '^blockageNet*') - ) - - -|noindent| The example above shows the system configuration file, with all the -available settings. Some important remarks about thoses settings: - -* In it's configuration file, the user do not need to redefine all the settings, - just the one he wants to change. In most of the cases, the ``SYSTEM_LIBRARY``, - the ``WORKING_LIBRARY`` and the special net names (at this point there is not - much alternatives for the others settings). - -* ``SYSTEM_LIBRARY`` setting: Setting up the library search path. - Each library entry in the tuple will be added to the search path according - to the second parameter: - - * :cb:`Environment::Append`: append to the search path. - - * :cb:`Environment::Prepend`: insert in head of the search path. - - * :cb:`Environment::Replace`: look for a library of the same name and replace - it, whithout changing the search path order. If no library of that name - already exists, it is appended. - - A library is identified by it's name, this name is the last component of the - path name. For instance: ``/soc/alliance/sxlib`` will be named ``sxlib``. - Implementing the |Alliance| specification, when looking for a |Cell| ``name``, - the system will browse sequentially trought the library list and returns - the first |Cell| whose name match. - -* For ``POWER``, ``GROUND``, ``CLOCK`` and ``BLOCKAGE`` net names, a regular - expression (|GNU| regexp) is expected. - -* The ``helpers.sysConfDir`` variable is supplied by the helpers, it is the - directory in which the system-wide configuration files are locateds. - For a standard installation it would be: ``/soc/coriolis2``. - -.. * Trick and naming convention about ``SYMBOLIC_TECHNOLOGY``, ``REAL_TECHNOLOGY`` -.. and ``DISPLAY``. In the previous releases, thoses files where to read by -.. XML parsers, and still do if you triggers the XML compatibility mode. -.. But now, they have Python conterparts. In the configuration files, you -.. still have to name them as XML files, the Python file name will be -.. deduced from this one with thoses two translation rules: -.. -.. #. In the filename, all dots, except for the last (the file extention), -.. are replaced by underscores. -.. -.. #. The ``.xml`` extention is substituted by a ``.conf``. -.. -.. For the symbolic technology, it would give: :: -.. -.. /soc/coriolis2/technology.symbolic.xml -.. --> /soc/coriolis2/technology_symbolic.conf - -A typical user's configuration file would be: :: - - import os - - homeDir = os.getenv('HOME') - - allianceConfig = \ - ( ('WORKING_LIBRARY' , homeDir+'/worklib') - , ('SYSTEM_LIBRARY' , ( (homeDir+'/mylib', Environment.Append) ) ) - , ('POWER' , 'vdd.*') - , ('GROUND' , 'vss.*') - ) - - -Tools Configuration Helpers ---------------------------- - -All the tools uses the same helper to load their configuration (a.k.a. -*Configuration Helper*). Currently the following configuration system-wide -configuration files are defined: - -* :cb:`misc.conf`: commons settings or not belonging specifically to a tool. -* :cb:`etesian.conf`: for the |Etesian| tool. -* :cb:`kite.conf`: for the |Kite| tool. -* :cb:`stratus1.conf`: for the |stratus1| tool. - -Here is the contents of :cb:`etesian.conf`: :: - - # Etesian parameters. - parametersTable = \ - ( ('etesian.aspectRatio' , TypePercentage, 100 , { 'min':10, 'max':1000 } ) - , ('etesian.spaceMargin' , TypePercentage, 5 ) - , ('etesian.uniformDensity' , TypeBool , False ) - , ('etesian.routingDriven' , TypeBool , False ) - , ("etesian.effort" , TypeEnumerate , 2 - , { 'values':( ("Fast" , 1) - , ("Standard", 2) - , ("High" , 3) - , ("Extreme" , 4) ) } - ) - , ("etesian.graphics" , TypeEnumerate , 2 - , { 'values':( ("Show every step" , 1) - , ("Show lower bound" , 2) - , ("Show result only" , 3) ) } - ) - ) - - layoutTable = \ - ( (TypeTab , 'Etesian', 'etesian') - - , (TypeTitle , 'Placement area') - , (TypeOption, "etesian.aspectRatio" , "Aspect Ratio, X/Y (%)", 0 ) - , (TypeOption, "etesian.spaceMargin" , "Space Margin" , 1 ) - , (TypeRule ,) - , (TypeTitle , 'Etesian - Placer') - , (TypeOption, "etesian.uniformDensity", "Uniform density" , 0 ) - , (TypeOption, "etesian.routingDriven" , "Routing driven" , 0 ) - , (TypeOption, "etesian.effort" , "Placement effort" , 1 ) - , (TypeOption, "etesian.graphics" , "Placement view" , 1 ) - , (TypeRule ,) - ) - -Taxonomy of the file: - -* It must contains, at least, the two tables: - - * ``parametersTable``, defines & initialise the configuration variables. - - * ``layoutTables``, defines how the various parameters will be displayed - in the configuration window (`The Settings Tab`_). - -* The ``parametersTable``, is a tuple (list) of tuples. Each entry in the list - describe a configuration parameter. In it's simplest form, it's a quadruplet - :cb:`(TypeOption, 'paramId', ParameterType, DefaultValue)` with: - - #. ``TypeOption``, tells that this tuple describe a parameter. - - #. ``paramId``, the identifier of the parameter. Identifiers are defined - by the tools. The list of parameters is detailed in each tool section. - - #. ``ParameterType``, the kind of parameter. Could be: - - * ``TypeBool``, boolean. - * ``TypeInt``, signed integer. - * ``TypeEnumerate``, enumerated type, needs extra entry. - * ``TypePercentage``, percentage, expressed between 0 and 100. - * ``TypeDouble``, float. - * ``TypeString``, character string. - - #. ``DefaultValue``, the default value for that parameter. - - -Hacking the Configuration Files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Asides from the symbols that gets used by the configuration helpers like -:cb:`allianceConfig` or :cb:`parametersTable`, you can put pretty much anything -in :cb:`/.coriolis2/settings.py` (that is, written in |Python|). - -For example: :: - - # -*- Mode:Python -*- - - defaultStyle = 'Alliance.Classic [black]' - - # Regular Coriolis configuration. - parametersTable = \ - ( ('misc.catchCore' , TypeBool , False ) - , ('misc.info' , TypeBool , False ) - , ('misc.paranoid' , TypeBool , False ) - , ('misc.bug' , TypeBool , False ) - , ('misc.logMode' , TypeBool , True ) - , ('misc.verboseLevel1' , TypeBool , False ) - , ('misc.verboseLevel2' , TypeBool , True ) - , ('misc.minTraceLevel' , TypeInt , 0 ) - , ('misc.maxTraceLevel' , TypeInt , 0 ) - ) - - # Some ordinary Python script... - import os - - print ' o Cleaning up ClockTree previous run.' - for fileName in os.listdir('.'): - if fileName.endswith('.ap') or (fileName.find('_clocked.') >= 0): - print ' - <%s>' % fileName - os.unlink(fileName) - - -See `Python Interface to Coriolis`_ for more details those capabilities. - - -CGT - The Graphical Interface -============================= - -The |Coriolis| graphical interface is split up into two windows. - -* The **Viewer**, with the following features: - - * Basic load/save capabilities. - * Display the current working cell. Could be empty if the design - is not yet placed. - * Execute Stratus Scripts. - * Menu to run the tools (placement, routage). - -Features are detailed in `Viewer & Tools`_. - -|ViewerSnapShot_1| - -* The **Controller**, which allows: - - * Tweak what is displayer by the *Viewer*. Through the *Look*, - *Filter* and *Layers&Gos* tabs. - * Browse the |netlist| with eponym tab. - * Show the list of selected objects (if any) with *selection* - * Walk through the Database, the Cell or the Selection with *Inspector*. - This is an advanced feature, reserved for experimented users. - * The tab *Settings* which give access to all the settings. - They are closely related to Configuration & Initialisation. - -|ControllerSnapShot_1| - - -.. _Viewer & Tools: - -Viewer & Tools -============== - -|Stratus| Netlist Capture -~~~~~~~~~~~~~~~~~~~~~~~~~ - -|Stratus| is the replacement for |GenLib| procedural netlist capture language. -It is designed as a set of |Python| classes, and comes with it's own documentation -(`Stratus Documentation`_) - - -The |Hurricane| Data-Base -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The |Alliance| flow is based on the |MBK| data-base, which has one data-structure -for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical* -view. The place and route tools were responsible for maintaining (or not) the -coherency between views. Reflecting this weak coupling between views, each one -was stored in a separate file with a specific format. The *logical* view is stored -in a |vst| file in |VHDL| format and the *physical* in an |ap| file in an ad-hoc format. - -The |Coriolis| flow is based on the |Hurricane| data-base, which has a unified -structure for *logical* and *physical* view. That data structure is the |Cell| object. -The |Cell| can have any state between pure netlist and completly placed and -routed design. Although the memory representation of the views has deeply -changed we still use the |Alliance| files format, but they now really represent -views of the same object. The point is that one must be very careful about -view coherency when going to and from |Coriolis|. - -As for the second release, |Coriolis| can be used only for three purposes : - -* **Placing a design**, in which case the |netlist| view must be present. -* **Routing a design**, in that case the |netlist| - view and the |layout| view must be present and |layout| view must contain - a placement. Both views must have the same name. When saving the routed design, - it is advised to change the design name otherwise the original unrouted placement - in the |layout| view will be overwritten. -* **Viewing a design**, the |netlist| view must be present, if a |layout| - view is present it still must have the same name but it can be in any - state. - - -Synthetizing and loading a design -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -|Coriolis| supports several file formats. It can load all file format -from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), -BLIF netlist format as well as benchmark formats from the ISPD contests. - -It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license -and may not be compiled in your version of the software. - -Synthesis under Yosys ---------------------- - -You can create a BLIF file from the |Yosys| synthetizer, which can be imported under Coriolis. -Most libraries are specified as a .lib liberty file and a .lef LEF file. -|Yosys| opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2. -If Coriolis hasn't been compiled against it, the library is given in |Alliance| .ap format. -`Some free libraries `_ already provide both .ap and .lib files. - -Once you have installed a common library under |Yosys| and Coriolis, just synthetize your design -with |Yosys| and import it (as Blif without the extension) under Coriolis to perform place&route. - -Synthesis under Alliance ------------------------- - -|Alliance| is an older toolchain but has been extensively used for years. Coriolis can import -and write Alliance designs and libraries directly. - -Etesian -- Placer -~~~~~~~~~~~~~~~~~ - -The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is -within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace. -This |Coriolis| tool is actually an encapsulation of |Coloquinte| which *is* the placer. - -.. note:: *Instance Uniquification Unsupported:* a same logical instance cannot have - two different placements. So, either you manually make a clone of it or you - supply a placement for it. We need to implement uniquification in the - |Hurricane| database. - - -|noindent| -**Hierarchical Placement** - -The placement area is defined by the top cell abutment box. - -When placing a complete hierarchy, the abutment boxes of the cells (models) other than -the top cell are sets identical to the one of the top cell and their instances are -all placed at position ``(0,0,ID)``. That is, all the abutments boxes, whatever the -hierarchical level, defines the same area (they are exactly superposed). - -We choose this scheme because the placer will see all the instances as virtually -flattened, so they can be placed anywhere inside the top-cell abutment box. - -|Etesian-1| - - -|noindent| -**Computing the Placement Area** - -The placement area is computed using the ``etesian.aspectRatio`` and ``etesian.spaceMargin`` -parameters only if the top-cell has an empty abutment box. If the top-cell abutment -box has to be set, then it is propagated to all the instances models recursively. - - -|noindent| -**Reseting the Placement** - -Once a placement has been done, the placer cannot reset it (will be implemented -later). To perform a new placement, you must restart |cgt|. In addition, if you -have saved the placement on disk, you must erase any :cb:`.ap` file, which are -automatically reloaded along with the netlist (:cb:`.vst`). - -|noindent| -**Limitations** - -Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version, -it doesn't support movable macros, and you must place every macro beforehand. -Timing and routability analysis are not included either, and the returned placement -may be unroutable. - -|newpage| - - -Etesian Configuration Parameters --------------------------------- - -+-----------------------------------+------------------+----------------------------+ -| Parameter Identifier | Type | Default | -+===================================+==================+============================+ -| **Etesian Parameters** | -+-----------------------------------+------------------+----------------------------+ -|``etesian.aspectRatio`` | TypePercentage | :cb:`100` | -| +------------------+----------------------------+ -| | Define the height on width ``H/W`` aspect | -| | ratio, can be comprised between 10 and 1000 | -+-----------------------------------+------------------+----------------------------+ -|``etesian.spaceMargin`` | TypePercentage | :cb:`5` | -| +------------------+----------------------------+ -| | The extra white space added to the total area | -| | of the standard cells | -+-----------------------------------+------------------+----------------------------+ -|``etesian.uniformDensity`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | Whether the cells will be spread envenly | -| | across the area or allowed to form denser | -| | clusters | -+-----------------------------------+------------------+----------------------------+ -|``etesian.effort`` | TypeInt | :cb:`2` | -| +------------------+----------------------------+ -| | Sets the balance between the speed of the | -| | placer and the solution quality | -+-----------------------------------+------------------+----------------------------+ -|``etesian.routingDriven`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | Whether the tool will try routing iterations | -| | and whitespace allocation to improve | -| | routability; to be implemented | -+-----------------------------------+------------------+----------------------------+ -|``etesian.graphics`` | TypeInt | :cb:`2` | -| +------------------+----------------------------+ -| | How often the display will be refreshed | -| | More refreshing slows the placer. | -| | | -| | * ``1`` shows both upper and lower bounds | -| | * ``2`` only shows lower bound results | -| | * ``3`` only shows the final results | -+-----------------------------------+-----------------------------------------------+ - - -Knik -- Global Router -~~~~~~~~~~~~~~~~~~~~~ - -The quality of |Knik| global routing solutions are equivalent to those of FGR_ 1.0. -For an in-depth description of |Knik| algorithms, you may download the thesis of -D. |Dupuis| avalaible from here~: `Knik Thesis`_. - -The global router is (not yet) deterministic. To circumvent this limitation, -a global routing *solution* can be saved to disk and reloaded for later uses. - -A global routing is saved into a file with the same name as the design and a -|kgr| extention. It is in `Box Router`_ output format. - -|noindent| Menus: - -* |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteSaveGlobalRouting|. -* |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteLoadGlobalRouting|. - - -Kite -- Detailed Router -~~~~~~~~~~~~~~~~~~~~~~~ - -|Kite| no longer suffers from the limitations of |Nero|. It can route big designs -as its runtime and memory footprint is almost linear (with respect to the number -of gates). It has successfully routed design of more than `150K` gates. -|medskip| - -|noindent| However, this first release comes with the temporary the following -restrictions: - -* Works only with |SxLib| standard cell gauge. -* Works always with 4 routing metal layers (`M2` through `M5`). -* Do not allow (take into account) pre-routed wires on signals - other than |POWER| or |GROUND|. - -.. note:: - **Slow Layer Assignment.** Most of the time, the layer assignment stage is - fast (less than a dozen seconds), but in some instances it can take more - than a dozen *minutes*. This is a known bug and will be corrected in later - releases. - -After each run, |Kite| displays a set of *completion ratios* which must all -be equal to `100%` if the detailed routing has been successfull. -In the event of a failure, on a saturated design, you may decrease the -`edge saturation ratio` (argument `--edge`) to balance more evenly the design -saturation. That is, the maximum saturation decrease at the price of a wider -saturated area and increased wirelength. This is the saturation of the -*global* router |Knik|, and you may increase/decrease by steps of ``5%``, -which represent one track. The maximum capacity of the |SxLib| gauge is -10 tracks in two layers, that makes 20 tracks by |Knik| edge. - -Routing a design is done in four ordered steps: - -#. Detailed pre-route |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteDetailedPreRoute|. -#. Global routing |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteGlobalRoute|. -#. Detailed routing |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteDetailedRoute|. -#. Finalize routing |menu_P&R| |rightarrow| |menu_StepByStep| |rightarrow| |menu_KiteFinalizeRoute|. - -It is possible to supply to the router a complete wiring for some nets that the user's -wants to be routed according to a specific topology. The supplied topology must respect -the building rules of the |Katabatic| database (contacts must be, terminals, turns, h-tee -& v-tee only). During the first step :fboxtt:`Detailed Pre-Route` the router will solve -overlaps between the segments, without making any dogleg. If no pre-routed topologies -are present, this step may be ommited. Any net routed at this step is then fixed and -become unmovable for the later stages. - -After the detailed routing step the |Kite| data-structure is still active -(the Hurricane wiring is decorated). The finalize step performs the removal of -the |Kite| data-structure, and it is not advisable to save the design before -that step. - -You may visualize the density (saturation) of either |Knik| (on edges) or -|Kite| (on GCells) until the routing is finalized. Special layers appears -to that effect in the `The Layers&Go Tab`_. - - -Kite Configuration Parameters ------------------------------ - -As |Knik| is only called through |Kite|, it's parameters also have -the :cb:`kite.` prefix. - -The |Katabatic| parameters control the layer assignment step. - -All the defaults value given below are from the default |Alliance| technology -(:cb:`cmos` and :cb:`SxLib` cell gauge/routing gauge). - -+-----------------------------------+------------------+----------------------------+ -| Parameter Identifier | Type | Default | -+===================================+==================+============================+ -| **Katabatic Parameters** | -+-----------------------------------+------------------+----------------------------+ -|``katabatic.topRoutingLayer`` | TypeString | :cb:`METAL5` | -| +------------------+----------------------------+ -| | Define the highest metal layer that will be | -| | used for routing (inclusive). | -+-----------------------------------+------------------+----------------------------+ -|``katabatic.globalLengthThreshold``| TypeInt | :cb:`1450` | -| +------------------+----------------------------+ -| | This parameter is used by a layer assignment | -| | method which is no longer used (did not give | -| | good results) | -+-----------------------------------+------------------+----------------------------+ -| ``katabatic.saturateRatio`` | TypePercentage | :cb:`80` | -| +------------------+----------------------------+ -| | If ``M(x)`` density is above this ratio, | -| | move up feedthru global segments up from | -| | depth ``x`` to ``x+2`` | -+-----------------------------------+------------------+----------------------------+ -| ``katabatic.saturateRp`` | TypeInt | :cb:`8` | -| +------------------+----------------------------+ -| | If a GCell contains more terminals | -| | (:cb:`RoutingPad`) than that number, force a | -| | move up of the connecting segments to those | -| | in excess | -+-----------------------------------+------------------+----------------------------+ -| **Knik Parameters** | -+-----------------------------------+------------------+----------------------------+ -| ``kite.hTracksReservedLocal`` | TypeInt | :cb:`3` | -| +------------------+----------------------------+ -| | To take account the tracks needed *inside* a | -| | GCell to build the *local* routing, decrease | -| | the capacity of the edges of the global | -| | router. Horizontal and vertical locally | -| | reserved capacity can be distinguished for | -| | more accuracy. | -+-----------------------------------+------------------+----------------------------+ -| ``kite.vTracksReservedLocal`` | TypeInt | :cb:`3` | -| +------------------+----------------------------+ -| | cf. ``kite.hTracksReservedLocal`` | -+-----------------------------------+------------------+----------------------------+ -| **Kite Parameters** | -+-----------------------------------+------------------+----------------------------+ -| ``kite.eventsLimit`` | TypeInt | :cb:`4000002` | -| +------------------+----------------------------+ -| | The maximum number of segment displacements, | -| | this is a last ditch safety against infinite | -| | loop. It's perhaps a little too low for big | -| | designs | -+-----------------------------------+------------------+----------------------------+ -| ``kite.ripupCost`` | TypeInt | :cb:`3` | -| +------------------+----------------------------+ -| | Differential introduced between two ripup | -| | cost to avoid a loop between two ripped up | -| | segments | -+-----------------------------------+------------------+----------------------------+ -| ``kite.strapRipupLimit`` | TypeInt | :cb:`16` | -| +------------------+----------------------------+ -| | Maximum number of ripup for *strap* segments | -+-----------------------------------+------------------+----------------------------+ -| ``kite.localRipupLimit`` | TypeInt | :cb:`9` | -| +------------------+----------------------------+ -| | Maximum number of ripup for *local* segments | -+-----------------------------------+------------------+----------------------------+ -| ``kite.globalRipupLimit`` | TypeInt | :cb:`5` | -| +------------------+----------------------------+ -| | Maximum number of ripup for *global* segments,| -| | when this limit is reached, triggers topologic| -| | modification | -+-----------------------------------+------------------+----------------------------+ -| ``kite.longGlobalRipupLimit`` | TypeInt | :cb:`5` | -| +------------------+----------------------------+ -| | Maximum number of ripup for *long global* | -| | segments, when this limit is reached, triggers| -| | topological modification | -+-----------------------------------+------------------+----------------------------+ - - - -.. _Python Scripts in Cgt: - -Executing Python Scripts in Cgt -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Python/Stratus scripts can be executed either in text or graphical mode. - -.. note:: **How Cgt Locates Python Scripts:** - |cgt| uses the Python ``import`` mechanism to load Python scripts. - So you must give the name of your script whitout ``.py`` extention and - it must be reachable through the ``PYTHONPATH``. You may uses the - dotted module notation. - -A Python/Stratus script must contains a function called ``ScriptMain()`` -with one optional argument, the graphical editor into which it may be -running (will be set to ``None`` in text mode). The Python interface to -the editor (type: :cb:`CellViewer`) is limited to basic capabilities -only. - -Any script given on the command line will be run immediatly *after* the -initializations and *before* any other argument is processed. - -For more explanation on Python scripts see `Python Interface to Coriolis`_. - - -Printing & Snapshots -~~~~~~~~~~~~~~~~~~~~ - -Printing or saving into a |pdf| is fairly simple, just uses the **File -> Print** -menu or the |CTRL_P| shortcut to open the dialog box. - -The print functionality uses exactly the same rendering mechanism as for the -screen, beeing almost *WYSIWYG*. Thus, to obtain the best results it is advisable -to select the ``Coriolis.Printer`` look (in the *Controller*), which uses a -white background and much suited for high resolutions ``32x32`` pixels patterns - -There is also two mode of printing selectable through the *Controller* -**Settings -> Misc -> Printer/Snapshot Mode**: - -=============== ================= ===================================================== -Mode DPI (approx.) Intended Usage ---------------- ----------------- ----------------------------------------------------- -**Cell Mode** 150 For single ``Cell`` printing or very small designs. - Patterns will be bigger and more readable. -**Design Mode** 300 For designs (mostly commposed of wires and cells - outlines). -=============== ================= ===================================================== - -.. note:: *The pdf file size* - Be aware that the generated |pdf| files are indeed only pixmaps. - So they can grew very large if you select paper format above ``A2`` - or similar. - - -|noindent| -Saving into an image is subject to the same remarks as for |pdf|. - - -Memento of Shortcuts in Graphic Mode -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The main application binary is |cgt|. - -+---------------+-------------------+-----------------------------------------------------------+ -| Category | Keys | Action | -+===============+===================+===========================================================+ -| **Moves** | | |KeyUp|, | Shift the view in the according direction | -| | |KeyDown| | | -| | | |KeyLeft|, | | -| | |KeyRight| | | -+---------------+-------------------+-----------------------------------------------------------+ -| **Fit** | |KeyF| | Fit to the Cell abutment box | -+---------------+-------------------+-----------------------------------------------------------+ -| **Refresh** | |CTRL_L| | Triggers a complete display redraw | -+---------------+-------------------+-----------------------------------------------------------+ -| **Goto** | |KeyG| | *apperture* is the minimum side of the area | -| | | displayed around the point to go to. It's an | -| | | alternative way of setting the zoom level | -+---------------+-------------------+-----------------------------------------------------------+ -| **Zoom** | |KeyZ|, | Respectively zoom by a 2 factor and *unzoom* | -| | |KeyM| | by a 2 factor | -| +-------------------+-----------------------------------------------------------+ -| | | |BigMouse| | You can perform a zoom to an area. | -| | | Area Zoom | Define the zoom area by *holding down the left | -| | | mouse button* while moving the mouse. | -+---------------+-------------------+-----------------------------------------------------------+ -| **Selection** | | |BigMouse| | You can select displayed objects under an area. | -| | | Area Selection | Define the selection area by *holding down the | -| | | right mouse button* while moving the mouse. | -| +-------------------+-----------------------------------------------------------+ -| | | |BigMouse| | You can toggle the selection of one object under | -| | | Toggle Selection| the mouse position by pressing |CTRL| and | -| | | pressing down *the right mouse button*. A popup | -| | | list of what's under the position shows up into | -| | | which you can toggle the selection state of one | -| | | item. | -| +-------------------+-----------------------------------------------------------+ -| | |KeyCapS| | Toggle the selection visibility | -+---------------+-------------------+-----------------------------------------------------------+ -| **Controller**| |CTRL_I| | Show/hide the controller window. | -| | | | -| | | It's the Swiss Army Knife of the viewer. | -| | | From it, you can fine-control the display and | -| | | inspect almost everything in your design. | -+---------------+-------------------+-----------------------------------------------------------+ -| **Rulers** | |KeyK|, | One stroke on |KeyK| enters the ruler mode, in | -| | |KeyESC| | which you can draw one ruler. You can exit the | -| | | ruler mode by pressing |KeyESC|. Once in ruler | -| | | mode, the first click on the *left mouse button* | -| | | sets the ruler's starting point and the second | -| | | click the ruler's end point. The second click | -| | | exits automatically the ruler mode. | -| +-------------------+-----------------------------------------------------------+ -| | |KeyCapK| | Clears all the drawn rulers | -+---------------+-------------------+-----------------------------------------------------------+ -| **Print** | |CTRL_P| | Currently rather crude. It's a direct copy of | -| | | what's displayed in pixels. So the resulting | -| | | picture will be a little blurred due to | -| | | anti-aliasing mechanism. | -+---------------+-------------------+-----------------------------------------------------------+ -| **Open/Close**| |CTRL_O| | Opens a new design. The design name must be | -| | | given without path or extention. | -| +-------------------+-----------------------------------------------------------+ -| | |CTRL_W| | Close the current viewer window, but do not quit | -| | | the application. | -| +-------------------+-----------------------------------------------------------+ -| | |CTRL_Q| | `CTRL+Q` quit the application | -| | | (closing all windows). | -+---------------+-------------------+-----------------------------------------------------------+ -| **Hierarchy** | |CTRL_Down| | Go one hierarchy level down. That is, if there | -| | | is an *instance* under the cursor position, load | -| | | it's *model* Cell in place of the current one. | -| +-------------------+-----------------------------------------------------------+ -| | |CTRL_Up| | Go one hierarchy level up. if we have entered | -| | | the current model through |CTRL_Down| | -| | | reload the previous model (the one | -| | | in which this model is instanciated). | -+---------------+-------------------+-----------------------------------------------------------+ - - -Cgt Command Line Options -~~~~~~~~~~~~~~~~~~~~~~~~ - -Appart from the obvious ``--text`` options, all can be used for text and graphical mode. - -+-----------------------------+------------------------------------------------+ -| Arguments | Meaning | -+=============================+================================================+ -| `-t|--text` | Instruct |cgt| to run in text mode. | -+-----------------------------+------------------------------------------------+ -| `-L|--log-mode` | Disable the uses of |ANSI| escape sequence on | -| | the |tty|. Useful when the output is | -| | redirected to a file. | -+-----------------------------+------------------------------------------------+ -| `-c |--cell=` | The name of the design to load, without | -| | leading path or extention. | -+-----------------------------+------------------------------------------------+ -| `-g|--load-global` | Reload a global routing solution from disk. | -| | The file containing the solution must be named | -| | `.kgr`. | -+-----------------------------+------------------------------------------------+ -| `--save-global` | Save the global routing solution, into a file | -| | named `.kgr`. | -+-----------------------------+------------------------------------------------+ -| `-e |--edge=` | Change the edge capacity for the global | -| | router, between 0 and 1 (|Knik|). | -+-----------------------------+------------------------------------------------+ -| `-G|--global-route` | Run the global router (|Knik|). | -+-----------------------------+------------------------------------------------+ -| `-R|--detailed-route` | Run the detailed router (|Kite|). | -+-----------------------------+------------------------------------------------+ -| `-s|--save-design=` | The design into which the routed layout will | -| | be saved. It is strongly recommanded to choose | -| | a different name from the source (unrouted) | -| | design. | -+-----------------------------+------------------------------------------------+ -| `--events-limit=` | The maximal number of events after which the | -| | router will stops. This is mainly a failsafe | -| | against looping. The limit is sets to 4 | -| | millions of iteration which should suffice to | -| | any design of `100K`. gates. For bigger | -| | designs you may wants to increase this limit. | -+-----------------------------+------------------------------------------------+ -| `--stratus-script=` | Run the Python/Stratus script ``module``. | -| | See `Python Scripts in Cgt`_. | -+-----------------------------+------------------------------------------------+ - - -Some Examples : - -* Run both global and detailed router, then save the routed design : :: - - > cgt -v -t -G -R --cell=design --save-design=design_kite - -* Load a previous global solution, run the detailed router, then save the - routed design : :: - - > cgt -v -t --load-global -R --cell=design --save-design=design_kite - -* Run the global router, then save the global routing solution : :: - - > cgt -v -t -G --save-global --cell=design - - -Miscellaneous Settings -~~~~~~~~~~~~~~~~~~~~~~ - -+---------------------------------------+------------------+----------------------------+ -| Parameter Identifier | Type | Default | -+=======================================+==================+============================+ -| **Verbosity/Log Parameters** | -+---------------------------------------+------------------+----------------------------+ -| ``misc.info`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | Enable display of *info* level message | -| | (:cb:`cinfo` stream) | -+---------------------------------------+------------------+----------------------------+ -| ``misc.bug`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | Enable display of *bug* level message | -| | (:cb:`cbug` stream), messages can be a little | -| | scarry | -+---------------------------------------+------------------+----------------------------+ -| ``misc.logMode`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | If enabled, assume that the output device | -| | is not a ``tty`` and suppress any escaped | -| | sequences | -+---------------------------------------+------------------+----------------------------+ -| ``misc.verboseLevel1`` | TypeBool | :cb:`True` | -| +------------------+----------------------------+ -| | First level of verbosity, disable level 2 | -+---------------------------------------+------------------+----------------------------+ -| ``misc.verboseLevel2`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | Second level of verbosity | -+---------------------------------------+------------------+----------------------------+ -| **Development/Debug Parameters** | -+---------------------------------------+------------------+----------------------------+ -| ``misc.minTraceLevel`` | TypeInt | :cb:`0` | -+---------------------------------------+------------------+----------------------------+ -| ``misc.maxTraceLevel`` | TypeInt | :cb:`0` | -| +------------------+----------------------------+ -| | Display trace information *between* those two | -| | levels (:cb:`cdebug` stream) | -+---------------------------------------+------------------+----------------------------+ -| ``misc.catchCore`` | TypeBool | :cb:`False` | -| +------------------+----------------------------+ -| | By default, |cgt| do not dump core. | -| | To generate one set this flag to :cb:`True` | -+---------------------------------------+------------------+----------------------------+ - -|newpage| - - -.. _The Controller: - -The Controller -============== - -The *Controller* window is composed of seven tabs: - -#. `The Look Tab`_ to select the display style. -#. `The Filter Tab`_ the hierarchical levels to be displayed, the look of - rubbers and the dimension units. -#. `The Layers&Go Tab`_ to selectively hide/display layers. -#. `The Netlist Tab`_ to browse through the |netlist|. Works in association - with the *Selection* tab. -#. `The Selection Tab`_ allow to view all the currently selected elements. -#. `The Inspector Tab`_ browse through either the DataBase, the Cell or - the current selection. -#. `The Settings Tab`_ access all the tool's configuration settings. - - -.. _The Look Tab: - -The Look Tab -~~~~~~~~~~~~ - -You can select how the layout will be displayed. There is a special one -``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_. -You should select it prior to calling the print or snapshot dialog boxes. - -|ControllerLook_1| - - -.. _The Filter Tab: - -The Filter Tab -~~~~~~~~~~~~~~ - -The filter tab let you select what hierarchical levels of your design will be -displayed. Hierarchy level are numbered top-down: the level 0 correspond to -the top-level cell, the level one to the instances of the top-level Cell and -so on. - -There are also check boxes to enable/disable the processing of Terminal Cell, -Master Cells and Compnents. The processing of Terminal Cell (hierarchy leaf -cells) is disabled by default when you load a hierarchical design and enabled -when you load a single Cell. - -You can choose what kind of form to give to the rubbers and the type of -unit used to display coordinates. - -.. note:: *What are Rubbers:* |Hurricane| uses *Rubbers* to materialize - physical gaps in net topology. That is, if some wires are missing to - connect two or more parts of net, a *rubber* will be drawn between them - to signal the gap. - - For example, after the detailed routing no *rubbers* should remains. - They have been made *very* visibles as big violet lines... - -|ControllerFilter_1| - - -.. _The Layers&Go Tab: - -The Layers&Go Tab -~~~~~~~~~~~~~~~~~ - -Control the individual display of all *layers* and *Gos*. - -* *Layers* correspond to a true physical layer. From a |Hurricane| point of - view they are all the *BasicLayers* (could be matched to GDSII). -* *Gos* stands from *Graphical Objects*, they are drawings that have no - physical existence but are added by the various tools to display extra - information. One good exemple is the density map of the detailed router, - to easily locate congested areas. - -For each layer/Go there are two check boxes: - -* The normal one triggers the display. -* The red-outlined allows objects of that layer to be selectable or not. - -|ControllerLayersGos_1| - - -.. _The Netlist Tab: - -The Netlist Tab -~~~~~~~~~~~~~~~ - -The *Netlist* tab shows the list of nets... By default the tab is not -*synched* with the displayed Cell. To see the nets you must check the -**Sync Netlist** checkbox. You can narrow the set of displayed nets by -using the filter pattern (supports regular expressions). - -An very useful feature is to enable the **Sync Selection**, which will -automatically select all the components of the selected net(s). You can -select multiple nets. In the figure the net ``auxsc35`` is selected and -is highlited in the *Viewer*. - -|ControllerNetlist_1| -|ViewerNetlist_1| - - -.. _The Selection Tab: - -The Selection Tab -~~~~~~~~~~~~~~~~~ - -The *Selection* tab list all the components currently selecteds. They -can be filtered thanks to the filter pattern. - -Used in conjunction with the *Netlist* **Sync Selection** you will all see -all the components part of *net*. - -In this list, you can toggle individually the selection of component by -pressing the ``t`` key. When unselected in this way a component is not -removed from the the selection list but instead displayed in red italic. -To see where a component is you may make it blink by repeatedly press -the ``t`` key... - -|ControllerSelection_1| - - -.. _The Inspector Tab: - -The Inspector Tab -~~~~~~~~~~~~~~~~~ - -This tab is very useful, but mostly for |Coriolis| developpers. It allows -to browse through the live DataBase. The *Inspector* provide three entry points: - -* **DataBase**: Starts from the whole |Hurricane| DataBase. -* **Cell**: Inspect the currently loaded Cell. -* **Selection**: Inspect the object currently highlited in the *Selection* tab. - -Once an entry point has been activated, you may recursively expore all -it's fields using the right/left arrows. - -.. note:: *Do not put your fingers in the socket:* when inspecting - anything, do not modify the DataBase. If any object under inspection - is deleted, you will crash the application... - -.. note:: *Implementation Detail:* the inspector support is done with - ``Slot``, ``Record`` and ``getString()``. - -|ControllerInspector_1| -|ControllerInspector_2| -|ControllerInspector_3| - - -.. _The Settings Tab: - -The Settings Tab -~~~~~~~~~~~~~~~~ - -Here comes the description of the *Settings* tab. - -|ControllerSettings_1| - - -.. _Python Interface to Coriolis: - -Python Interface for |Hurricane| / |Coriolis| -============================================= - -The (almost) complete interface of |Hurricane| is exported as a |Python| module -and some part of the other components of |Coriolis| (each one in a separate -module). The interface has been made to mirror as closely as possible the -C++ one, so the C++ doxygen documentation could be used to write code with -either languages. - -`Summary of the C++ Documentation `_ - -A script could be run directly in text mode from the command line or through -the graphical interface (see `Python Scripts in Cgt`_). - -Asides for this requirement, the python script can contain anything valid -in |Python|, so don't hesitate to use any package or extention. - -Small example of Python/Stratus script: :: - - from Hurricane import * - from Stratus import * - - def doSomething (): - # ... - return - - def ScriptMain ( **kw ): - editor = None - if kw.has_key('editor') and kw['editor']: - editor = kw['editor'] - stratus.setEditor( editor ) - - doSomething() - return - - if __name__ == "__main__" : - kw = {} - success = ScriptMain( **kw ) - shellSuccess = 0 - if not success: shellSuccess = 1 - - sys.exit( shellSuccess ) - ScriptMain () - -This typical script can be executed in two ways: - -#. Run directly as a |Python| script, thanks to the :: - - if __name__ == "__main__" : - - part (this is standart |Python|). It is a simple adapter that will - calls :cb:`ScriptMain()`. -#. Through |cgt|, either in text or graphical mode. In that case, the - :cb:`ScriptMain()` is directly called trough a sub-interpreter. - The arguments of the script are passed through the ``**kw`` dictionnary. - - +----------------------+-----------------------------------------------+ - | \*\*kw Dictionnary | - +----------------------+-----------------------------------------------+ - | Parameter Key/Name | Contents type | - +======================+===============================================+ - | ``'cell'`` | A Hurricane cell on which to work. Depending | - | | on the context, it may be ``None``. | - | | For example, when run from |cgt|, it the cell | - | | currently loaded in the viewer, if any. | - +----------------------+-----------------------------------------------+ - | ``'editor'`` | The viewer from which the script is run, when | - | | lauched through |cgt|. | - +----------------------+-----------------------------------------------+ - - -Plugins -======= - -Plugins are |Python| scripts specially crafted to integrate with |cgt|. -Their entry point is a :cb:`ScriptMain()` method as described in -`Python Interface to Coriolis`_. They can be called by user scripts -through this method. - - - -Chip Placement -~~~~~~~~~~~~~~ - -Automatically perform the placement of a complete chip. This plugin, as well -as the other P&R tools expect a specific top-level hierarchy for the design. -The top-level hierarchy must contains the instances of all the I/O pads and -**exactly one** instance of the chip's core model. - -|ChipStructure-1| - -The designer must provide a configuration file that define the rules for the -placement of the top-level hierarchy (that is, the pads and the core). -This file must be named after the chip's name, by appending ``_chip.py`` -(obviously, it is a |Python| file). For instance if the chip netlist file -is called ``amd2901_crl.vst``, then the configuration file must be named -``amd2901_crl_chip.vst``. - -Example of chip placement configuration file (for ``AM2901``): :: - - chip = \ - { 'pads.south' : [ 'p_a3' , 'p_a2' , 'p_a1' , 'p_r0' - , 'p_vddick0', 'p_vssick0', 'p_a0' , 'p_i6' - , 'p_i8' , 'p_i7' , 'p_r3' ] - , 'pads.east' : [ 'p_zero' , 'p_i0' , 'p_i1' , 'p_i2' - , 'p_vddeck0', 'p_vsseck0', 'p_q3' , 'p_b0' - , 'p_b1' , 'p_b2' , 'p_b3' ] - , 'pads.north' : [ 'p_noe' , 'p_y3' , 'p_y2' , 'p_y1' - , 'p_y0' , 'p_vddeck1', 'p_vsseck1', 'p_np' - , 'p_ovr' , 'p_cout' , 'p_ng' ] - , 'pads.west' : [ 'p_cin' , 'p_i4' , 'p_i5' , 'p_i3' - , 'p_ck' , 'p_d0' , 'p_d1' , 'p_d2' - , 'p_d3' , 'p_q0' , 'p_f3' ] - , 'core.size' : ( 1500, 1500 ) - , 'chip.size' : ( 3000, 3000 ) - , 'chip.clockTree' : True - } - -The file must contain *one dictionnary* named ``chip``. - -+----------------------+-------------------------------------------------------+ -| Chip Dictionnary | -+----------------------+-------------------------------------------------------+ -| Parameter Key/Name | Value/Contents type | -+======================+=======================================================+ -| ``'pad.south'`` | Ordered list (left to right) of pad instances names | -| | to put on the south side of the chip | -+----------------------+-------------------------------------------------------+ -| ``'pad.east'`` | Ordered list (down to up) of pad instances names | -| | to put on the east side of the chip | -+----------------------+-------------------------------------------------------+ -| ``'pad.north'`` | Ordered list (left to right) of pad instances names | -| | to put on the north side of the chip | -+----------------------+-------------------------------------------------------+ -| ``'pad.west'`` | Ordered list (down to up) of pad instances names | -| | to put on the west side of the chip | -+----------------------+-------------------------------------------------------+ -| ``'core.size'`` | The size of the core (to be used by the placer) | -+----------------------+-------------------------------------------------------+ -| ``'chip.size'`` | The size of the whole chip. The sides must be great | -| | enough to accomodate all the pads | -+----------------------+-------------------------------------------------------+ -| ``'chip.clockTree'`` | Whether to generate a clock tree or not. This calls | -| | the ClockTree plugin | -+----------------------+-------------------------------------------------------+ - -Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. - -+-----------------------------------+------------------+----------------------------+ -| Parameter Identifier | Type | Default | -+===================================+==================+============================+ -| **Chip Plugin Parameters** | -+-----------------------------------+------------------+----------------------------+ -|``chip.block.rails.count`` | TypeInt | :cb:`5` | -| +------------------+----------------------------+ -| | The minimum number of rails around the core | -| | block. Must be odd and suppérior to 5. | -| | One rail for the clock and at least two pairs | -| | of power/grounds | -+-----------------------------------+------------------+----------------------------+ -|``chip.block.rails.hWidth`` | TypeInt | :cb:`12` | -| +------------------+----------------------------+ -| | The horizontal with of the rails | -+-----------------------------------+------------------+----------------------------+ -|``chip.block.rails.vWidth`` | TypeInt | :cb:`12` | -| +------------------+----------------------------+ -| | The vertical with of the rails | -+-----------------------------------+------------------+----------------------------+ -|``chip.block.rails.hSpacing`` | TypeInt | :cb:`6` | -| +------------------+----------------------------+ -| | The spacing, *edge to edge* of two adjacent | -| | horizontal rails | -+-----------------------------------+------------------+----------------------------+ -|``chip.block.rails.vSpacing`` | TypeInt | :cb:`6` | -| +------------------+----------------------------+ -| | The spacing, *edge to edge* of two adjacent | -| | vertical rails | -+-----------------------------------+------------------+----------------------------+ -|``chip.pad.pck`` | TypeString | :cb:`pck_px` | -| +------------------+----------------------------+ -| | The model name of the pad connected to the | -| | chip external clock | -+-----------------------------------+------------------+----------------------------+ -|``chip.pad.pvddeck`` | TypeString | :cb:`pvddeck_px` | -| +------------------+----------------------------+ -| | The model name of the pad connected to the | -| | ``vdde`` (external power) and suppling it to | -| | the core | -+-----------------------------------+------------------+----------------------------+ -|``chip.pad.pvsseck`` | TypeString | :cb:`pvsseck_px` | -| +------------------+----------------------------+ -| | The model name of the pad connected to the | -| | ``vsse`` (external ground) and suppling it to | -| | the core | -+-----------------------------------+------------------+----------------------------+ -|``chip.pad.pvddick`` | TypeString | :cb:`pvddick_px` | -| +------------------+----------------------------+ -| | The model name of the pad connected to the | -| | ``vddi`` (internal power) and suppling it to | -| | the core | -+-----------------------------------+------------------+----------------------------+ -|``chip.pad.pvssick`` | TypeString | :cb:`pvssick_px` | -| +------------------+----------------------------+ -| | The model name of the pad connected to the | -| | ``vssi`` (internal ground) and suppling it to | -| | the core | -+-----------------------------------+------------------+----------------------------+ - -.. note:: - If no clock tree is generated, then the clock rail is *not* created. - So even if the requested number of rails ``chip.block.rails.count`` is, say 5, - only four rails (2* ``power``, 2* ``ground``) will be generateds. - - -Clock Tree -~~~~~~~~~~ - -Insert a clock tree into a block. The clock tree uses the H strategy. -The clock net is splitted into sub-nets, one for each branch of the -tree. - -* On **chips** design, the sub-nets are createds in the model of the - core block (then trans-hierarchically flattened to be shown at - chip level). -* On **blocks**, the sub nets are created directly in the top block. -* The sub-nets are named according to a simple geometrical scheme. - A common prefix ``ck_htree``, then one postfix by level telling - on which quarter of plane the sub-clock is located: - - #. ``_bl``: bottom left plane quarter. - #. ``_br``: bottom right plane quarter. - #. ``_tl``: top left plane quarter. - #. ``_tr``: top right plane quarter. - - We can have ``ck_htree_bl``, ``ck_htree_bl_bl``, ``ch_htree_bl_tl`` and so on. - -The clock tree plugin works in four steps: - -#. Build the clock tree: creates the top-block abutment box, compute the - levels of H tree neededs and place the clock buffers. -#. Once the clock buffers are placed, calls the placer (|etesian|) to place - the ordinary standart cells, whithout disturbing clock H-tree buffers. -#. At this point we know the exact positions of all the DFFs, so we can - connect them to the nearest H-tree leaf clock signal. -#. Leaf clock signals that are not connecteds to any DFFs are removed. - -Netlist reorganisation: - -* Obviously the top block or chip core model netlist is modificated to - contains all the clock sub-nets. The interface is *not* changed. -* If the top block contains instances of other models *and* those models - contains DFFs that get re-connecteds to the clock sub-nets (from the - top level). Change both the model netlist and interface to propagate - the relevant clock sub-nets to the instanciated model. The new model - with the added clock signal is renamed with a ``_clocked`` suffix. - For example, the sub-block model ``ram.vst`` will become ``ram_clocked.vst``. - -.. note:: - If you are to re-run the clock tree plugin on a netlist, be careful - to erase any previously generated ``_clocked`` file (both netlist and - layout: ``rm *.clocked.{ap,vst}``). And restart |cgt| to clear it's - memory cache. - -Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. - -+-----------------------------------+------------------+----------------------------+ -| Parameter Identifier | Type | Default | -+===================================+==================+============================+ -| **ClockTree Plugin Parameters** | -+-----------------------------------+------------------+----------------------------+ -|``clockTree.minimumSide`` | TypeInt | :cb:`300` | -| +------------------+----------------------------+ -| | The minimum size below which the clock tree | -| | will stop to perform quadri-partitions | -+-----------------------------------+------------------+----------------------------+ -|``clockTree.buffer`` | TypeString | :cb:`buf_x2` | -| +------------------+----------------------------+ -| | The buffer model to use to drive sub-nets | -+-----------------------------------+------------------+----------------------------+ -|``clockTree.placerEngine`` | TypeString | :cb:`Etesian` | -| +------------------+----------------------------+ -| | The placer to use. Other value is ``Mauka`` | -| | the simulated annealing placer which will go | -| | into retirement very soon | -+-----------------------------------+------------------+----------------------------+ - - -Recursive-Save (RSave) -~~~~~~~~~~~~~~~~~~~~~~ - -Perform a recursive top down save of all the models from the top cell -loaded in |cgt|. Force a write of any non-terminal model. This plugin is used -by the clock tree plugin after the netlist clock sub-nets creation. - - -A Simple Example: AM2901 -======================== - -To illustrate the capabilities of |Coriolis| tools and |Python| scripting, a small -example, derived from the |Alliance| :cb:`AM2901` is supplied. - -This example contains only the synthetized netlists and the :cb:`doChip.py` script -which perform the whole P&R of the design. - -You can generate the chip using one of the following method: - -#. **Command line mode:** directly run the script: :: - - dummy@lepka:AM2901$ ./doChip -V --cell=amd2901 - -#. **Graphic mode:** launch |cgt|, load chip netlist ``amd2901`` (the top cell) - then run the |Python| script :cb:`doChip.py`. - -.. note:: - Between two consecutive run, be sure to erase the netlist/layout generateds: :: - - dummy@lepka:AM2901$ rm *_clocked*.vst *.ap diff --git a/documentation/UsersGuide/UsersGuide_HTML.rst b/documentation/UsersGuide/UsersGuide_HTML.rst deleted file mode 100644 index 1bb507b5..00000000 --- a/documentation/UsersGuide/UsersGuide_HTML.rst +++ /dev/null @@ -1,5 +0,0 @@ - -.. -*- Mode: rst -*- - -.. include:: HTML_defs.rst -.. include:: UsersGuide.rst diff --git a/documentation/UsersGuide/UsersGuide_LaTeX.rst b/documentation/UsersGuide/UsersGuide_LaTeX.rst deleted file mode 100644 index 0c6ed943..00000000 --- a/documentation/UsersGuide/UsersGuide_LaTeX.rst +++ /dev/null @@ -1,5 +0,0 @@ - -.. -*- Mode: rst -*- - -.. include:: LaTeX_defs.rst -.. include:: UsersGuide.rst diff --git a/documentation/UsersGuide/ViewerTools.rst b/documentation/UsersGuide/ViewerTools.rst new file mode 100644 index 00000000..8313e1df --- /dev/null +++ b/documentation/UsersGuide/ViewerTools.rst @@ -0,0 +1,868 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Stratus Documentation: file:///usr/share/doc/coriolis2/en/html/stratus/index.html + + +.. |BigMouse| image:: ./images/ComputerMouse.png + :scale: 25% + +.. |ViewerSnapshot_1| image:: ./images/Viewer-1.png + :alt: Viewer Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSnapshot_1| image:: ./images/Controller-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerLook_1| image:: ./images/Controller-Look-1.png + :alt: Controller Look, Snapshot 1 + :align: middle + :width: 80% + +.. |ControllerFilter_1| image:: ./images/Controller-Filter-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerLayersGos_1| image:: ./images/Controller-LayersGos-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerNetlist_1| image:: ./images/Controller-Netlist-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ViewerNetlist_1| image:: ./images/Viewer-Netlist-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSelection_1| image:: ./images/Controller-Selection-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_1| image:: ./images/Controller-Inspector-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_2| image:: ./images/Controller-Inspector-2.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_3| image:: ./images/Controller-Inspector-3.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSettings_1| image:: ./images/Controller-Settings-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |Etesian-1| image:: ./images/etesian-1.png + :alt: Etesian Abutment Box + :align: middle + :width: 80% + + +CGT - The Graphical Interface +============================= + +The |Coriolis| graphical interface is split up into two windows. + +* The **Viewer**, with the following features: + + * Basic load/save capabilities. + * Display the current working cell. Could be empty if the design + is not yet placed. + * Execute Stratus Scripts. + * Menu to run the tools (placement, routage). + +Features are detailed in `Viewer & Tools`_. + +|ViewerSnapShot_1| + +* The **Controller**, which allows: + + * Tweak what is displayer by the *Viewer*. Through the *Look*, + *Filter* and *Layers&Gos* tabs. + * Browse the |netlist| with eponym tab. + * Show the list of selected objects (if any) with *selection* + * Walk through the Database, the Cell or the Selection with *Inspector*. + This is an advanced feature, reserved for experimented users. + * The tab *Settings* which give access to all the settings. + They are closely related to Configuration & Initialisation. + +|bcenter| |ControllerSnapShot_1| |ecenter| + + +.. _Viewer & Tools: + +Viewer & Tools +~~~~~~~~~~~~~~ + +|Stratus| Netlist Capture +------------------------- + +|Stratus| is the replacement for |GenLib| procedural netlist capture language. +It is designed as a set of |Python| classes, and comes with it's own documentation +(`Stratus Documentation`_) + + +The |Hurricane| Data-Base +------------------------- + +The |Alliance| flow is based on the |MBK| data-base, which has one data-structure +for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical* +view. The place and route tools were responsible for maintaining (or not) the +coherency between views. Reflecting this weak coupling between views, each one +was stored in a separate file with a specific format. The *logical* view is stored +in a |vst| file in |VHDL| format and the *physical* in an |ap| file in an ad-hoc format. + +The |Coriolis| flow is based on the |Hurricane| data-base, which has a unified +structure for *logical* and *physical* view. That data structure is the |Cell| object. +The |Cell| can have any state between pure netlist and completly placed and +routed design. Although the memory representation of the views has deeply +changed we still use the |Alliance| files format, but they now really represent +views of the same object. The point is that one must be very careful about +view coherency when going to and from |Coriolis|. + +As for the second release, |Coriolis| can be used only for three purposes : + +* **Placing a design**, in which case the |netlist| view must be present. +* **Routing a design**, in that case the |netlist| + view and the |layout| view must be present and |layout| view must contain + a placement. Both views must have the same name. When saving the routed design, + it is advised to change the design name otherwise the original unrouted placement + in the |layout| view will be overwritten. +* **Viewing a design**, the |netlist| view must be present, if a |layout| + view is present it still must have the same name but it can be in any + state. + + +Synthetizing and loading a design +--------------------------------- + +|Coriolis| supports several file formats. It can load all file format +from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), +BLIF netlist format as well as benchmark formats from the ISPD contests. + +It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license +and may not be compiled in your version of the software. + +Synthesis under Yosys +..................... + +You can create a BLIF file from the |Yosys| synthetizer, which can be imported under Coriolis. +Most libraries are specified as a .lib liberty file and a .lef LEF file. +|Yosys| opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2. +If Coriolis hasn't been compiled against it, the library is given in |Alliance| .ap format. +`Some free libraries `_ already provide both .ap and .lib files. + +Once you have installed a common library under |Yosys| and Coriolis, just synthetize your design +with |Yosys| and import it (as Blif without the extension) under Coriolis to perform place&route. + +Synthesis under Alliance +........................ + +|Alliance| is an older toolchain but has been extensively used for years. Coriolis can import +and write Alliance designs and libraries directly. + +Etesian -- Placer +----------------- + +The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is +within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace. +This |Coriolis| tool is actually an encapsulation of |Coloquinte| which *is* the placer. + +.. note:: *Instance Uniquification Unsupported:* a same logical instance cannot have + two different placements. So, either you manually make a clone of it or you + supply a placement for it. We need to implement uniquification in the + |Hurricane| database. + + +|noindent| +**Hierarchical Placement** + +The placement area is defined by the top cell abutment box. + +When placing a complete hierarchy, the abutment boxes of the cells (models) other than +the top cell are sets identical to the one of the top cell and their instances are +all placed at position ``(0,0,ID)``. That is, all the abutments boxes, whatever the +hierarchical level, defines the same area (they are exactly superposed). + +We choose this scheme because the placer will see all the instances as virtually +flattened, so they can be placed anywhere inside the top-cell abutment box. + +|bcenter| |Etesian-1| |ecenter| + + +|noindent| +**Computing the Placement Area** + +The placement area is computed using the ``etesian.aspectRatio`` and ``etesian.spaceMargin`` +parameters only if the top-cell has an empty abutment box. If the top-cell abutment +box has to be set, then it is propagated to all the instances models recursively. + + +|noindent| +**Reseting the Placement** + +Once a placement has been done, the placer cannot reset it (will be implemented +later). To perform a new placement, you must restart |cgt|. In addition, if you +have saved the placement on disk, you must erase any :cb:`.ap` file, which are +automatically reloaded along with the netlist (:cb:`.vst`). + +|noindent| +**Limitations** + +Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version, +it doesn't support movable macros, and you must place every macro beforehand. +Timing and routability analysis are not included either, and the returned placement +may be unroutable. + + +Etesian Configuration Parameters +................................ + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Etesian Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``etesian.aspectRatio`` | TypePercentage | :cb:`100` | +| +------------------+----------------------------+ +| | Define the height on width ``H/W`` aspect | +| | ratio, can be comprised between 10 and 1000 | ++-----------------------------------+------------------+----------------------------+ +|``etesian.spaceMargin`` | TypePercentage | :cb:`5` | +| +------------------+----------------------------+ +| | The extra white space added to the total area | +| | of the standard cells | ++-----------------------------------+------------------+----------------------------+ +|``etesian.uniformDensity`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Whether the cells will be spread envenly | +| | across the area or allowed to form denser | +| | clusters | ++-----------------------------------+------------------+----------------------------+ +|``etesian.effort`` | TypeInt | :cb:`2` | +| +------------------+----------------------------+ +| | Sets the balance between the speed of the | +| | placer and the solution quality | ++-----------------------------------+------------------+----------------------------+ +|``etesian.routingDriven`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Whether the tool will try routing iterations | +| | and whitespace allocation to improve | +| | routability; to be implemented | ++-----------------------------------+------------------+----------------------------+ +|``etesian.graphics`` | TypeInt | :cb:`2` | +| +------------------+----------------------------+ +| | How often the display will be refreshed | +| | More refreshing slows the placer. | +| | | +| | * ``1`` shows both upper and lower bounds | +| | * ``2`` only shows lower bound results | +| | * ``3`` only shows the final results | ++-----------------------------------+-----------------------------------------------+ + +|newpage| + + +Knik -- Global Router +--------------------- + +The quality of |Knik| global routing solutions are equivalent to those of FGR_ 1.0. +For an in-depth description of |Knik| algorithms, you may download the thesis of +D. |Dupuis| avalaible from here~: `Knik Thesis`_. + +The global router is (not yet) deterministic. To circumvent this limitation, +a global routing *solution* can be saved to disk and reloaded for later uses. + +A global routing is saved into a file with the same name as the design and a +|kgr| extention. It is in `Box Router`_ output format. + +|noindent| Menus: + +* :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Save Global Routing}` +* :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Load Global Routing}` + + +Kite -- Detailed Router +----------------------- + +|Kite| no longer suffers from the limitations of |Nero|. It can route big designs +as its runtime and memory footprint is almost linear (with respect to the number +of gates). It has successfully routed design of more than `150K` gates. +|medskip| + +|noindent| However, this first release comes with the temporary the following +restrictions: + +* Works only with |SxLib| standard cell gauge. +* Works always with 4 routing metal layers (`M2` through `M5`). +* Do not allow (take into account) pre-routed wires on signals + other than |POWER| or |GROUND|. + +.. note:: + **Slow Layer Assignment.** Most of the time, the layer assignment stage is + fast (less than a dozen seconds), but in some instances it can take more + than a dozen *minutes*. This is a known bug and will be corrected in later + releases. + +After each run, |Kite| displays a set of *completion ratios* which must all +be equal to `100%` if the detailed routing has been successfull. +In the event of a failure, on a saturated design, you may decrease the +`edge saturation ratio` (argument `--edge`) to balance more evenly the design +saturation. That is, the maximum saturation decrease at the price of a wider +saturated area and increased wirelength. This is the saturation of the +*global* router |Knik|, and you may increase/decrease by steps of ``5%``, +which represent one track. The maximum capacity of the |SxLib| gauge is +10 tracks in two layers, that makes 20 tracks by |Knik| edge. + +Routing a design is done in four ordered steps: + +#. Detailed pre-route :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed PreRoute}` +#. Global routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Global Route}` +#. Detailed routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed Route}` +#. Finalize routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Finalize Route}` + +It is possible to supply to the router a complete wiring for some nets that the user's +wants to be routed according to a specific topology. The supplied topology must respect +the building rules of the |Katabatic| database (contacts must be, terminals, turns, h-tee +& v-tee only). During the first step :fboxtt:`Detailed Pre-Route` the router will solve +overlaps between the segments, without making any dogleg. If no pre-routed topologies +are present, this step may be ommited. Any net routed at this step is then fixed and +become unmovable for the later stages. + +After the detailed routing step the |Kite| data-structure is still active +(the Hurricane wiring is decorated). The finalize step performs the removal of +the |Kite| data-structure, and it is not advisable to save the design before +that step. + +You may visualize the density (saturation) of either |Knik| (on edges) or +|Kite| (on GCells) until the routing is finalized. Special layers appears +to that effect in the `The Layers&Go Tab`_. + + +Kite Configuration Parameters +............................. + +As |Knik| is only called through |Kite|, it's parameters also have +the :cb:`kite.` prefix. + +The |Katabatic| parameters control the layer assignment step. + +All the defaults value given below are from the default |Alliance| technology +(:cb:`cmos` and :cb:`SxLib` cell gauge/routing gauge). + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Katabatic Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``katabatic.topRoutingLayer`` | TypeString | :cb:`METAL5` | +| +------------------+----------------------------+ +| | Define the highest metal layer that will be | +| | used for routing (inclusive). | ++-----------------------------------+------------------+----------------------------+ +|``katabatic.globalLengthThreshold``| TypeInt | :cb:`1450` | +| +------------------+----------------------------+ +| | This parameter is used by a layer assignment | +| | method which is no longer used (did not give | +| | good results) | ++-----------------------------------+------------------+----------------------------+ +| ``katabatic.saturateRatio`` | TypePercentage | :cb:`80` | +| +------------------+----------------------------+ +| | If ``M(x)`` density is above this ratio, | +| | move up feedthru global segments up from | +| | depth ``x`` to ``x+2`` | ++-----------------------------------+------------------+----------------------------+ +| ``katabatic.saturateRp`` | TypeInt | :cb:`8` | +| +------------------+----------------------------+ +| | If a GCell contains more terminals | +| | (:cb:`RoutingPad`) than that number, force a | +| | move up of the connecting segments to those | +| | in excess | ++-----------------------------------+------------------+----------------------------+ +| **Knik Parameters** | ++-----------------------------------+------------------+----------------------------+ +| ``kite.hTracksReservedLocal`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | To take account the tracks needed *inside* a | +| | GCell to build the *local* routing, decrease | +| | the capacity of the edges of the global | +| | router. Horizontal and vertical locally | +| | reserved capacity can be distinguished for | +| | more accuracy. | ++-----------------------------------+------------------+----------------------------+ +| ``kite.vTracksReservedLocal`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | cf. ``kite.hTracksReservedLocal`` | ++-----------------------------------+------------------+----------------------------+ +| **Kite Parameters** | ++-----------------------------------+------------------+----------------------------+ +| ``kite.eventsLimit`` | TypeInt | :cb:`4000002` | +| +------------------+----------------------------+ +| | The maximum number of segment displacements, | +| | this is a last ditch safety against infinite | +| | loop. It's perhaps a little too low for big | +| | designs | ++-----------------------------------+------------------+----------------------------+ +| ``kite.ripupCost`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | Differential introduced between two ripup | +| | cost to avoid a loop between two ripped up | +| | segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.strapRipupLimit`` | TypeInt | :cb:`16` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *strap* segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.localRipupLimit`` | TypeInt | :cb:`9` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *local* segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.globalRipupLimit`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *global* segments,| +| | when this limit is reached, triggers topologic| +| | modification | ++-----------------------------------+------------------+----------------------------+ +| ``kite.longGlobalRipupLimit`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *long global* | +| | segments, when this limit is reached, triggers| +| | topological modification | ++-----------------------------------+------------------+----------------------------+ + + + +.. _Python Scripts in Cgt: + +Executing Python Scripts in Cgt +------------------------------- + +Python/Stratus scripts can be executed either in text or graphical mode. + +.. note:: **How Cgt Locates Python Scripts:** + |cgt| uses the Python ``import`` mechanism to load Python scripts. + So you must give the name of your script whitout ``.py`` extention and + it must be reachable through the ``PYTHONPATH``. You may uses the + dotted module notation. + +A Python/Stratus script must contains a function called ``ScriptMain()`` +with one optional argument, the graphical editor into which it may be +running (will be set to ``None`` in text mode). The Python interface to +the editor (type: :cb:`CellViewer`) is limited to basic capabilities +only. + +Any script given on the command line will be run immediatly *after* the +initializations and *before* any other argument is processed. + +For more explanation on Python scripts see :ref:`Python Interface to Coriolis`. + + +Printing & Snapshots +-------------------- + +Printing or saving into a |pdf| is fairly simple, just uses the **File -> Print** +menu or the |CTRL_P| shortcut to open the dialog box. + +The print functionality uses exactly the same rendering mechanism as for the +screen, beeing almost *WYSIWYG*. Thus, to obtain the best results it is advisable +to select the ``Coriolis.Printer`` look (in the *Controller*), which uses a +white background and much suited for high resolutions ``32x32`` pixels patterns + +There is also two mode of printing selectable through the *Controller* +**Settings -> Misc -> Printer/Snapshot Mode**: + +=============== ================= ===================================================== +Mode DPI (approx.) Intended Usage +--------------- ----------------- ----------------------------------------------------- +**Cell Mode** 150 For single ``Cell`` printing or very small designs. + Patterns will be bigger and more readable. +**Design Mode** 300 For designs (mostly commposed of wires and cells + outlines). +=============== ================= ===================================================== + +.. note:: *The pdf file size* + Be aware that the generated |pdf| files are indeed only pixmaps. + So they can grew very large if you select paper format above ``A2`` + or similar. + + +|noindent| +Saving into an image is subject to the same remarks as for |pdf|. + + +Memento of Shortcuts in Graphic Mode +------------------------------------ + +The main application binary is |cgt|. + ++---------------+-------------------+-----------------------------------------------------------+ +| Category | Keys | Action | ++===============+===================+===========================================================+ +| **Moves** | | |KeyUp|, | Shift the view in the according direction | +| | |KeyDown| | | +| | | |KeyLeft|, | | +| | |KeyRight| | | ++---------------+-------------------+-----------------------------------------------------------+ +| **Fit** | |KeyF| | Fit to the Cell abutment box | ++---------------+-------------------+-----------------------------------------------------------+ +| **Refresh** | |CTRL_L| | Triggers a complete display redraw | ++---------------+-------------------+-----------------------------------------------------------+ +| **Goto** | |KeyG| | *apperture* is the minimum side of the area | +| | | displayed around the point to go to. It's an | +| | | alternative way of setting the zoom level | ++---------------+-------------------+-----------------------------------------------------------+ +| **Zoom** | |KeyZ|, | Respectively zoom by a 2 factor and *unzoom* | +| | |KeyM| | by a 2 factor | +| +-------------------+-----------------------------------------------------------+ +| | | |BigMouse| | You can perform a zoom to an area. | +| | | Area Zoom | Define the zoom area by *holding down the left | +| | | mouse button* while moving the mouse. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Selection** | | |BigMouse| | You can select displayed objects under an area. | +| | | Area Selection | Define the selection area by *holding down the | +| | | right mouse button* while moving the mouse. | +| +-------------------+-----------------------------------------------------------+ +| | | |BigMouse| | You can toggle the selection of one object under | +| | | Toggle Selection| the mouse position by pressing |CTRL| and | +| | | pressing down *the right mouse button*. A popup | +| | | list of what's under the position shows up into | +| | | which you can toggle the selection state of one | +| | | item. | +| +-------------------+-----------------------------------------------------------+ +| | |KeyCapS| | Toggle the selection visibility | ++---------------+-------------------+-----------------------------------------------------------+ +| **Controller**| |CTRL_I| | Show/hide the controller window. | +| | | | +| | | It's the Swiss Army Knife of the viewer. | +| | | From it, you can fine-control the display and | +| | | inspect almost everything in your design. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Rulers** | |KeyK|, | One stroke on |KeyK| enters the ruler mode, in | +| | |KeyESC| | which you can draw one ruler. You can exit the | +| | | ruler mode by pressing |KeyESC|. Once in ruler | +| | | mode, the first click on the *left mouse button* | +| | | sets the ruler's starting point and the second | +| | | click the ruler's end point. The second click | +| | | exits automatically the ruler mode. | +| +-------------------+-----------------------------------------------------------+ +| | |KeyCapK| | Clears all the drawn rulers | ++---------------+-------------------+-----------------------------------------------------------+ +| **Print** | |CTRL_P| | Currently rather crude. It's a direct copy of | +| | | what's displayed in pixels. So the resulting | +| | | picture will be a little blurred due to | +| | | anti-aliasing mechanism. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Open/Close**| |CTRL_O| | Opens a new design. The design name must be | +| | | given without path or extention. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_W| | Close the current viewer window, but do not quit | +| | | the application. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_Q| | `CTRL+Q` quit the application | +| | | (closing all windows). | ++---------------+-------------------+-----------------------------------------------------------+ +| **Hierarchy** | |CTRL_Down| | Go one hierarchy level down. That is, if there | +| | | is an *instance* under the cursor position, load | +| | | it's *model* Cell in place of the current one. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_Up| | Go one hierarchy level up. if we have entered | +| | | the current model through |CTRL_Down| | +| | | reload the previous model (the one | +| | | in which this model is instanciated). | ++---------------+-------------------+-----------------------------------------------------------+ + + +Cgt Command Line Options +------------------------ + +Appart from the obvious ``--text`` options, all can be used for text and graphical mode. + ++-----------------------------+------------------------------------------------+ +| Arguments | Meaning | ++=============================+================================================+ +| `-t|--text` | Instruct |cgt| to run in text mode. | ++-----------------------------+------------------------------------------------+ +| `-L|--log-mode` | Disable the uses of |ANSI| escape sequence on | +| | the |tty|. Useful when the output is | +| | redirected to a file. | ++-----------------------------+------------------------------------------------+ +| `-c |--cell=` | The name of the design to load, without | +| | leading path or extention. | ++-----------------------------+------------------------------------------------+ +| `-g|--load-global` | Reload a global routing solution from disk. | +| | The file containing the solution must be named | +| | `.kgr`. | ++-----------------------------+------------------------------------------------+ +| `--save-global` | Save the global routing solution, into a file | +| | named `.kgr`. | ++-----------------------------+------------------------------------------------+ +| `-e |--edge=` | Change the edge capacity for the global | +| | router, between 0 and 1 (|Knik|). | ++-----------------------------+------------------------------------------------+ +| `-G|--global-route` | Run the global router (|Knik|). | ++-----------------------------+------------------------------------------------+ +| `-R|--detailed-route` | Run the detailed router (|Kite|). | ++-----------------------------+------------------------------------------------+ +| `-s|--save-design=` | The design into which the routed layout will | +| | be saved. It is strongly recommanded to choose | +| | a different name from the source (unrouted) | +| | design. | ++-----------------------------+------------------------------------------------+ +| `--events-limit=` | The maximal number of events after which the | +| | router will stops. This is mainly a failsafe | +| | against looping. The limit is sets to 4 | +| | millions of iteration which should suffice to | +| | any design of `100K`. gates. For bigger | +| | designs you may wants to increase this limit. | ++-----------------------------+------------------------------------------------+ +| `--stratus-script=` | Run the Python/Stratus script ``module``. | +| | See `Python Scripts in Cgt`_. | ++-----------------------------+------------------------------------------------+ + +|newpage| + + +Some Examples : + +* Run both global and detailed router, then save the routed design : :: + + > cgt -v -t -G -R --cell=design --save-design=design_kite + +* Load a previous global solution, run the detailed router, then save the + routed design : :: + + > cgt -v -t --load-global -R --cell=design --save-design=design_kite + +* Run the global router, then save the global routing solution : :: + + > cgt -v -t -G --save-global --cell=design + + +Miscellaneous Settings +---------------------- + ++---------------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++=======================================+==================+============================+ +| **Verbosity/Log Parameters** | ++---------------------------------------+------------------+----------------------------+ +| ``misc.info`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Enable display of *info* level message | +| | (:cb:`cinfo` stream) | ++---------------------------------------+------------------+----------------------------+ +| ``misc.bug`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Enable display of *bug* level message | +| | (:cb:`cbug` stream), messages can be a little | +| | scarry | ++---------------------------------------+------------------+----------------------------+ +| ``misc.logMode`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | If enabled, assume that the output device | +| | is not a ``tty`` and suppress any escaped | +| | sequences | ++---------------------------------------+------------------+----------------------------+ +| ``misc.verboseLevel1`` | TypeBool | :cb:`True` | +| +------------------+----------------------------+ +| | First level of verbosity, disable level 2 | ++---------------------------------------+------------------+----------------------------+ +| ``misc.verboseLevel2`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Second level of verbosity | ++---------------------------------------+------------------+----------------------------+ +| **Development/Debug Parameters** | ++---------------------------------------+------------------+----------------------------+ +| ``misc.minTraceLevel`` | TypeInt | :cb:`0` | ++---------------------------------------+------------------+----------------------------+ +| ``misc.maxTraceLevel`` | TypeInt | :cb:`0` | +| +------------------+----------------------------+ +| | Display trace information *between* those two | +| | levels (:cb:`cdebug` stream) | ++---------------------------------------+------------------+----------------------------+ +| ``misc.catchCore`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | By default, |cgt| do not dump core. | +| | To generate one set this flag to :cb:`True` | ++---------------------------------------+------------------+----------------------------+ + +|newpage| + + +.. _The Controller: + +The Controller +~~~~~~~~~~~~~~ + +The *Controller* window is composed of seven tabs: + +#. `The Look Tab`_ to select the display style. +#. `The Filter Tab`_ the hierarchical levels to be displayed, the look of + rubbers and the dimension units. +#. `The Layers&Go Tab`_ to selectively hide/display layers. +#. `The Netlist Tab`_ to browse through the |netlist|. Works in association + with the *Selection* tab. +#. `The Selection Tab`_ allow to view all the currently selected elements. +#. `The Inspector Tab`_ browse through either the DataBase, the Cell or + the current selection. +#. `The Settings Tab`_ access all the tool's configuration settings. + + +.. _The Look Tab: + +The Look Tab +------------ + +You can select how the layout will be displayed. There is a special one +``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_. +You should select it prior to calling the print or snapshot dialog boxes. + +|bcenter| |ControllerLook_1| |ecenter| + +|newpage| + + +.. _The Filter Tab: + +The Filter Tab +-------------- + +The filter tab let you select what hierarchical levels of your design will be +displayed. Hierarchy level are numbered top-down: the level 0 correspond to +the top-level cell, the level one to the instances of the top-level Cell and +so on. + +There are also check boxes to enable/disable the processing of Terminal Cell, +Master Cells and Compnents. The processing of Terminal Cell (hierarchy leaf +cells) is disabled by default when you load a hierarchical design and enabled +when you load a single Cell. + +You can choose what kind of form to give to the rubbers and the type of +unit used to display coordinates. + +.. note:: *What are Rubbers:* |Hurricane| uses *Rubbers* to materialize + physical gaps in net topology. That is, if some wires are missing to + connect two or more parts of net, a *rubber* will be drawn between them + to signal the gap. + + For example, after the detailed routing no *rubbers* should remains. + They have been made *very* visibles as big violet lines... + +|bcenter| |ControllerFilter_1| |ecenter| + +|newpage| + + +.. _The Layers&Go Tab: + +The Layers&Go Tab +----------------- + +Control the individual display of all *layers* and *Gos*. + +* *Layers* correspond to a true physical layer. From a |Hurricane| point of + view they are all the *BasicLayers* (could be matched to GDSII). +* *Gos* stands from *Graphical Objects*, they are drawings that have no + physical existence but are added by the various tools to display extra + information. One good exemple is the density map of the detailed router, + to easily locate congested areas. + +For each layer/Go there are two check boxes: + +* The normal one triggers the display. +* The red-outlined allows objects of that layer to be selectable or not. + +|bcenter| |ControllerLayersGos_1| |ecenter| + + +.. _The Netlist Tab: + +The Netlist Tab +--------------- + +The *Netlist* tab shows the list of nets... By default the tab is not +*synched* with the displayed Cell. To see the nets you must check the +**Sync Netlist** checkbox. You can narrow the set of displayed nets by +using the filter pattern (supports regular expressions). + +An very useful feature is to enable the **Sync Selection**, which will +automatically select all the components of the selected net(s). You can +select multiple nets. In the figure the net ``auxsc35`` is selected and +is highlited in the *Viewer*. + +|bcenter| |ControllerNetlist_1| |ecenter| +|bcenter| |ViewerNetlist_1| |ecenter| + + +.. _The Selection Tab: + +The Selection Tab +----------------- + +The *Selection* tab list all the components currently selecteds. They +can be filtered thanks to the filter pattern. + +Used in conjunction with the *Netlist* **Sync Selection** you will all see +all the components part of *net*. + +In this list, you can toggle individually the selection of component by +pressing the ``t`` key. When unselected in this way a component is not +removed from the the selection list but instead displayed in red italic. +To see where a component is you may make it blink by repeatedly press +the ``t`` key... + +|bcenter| |ControllerSelection_1| |ecenter| + + +.. _The Inspector Tab: + +The Inspector Tab +----------------- + +This tab is very useful, but mostly for |Coriolis| developpers. It allows +to browse through the live DataBase. The *Inspector* provide three entry points: + +* **DataBase**: Starts from the whole |Hurricane| DataBase. +* **Cell**: Inspect the currently loaded Cell. +* **Selection**: Inspect the object currently highlited in the *Selection* tab. + +Once an entry point has been activated, you may recursively expore all +it's fields using the right/left arrows. + +.. note:: *Do not put your fingers in the socket:* when inspecting + anything, do not modify the DataBase. If any object under inspection + is deleted, you will crash the application... + +.. note:: *Implementation Detail:* the inspector support is done with + ``Slot``, ``Record`` and ``getString()``. + +|bcenter| |ControllerInspector_1| |ecenter| +|bcenter| |ControllerInspector_2| |ecenter| +|bcenter| |ControllerInspector_3| |ecenter| + + +.. _The Settings Tab: + +The Settings Tab +---------------- + +Here comes the description of the *Settings* tab. + +|bcenter| |ControllerSettings_1| |ecenter| diff --git a/documentation/UsersGuide/WWW_defs.rst b/documentation/UsersGuide/WWW_defs.rst deleted file mode 100644 index 5062f371..00000000 --- a/documentation/UsersGuide/WWW_defs.rst +++ /dev/null @@ -1,70 +0,0 @@ - -.. -*- Mode: rst -*- -.. This header contains the definitions needed for the UsersGuide.rst -.. document to be displayed correctly on the soc-extras website. -.. The only difference with HTML_defs.rst is that the images are -.. stored at a different URL on the website. Namely: -.. https://soc-extras.lip6.fr/media/filer/2012/12/07/ - -.. 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 -.. _Here: https://www-soc.lip6.fr/sesi-docs/coriolis2-docs/coriolis2/en/latex/users-guide/UsersGuide.pdf - -.. role:: raw-html(raw) - :format: html - -.. For HTML backend -.. |Key_ESC| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_esc.png -.. |Key_CTRL| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_ctrl.png -.. |Key_Up| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_up.png -.. |Key_Down| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_down.png -.. |Key_Left| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_left.png -.. |Key_Right| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_right.png -.. |Key_f| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_f.png -.. |Key_G| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_gcap.png -.. |Key_i| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_icap.png -.. |Key_l| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_lcap.png -.. |Key_m| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_m.png -.. |Key_k| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_k.png -.. |Key_K| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_kcap.png -.. |Key_o| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_ocap.png -.. |Key_p| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_pcap.png -.. |Key_q| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_qcap.png -.. |Key_w| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_wcap.png -.. |Key_S| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_scap.png -.. |Key_z| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/key_z.png -.. |Plus| replace:: :raw-html:`+` -.. |rightarrow| replace:: :raw-html:`

` -.. |menu_P&R| replace:: :raw-html:`

` -.. |menu_StepByStep| replace:: :raw-html:`

` -.. |menu_KiteSaveGlobalRouting| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-sbs-saveglobal.png -.. |menu_KiteLoadGlobalRouting| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-sbs-loadglobal.png -.. |menu_KiteGlobalRoute| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-globalroute.png -.. |menu_KiteDetailedRoute| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-detailedroute.png -.. |menu_KiteDetailedPreRoute| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-detailedpreroute.png -.. |menu_KiteFinalizeRoute| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/pr-finalizeroute.png - -.. Stand-alone images. -.. |ViewerSnapshot_1| replace:: :raw-html:`
Viewer Basic Snapshot
` -.. |ControllerSnapshot_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerLook_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerFilter_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerLayersGos_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerNetlist_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ViewerNetlist_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerSelection_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_2| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerInspector_3| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |ControllerSettings_1| replace:: :raw-html:`
Controller Basic Snapshot
` -.. |CoriolisSoftSchema| replace:: :raw-html:`
Coriolis Software Schematic
` - -.. |BigMouse| image:: https://soc-extras.lip6.fr/media/filer/2012/12/07/computermouse.png - :scale: 25% - -.. Direct LaTeX commands encapsulation. -.. |dotfill| replace:: :raw-html:`  ` -.. |noindent| replace:: :raw-html:`

` -.. |medskip| replace:: :raw-html:`
` -.. |newpage| replace:: :raw-html:`
` diff --git a/documentation/UsersGuide/images/Controller-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-1-eps-converted-to.pdf new file mode 100644 index 00000000..f30a0f38 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Filter-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Filter-1-eps-converted-to.pdf new file mode 100644 index 00000000..3298d8fa Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Filter-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Inspector-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Inspector-1-eps-converted-to.pdf new file mode 100644 index 00000000..817a0120 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Inspector-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Inspector-2-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Inspector-2-eps-converted-to.pdf new file mode 100644 index 00000000..12982531 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Inspector-2-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Inspector-3-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Inspector-3-eps-converted-to.pdf new file mode 100644 index 00000000..9fa8ec11 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Inspector-3-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-LayersGos-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-LayersGos-1-eps-converted-to.pdf new file mode 100644 index 00000000..e58dfa22 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-LayersGos-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Look-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Look-1-eps-converted-to.pdf new file mode 100644 index 00000000..1cbaae91 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Look-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Netlist-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Netlist-1-eps-converted-to.pdf new file mode 100644 index 00000000..442f8b76 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Netlist-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Selection-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Selection-1-eps-converted-to.pdf new file mode 100644 index 00000000..535fbae2 Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Selection-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Controller-Settings-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Controller-Settings-1-eps-converted-to.pdf new file mode 100644 index 00000000..96fd825a Binary files /dev/null and b/documentation/UsersGuide/images/Controller-Settings-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Coriolis-Soft-Schema-eps-converted-to.pdf b/documentation/UsersGuide/images/Coriolis-Soft-Schema-eps-converted-to.pdf new file mode 100644 index 00000000..7cfb3bcb Binary files /dev/null and b/documentation/UsersGuide/images/Coriolis-Soft-Schema-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Viewer-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Viewer-1-eps-converted-to.pdf new file mode 100644 index 00000000..357780b2 Binary files /dev/null and b/documentation/UsersGuide/images/Viewer-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/Viewer-Netlist-1-eps-converted-to.pdf b/documentation/UsersGuide/images/Viewer-Netlist-1-eps-converted-to.pdf new file mode 100644 index 00000000..39e492d2 Binary files /dev/null and b/documentation/UsersGuide/images/Viewer-Netlist-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/chip-structure-1-eps-converted-to.pdf b/documentation/UsersGuide/images/chip-structure-1-eps-converted-to.pdf new file mode 100644 index 00000000..c937a9b4 Binary files /dev/null and b/documentation/UsersGuide/images/chip-structure-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/images/etesian-1-eps-converted-to.pdf b/documentation/UsersGuide/images/etesian-1-eps-converted-to.pdf new file mode 100644 index 00000000..c083696b Binary files /dev/null and b/documentation/UsersGuide/images/etesian-1-eps-converted-to.pdf differ diff --git a/documentation/UsersGuide/index.rst b/documentation/UsersGuide/index.rst new file mode 100644 index 00000000..7121510a --- /dev/null +++ b/documentation/UsersGuide/index.rst @@ -0,0 +1,21 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +======================= +Coriolis User's Guide +======================= + +Printable version of this document `UsersGuide.pdf <../../../pdf/main/UsersGuide.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + LicenseCredits.rst + Releases.rst + Installation.rst + Configuration.rst + ViewerTools.rst + ScriptsPlugins.rst diff --git a/documentation/UsersGuide/pdfHeader.rst b/documentation/UsersGuide/pdfHeader.rst new file mode 100644 index 00000000..3a9c832f --- /dev/null +++ b/documentation/UsersGuide/pdfHeader.rst @@ -0,0 +1,15 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +======================= +Coriolis User's Guide +======================= + +|pagestylefancy| + + +.. contents:: + +|newpage| diff --git a/documentation/UsersGuide/socstyle.tex b/documentation/UsersGuide/socstyle.tex deleted file mode 100644 index 5cf8f487..00000000 --- a/documentation/UsersGuide/socstyle.tex +++ /dev/null @@ -1,89 +0,0 @@ - - \usepackage[default,osfigures,scale=0.95]{opensans} - \usepackage{xspace} - \usepackage{fancyhdr} -%\usepackage[dvipdfm]{graphicx} - \usepackage{graphicx} - \usepackage{enumitem} - \usepackage[sf,bf]{titlesec} - \usepackage{titletoc} - \usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue,dvipdfm]{hyperref} - \usepackage[paper=a4paper,headheight=30pt,tmargin=1.5in,bmargin=1in]{geometry} -%\usepackage{layouts} - - \urlstyle{tt} % normal text font (alternatives: same, tt, rm, sf) - \renewlist{itemize}{itemize}{9} - \setlist[itemize]{label=\textbullet} - -% The LaTeX Companion -- p. 204. -% Miniature display of the page layout. -%\newcommand{\showpage}{% -% \setlayoutscale{0.65}\setlabelfont{\tiny}% -% \printheadingsfalse\printparametersfalse% -% \currentpage\pagedesign% -%} - - \titlecontents{section}[0pc] - {\sffamily\bfseries} % above code. - {\contentslabel{1pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsection}[0pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsubsection}[1pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - - \newcommand{\key}[1]{\raisebox{-0.5\baselineskip}{\rule{0pt}{1.5\baselineskip}}\fbox{\textsf{#1}}} - - \newcommand{\DUroleul}[1]{\underline{#1}\xspace} - \newcommand{\DUrolesc}[1]{\textsc{#1}\xspace} - \newcommand{\DUrolecb}[1]{\textbf{\texttt{#1}}\xspace} - \newcommand{\DUrolefboxtt}[1]{\fbox{\texttt{#1}}\xspace} - - \newcommand{\DUtitlenote}[1]{\noindent\textbf{#1}\smallskip} - - \newcommand{\DUadmonitionnote}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5,natwidth=48,natheight=48]{./images/clipboard.pdf}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\DUtitleerror}[1]{\noindent\textbf{\color{red}#1}\smallskip} - - \newcommand{\DUadmonitionerror}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5,natwidth=48,natheight=48]{./images/i-core.pdf}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\UPMC} {\textsc{upmc}\xspace} - \newcommand{\LIP} {\textsc{lip6}\xspace} - \newcommand{\SoC} {\textsc{S}o\textsc{C}\xspace} - - \renewcommand{\headrulewidth}{0.2mm} - \renewcommand{\footrulewidth}{0.2mm} - \renewcommand{\sectionmark}[1]{\markboth{\thesection\ #1}{\thesection\ #1}} - \renewcommand{\subsectionmark}[1]{} - \lhead[]{Documentation \SoC} - \rhead[]{March 2015} - \lfoot[]{\UPMC/\LIP/\SoC} - \rfoot[]{\thepage} - \cfoot[]{} - - \pagestyle{fancy} diff --git a/documentation/Viewer/Viewer.rst b/documentation/Viewer/Viewer.rst new file mode 100644 index 00000000..c103b413 --- /dev/null +++ b/documentation/Viewer/Viewer.rst @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================== +Viewer Reference +================== + +The Viewer C++ API reference is generated by Doxygen_ and is +available here: `Viewer `_ diff --git a/documentation/_build/doctrees/Contents.doctree b/documentation/_build/doctrees/Contents.doctree new file mode 100644 index 00000000..b4e850b7 Binary files /dev/null and b/documentation/_build/doctrees/Contents.doctree differ diff --git a/documentation/_build/doctrees/CrlCore/CrlCore.doctree b/documentation/_build/doctrees/CrlCore/CrlCore.doctree new file mode 100644 index 00000000..c59fd7ab Binary files /dev/null and b/documentation/_build/doctrees/CrlCore/CrlCore.doctree differ diff --git a/documentation/_build/doctrees/DpGen/DpGen.doctree b/documentation/_build/doctrees/DpGen/DpGen.doctree new file mode 100644 index 00000000..3fe89591 Binary files /dev/null and b/documentation/_build/doctrees/DpGen/DpGen.doctree differ diff --git a/documentation/_build/doctrees/Hurricane/Hurricane.doctree b/documentation/_build/doctrees/Hurricane/Hurricane.doctree new file mode 100644 index 00000000..6424b3dc Binary files /dev/null and b/documentation/_build/doctrees/Hurricane/Hurricane.doctree differ diff --git a/documentation/_build/doctrees/Katabatic/Katabatic.doctree b/documentation/_build/doctrees/Katabatic/Katabatic.doctree new file mode 100644 index 00000000..604f8410 Binary files /dev/null and b/documentation/_build/doctrees/Katabatic/Katabatic.doctree differ diff --git a/documentation/_build/doctrees/Kite/Kite.doctree b/documentation/_build/doctrees/Kite/Kite.doctree new file mode 100644 index 00000000..85ebbf7d Binary files /dev/null and b/documentation/_build/doctrees/Kite/Kite.doctree differ diff --git a/documentation/_build/doctrees/Patterns/Patterns.doctree b/documentation/_build/doctrees/Patterns/Patterns.doctree new file mode 100644 index 00000000..29ae4f45 Binary files /dev/null and b/documentation/_build/doctrees/Patterns/Patterns.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Configuration.doctree b/documentation/_build/doctrees/PythonCpp/Configuration.doctree new file mode 100644 index 00000000..82734a70 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/Configuration.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree b/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree new file mode 100644 index 00000000..66556e6e Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/DBoHierarchy.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree b/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree new file mode 100644 index 00000000..3b2616e1 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/DBoStandalone.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/DbU.doctree b/documentation/_build/doctrees/PythonCpp/DbU.doctree new file mode 100644 index 00000000..abec6c78 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/DbU.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Introduction.doctree b/documentation/_build/doctrees/PythonCpp/Introduction.doctree new file mode 100644 index 00000000..6a2be816 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/Introduction.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/Name.doctree b/documentation/_build/doctrees/PythonCpp/Name.doctree new file mode 100644 index 00000000..0f70db9b Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/Name.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/NonDBo.doctree b/documentation/_build/doctrees/PythonCpp/NonDBo.doctree new file mode 100644 index 00000000..fc5d7710 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/NonDBo.doctree differ diff --git a/documentation/_build/doctrees/PythonCpp/index.doctree b/documentation/_build/doctrees/PythonCpp/index.doctree new file mode 100644 index 00000000..0dffd096 Binary files /dev/null and b/documentation/_build/doctrees/PythonCpp/index.doctree differ diff --git a/documentation/_build/doctrees/RDS/RDSpage.doctree b/documentation/_build/doctrees/RDS/RDSpage.doctree new file mode 100644 index 00000000..909e3c1d Binary files /dev/null and b/documentation/_build/doctrees/RDS/RDSpage.doctree differ diff --git a/documentation/_build/doctrees/RDS/index.doctree b/documentation/_build/doctrees/RDS/index.doctree new file mode 100644 index 00000000..22318d67 Binary files /dev/null and b/documentation/_build/doctrees/RDS/index.doctree differ diff --git a/documentation/_build/doctrees/Stratus/Stratus.doctree b/documentation/_build/doctrees/Stratus/Stratus.doctree new file mode 100644 index 00000000..1fd0e367 Binary files /dev/null and b/documentation/_build/doctrees/Stratus/Stratus.doctree differ diff --git a/documentation/_build/doctrees/Unicorn/Unicorn.doctree b/documentation/_build/doctrees/Unicorn/Unicorn.doctree new file mode 100644 index 00000000..e8de0e2b Binary files /dev/null and b/documentation/_build/doctrees/Unicorn/Unicorn.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Configuration.doctree b/documentation/_build/doctrees/UsersGuide/Configuration.doctree new file mode 100644 index 00000000..15afc02b Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/Configuration.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Installation.doctree b/documentation/_build/doctrees/UsersGuide/Installation.doctree new file mode 100644 index 00000000..ceb83c86 Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/Installation.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree b/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree new file mode 100644 index 00000000..b092b64c Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/LicenseCredits.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/Releases.doctree b/documentation/_build/doctrees/UsersGuide/Releases.doctree new file mode 100644 index 00000000..d0486ddc Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/Releases.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree b/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree new file mode 100644 index 00000000..ce9a1dfc Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/ScriptsPlugins.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree b/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree new file mode 100644 index 00000000..8572d9d5 Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/ViewerTools.doctree differ diff --git a/documentation/_build/doctrees/UsersGuide/index.doctree b/documentation/_build/doctrees/UsersGuide/index.doctree new file mode 100644 index 00000000..b27bacd9 Binary files /dev/null and b/documentation/_build/doctrees/UsersGuide/index.doctree differ diff --git a/documentation/_build/doctrees/Viewer/Viewer.doctree b/documentation/_build/doctrees/Viewer/Viewer.doctree new file mode 100644 index 00000000..15b8458b Binary files /dev/null and b/documentation/_build/doctrees/Viewer/Viewer.doctree differ diff --git a/documentation/_build/doctrees/environment.pickle b/documentation/_build/doctrees/environment.pickle new file mode 100644 index 00000000..ccbb62d5 Binary files /dev/null and b/documentation/_build/doctrees/environment.pickle differ diff --git a/documentation/_build/doctrees/etc/definitions.doctree b/documentation/_build/doctrees/etc/definitions.doctree new file mode 100644 index 00000000..446116dd Binary files /dev/null and b/documentation/_build/doctrees/etc/definitions.doctree differ diff --git a/documentation/_build/doctrees/index.doctree b/documentation/_build/doctrees/index.doctree new file mode 100644 index 00000000..f2a76316 Binary files /dev/null and b/documentation/_build/doctrees/index.doctree differ diff --git a/documentation/_build/html/.buildinfo b/documentation/_build/html/.buildinfo new file mode 100644 index 00000000..3ba06f68 --- /dev/null +++ b/documentation/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 1563ffe9c48542af75d7298c4e351220 +tags: fbb0d17656682115ca4d033fb2f83ba1 diff --git a/documentation/_build/html/Contents.html b/documentation/_build/html/Contents.html new file mode 100644 index 00000000..ca4df365 --- /dev/null +++ b/documentation/_build/html/Contents.html @@ -0,0 +1,475 @@ + + + + + + + + + + + + Comprenhensive Table of Contents — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Comprenhensive Table of Contents
    • +
  • + + + +
    • +
+
+
+
+ +
+

Comprenhensive Table of Contents

+
+ +
+
+ + +
+
+ + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/CrlCore/CrlCore.html b/documentation/_build/html/CrlCore/CrlCore.html new file mode 100644 index 00000000..e2f4e3fd --- /dev/null +++ b/documentation/_build/html/CrlCore/CrlCore.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + CRL Core Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • CRL Core Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

CRL Core Reference

+

The CRL Core C++ API reference is generated by Doxygen and is +available here: CRL Core

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/DpGen/DpGen.html b/documentation/_build/html/DpGen/DpGen.html new file mode 100644 index 00000000..70f4378a --- /dev/null +++ b/documentation/_build/html/DpGen/DpGen.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + DpGen Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • DpGen Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

DpGen Reference

+

The DpGen extension of the Stratus Language reference is generated by LaTeX2HTML and is +available here: DpGen

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Hurricane/Hurricane.html b/documentation/_build/html/Hurricane/Hurricane.html new file mode 100644 index 00000000..ce9cc861 --- /dev/null +++ b/documentation/_build/html/Hurricane/Hurricane.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Hurricane Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Hurricane Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Hurricane Reference

+

The Hurricane C++ API reference is generated by Doxygen and is +available here: Hurricane

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Katabatic/Katabatic.html b/documentation/_build/html/Katabatic/Katabatic.html new file mode 100644 index 00000000..86d5e352 --- /dev/null +++ b/documentation/_build/html/Katabatic/Katabatic.html @@ -0,0 +1,341 @@ + + + + + + + + + + + + Katabatic Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Katabatic Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Katabatic Reference

+

The Katabatic C++ API reference is generated by Doxygen and is +available here: Katana

+
+

Note

+

The Katabatic API has served as a base for it’s +mixed signal conterpart Anabatic.

+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Kite/Kite.html b/documentation/_build/html/Kite/Kite.html new file mode 100644 index 00000000..3c4aca7c --- /dev/null +++ b/documentation/_build/html/Kite/Kite.html @@ -0,0 +1,341 @@ + + + + + + + + + + + + Kite Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Kite Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Kite Reference

+

The Kite C++ API reference is generated by Doxygen and is +available here: Kite

+
+

Note

+

The Kite API has also served has a base for it’s +mixed-signal conterpart Katana (Kit[e]-Ana[logic]).

+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Patterns/Patterns.html b/documentation/_build/html/Patterns/Patterns.html new file mode 100644 index 00000000..45f626b7 --- /dev/null +++ b/documentation/_build/html/Patterns/Patterns.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Patterns Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Patterns Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Patterns Reference

+

The Patterns extension of the Stratus Language reference is generated by LaTeX2HTML and is +available here: Patterns

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/Configuration.html b/documentation/_build/html/PythonCpp/Configuration.html new file mode 100644 index 00000000..3fa89929 --- /dev/null +++ b/documentation/_build/html/PythonCpp/Configuration.html @@ -0,0 +1,369 @@ + + + + + + + + + + + + 2. Basic File Structure and CMake configuration — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

2. Basic File Structure and CMake configuration

+

As a first example we will consider the Hurrican::Library +class. To export a class into Python, we must create three files:

+
    +
  1. PyLibrary.h, defines the PyLibrary C-Struct and the functions +needed outside the module istself (mostly for PyHurricane.cpp).
    2. +
  2. PyLibrary.cpp, contains the complete wrapping of the class and +the Python type definition (PyTypeLibrary).
    3. +
  3. PyHurricane.cpp, the definition of the Python module into which +the classes are registered. The module act as a namespace in +Python so it is good practice to give it the same name as it’s +associated C++ namespace.
    4. +
+

+

To build a Python module in cmake, use the following macro:

+
+
              set( pyCpps      PyLibrary.cpp
+                               PyHurricane.cpp )
+              set( pyIncludes  hurricane/isobar/PyLibrary.h
+
+add_python_module( "${pyCpps}"
+                   "${pyIncludes}"
+                   "isobar;1.0;1"     # Name & version of the supporting
+                                      # shared library.
+                   Hurricane          # Name of the Python module will give:
+                                      #   Hurricane.so
+                   "${depLibs}"       # List of dependency libraries.
+                   include/coriolis2/hurricane/isobar
+                                      # Where to install the include files.
+                 )
+
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/DBoHierarchy.html b/documentation/_build/html/PythonCpp/DBoHierarchy.html new file mode 100644 index 00000000..fcc89c58 --- /dev/null +++ b/documentation/_build/html/PythonCpp/DBoHierarchy.html @@ -0,0 +1,740 @@ + + + + + + + + + + + + 4. Case 2 - Hierarchy of DBo Derived Classes — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +

+
+

4. Case 2 - Hierarchy of DBo Derived Classes

+

Now we want to export the following C++ class hierarchy into Python:

+
PyEntity <-- PyComponent <-+- PyContact
+                           +- PySegment <-+- PyHorizontal
+                                          +- PyVertical
+
+
+

4.1 Base Class Header

+

Remark: this is only a partial description of the tree for the sake of +clarity.

+

One important fact to remember is that PyEntity and PyComponent +being related to C++ abstract classes, no objects of those types will be +created, only PyContact, PyHorizontal or PyVertical will.

+

The consequence is that there is no PyEntity_Link() like in 3.1 Class Associated Header File +but instead two functions:

+
    +
  1. PyEntity_NEW() which create the relevant PyEntity derived +object from the Entity one. For example, if the Entity* given +as argument is in fact a Horizontal*, then the function will +return a PyHorizontal*.
    2. +
  2. EntityCast() do the reverse of PyEntity_NEW() that is, from +a PyEntity, return the C++ derived object. Again, if the +PyEntity* is a PyHorizontal*, the function will cast it as +a Horizontal* then return it as an Entity*.
    3. +
+
#ifndef ISOBAR_PY_ENTITY_H
+#define ISOBAR_PY_ENTITY_H
+
+#include "hurricane/isobar/PyHurricane.h"
+#include "hurricane/Entity.h"
+
+namespace  Isobar {
+  extern "C" {
+
+    typedef struct {
+        PyObject_HEAD
+        Hurricane::Entity* _object;
+    } PyEntity;
+
+    extern  PyObject*     PyEntity_NEW        ( Hurricane::Entity* entity );
+    extern  void          PyEntity_LinkPyType ();
+    extern  PyTypeObject  PyTypeEntity;
+    extern  PyMethodDef   PyEntity_Methods[];
+
+
+#define IsPyEntity(v)    ( (v)->ob_type == &PyTypeEntity )
+#define PYENTITY(v)      ( (PyEntity*)(v) )
+#define PYENTITY_O(v)    ( PYENTITY(v)->_object )
+
+  }  // extern "C".
+
+  Hurricane::Entity*  EntityCast ( PyObject* derivedObject );
+
+}  // Isobar namespace.
+
+#endif  // ISOBAR_PY_ENTITY_H
+
+
+

+
+
+

4.2 Base Class File

+

Changes from 3.2 Class Associated File are:

+
    +
  1. No call to DBoLinkCreateMethod() because there must be no PyEntity_Link(), +but the definitions of PyEntity_NEW() and EntityCast.
    2. +
  2. For defining the PyTypeEntity Python type, we call a different +macro: PyTypeRootObjectDefinitions, dedicated to base classes.
    3. +
+
#include "hurricane/isobar/PyCell.h"
+#include "hurricane/isobar/PyHorizontal.h"
+#include "hurricane/isobar/PyVertical.h"
+#include "hurricane/isobar/PyContact.h"
+
+namespace Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+#if defined(__PYTHON_MODULE__)
+
+#define  METHOD_HEAD(function)   GENERIC_METHOD_HEAD(Entity,entity,function)
+
+    DBoDestroyAttribute(PyEntity_destroy ,PyEntity)
+
+    static PyObject* PyEntity_getCell ( PyEntity *self )
+    {
+      Cell* cell = NULL;
+      HTRY
+        METHOD_HEAD( "Entity.getCell()" )
+        cell = entity->getCell();
+      HCATCH
+      return PyCell_Link( cell );
+    }
+
+    PyMethodDef PyEntity_Methods[] =
+      { { "getCell", (PyCFunction)PyEntity_getCell, METH_NOARGS
+                   , "Returns the entity cell." }
+      , { "destroy", (PyCFunction)PyEntity_destroy, METH_NOARGS
+                   , "Destroy associated hurricane object, the python object remains." }
+      , {NULL, NULL, 0, NULL}  /* sentinel */
+      };
+
+
+    DBoDeleteMethod(Entity)
+    PyTypeObjectLinkPyType(Entity)
+
+#else  // End of Python Module Code Part.
+
+    PyObject* PyEntity_NEW ( Entity* entity )
+    {
+      if (not entity) {
+        PyErr_SetString ( HurricaneError, "Invalid Entity (bad occurrence)" );
+        return NULL;
+      }
+
+      Horizontal* horizontal = dynamic_cast<Horizontal*>(entity);
+      if (horizontal) return PyHorizontal_Link( horizontal );
+
+      Vertical* vertical = dynamic_cast<Vertical*>(entity);
+      if (vertical) return PyVertical_Link( vertical );
+
+      Contact* contact = dynamic_cast<Contact*>(entity);
+      if (contact) return PyContact_Link( contact );
+
+      Py_RETURN_NONE;
+    }
+
+    PyTypeRootObjectDefinitions(Entity)
+
+#endif  // Shared Library Code Part (1).
+
+}  // extern "C".
+
+
+#if !defined(__PYTHON_MODULE__)
+
+Hurricane::Entity* EntityCast ( PyObject* derivedObject ) {
+  if (IsPyHorizontal(derivedObject)) return PYHORIZONTAL_O(derivedObject);
+  if (IsPyVertical  (derivedObject)) return PYVERTICAL_O(derivedObject);
+  if (IsPyContact   (derivedObject)) return PYCONTACT_O(derivedObject);
+  return NULL;
+}
+
+#endif  // Shared Library Code Part (2).
+
+}  // Isobar namespace.
+
+
+

+
+
+

4.3 Intermediate Class Header

+

Changes from 3.1 Class Associated Header File are:

+
    +
  1. As for PyEntity, and because this is still an abstract class, +there is no PyComponent_Link() function.
    2. +
  2. The definition of the PyComponent struct is differs. There is +no PyObject_HEAD (it is a Python derived class). The only +field is of the base class type PyEntity and for use with +Coriolis macros, it must be named _baseObject (note that +this is not a pointer but a whole object).
    3. +
+
#ifndef ISOBAR_PY_COMPONENT_H
+#define ISOBAR_PY_COMPONENT_H
+
+#include "hurricane/isobar/PyEntity.h"
+#include "hurricane/Component.h"
+
+namespace  Isobar {
+  extern "C" {
+
+    typedef struct {
+        PyEntity  _baseObject;
+    } PyComponent;
+
+    extern  PyTypeObject  PyTypeComponent;
+    extern  PyMethodDef   PyComponent_Methods[];
+    extern  void          PyComponent_LinkPyType ();
+
+#define IsPyComponent(v) ((v)->ob_type == &PyTypeComponent)
+#define PYCOMPONENT(v)   ((PyComponent*)(v))
+#define PYCOMPONENT_O(v) (static_cast<Component*>(PYCOMPONENT(v)->_baseObject._object))
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+#endif
+
+
+
+
+

4.4 Intermediate Class File

+

Changes from 3.2 Class Associated File are:

+
    +
  1. Redefinition of the default macros ACCESS_OBJECT and ACCESS_CLASS.
      +
    • The pointer to the C++ encapsulated object (attribute _object) is hold +by the base class PyEntity. The ACCESS_OBJECT macro which is tasked +to give access to that attribute is then _baseObject._object as +PyComponent is a direct derived class of PyEntity.
      • +
    • ACCESS_CLASS is similar to ACCESS_OBJECT for accessing the base +class, that is a pointer to PyEntity.
      • +
    +
    2. +
+

+
    +
  1. For defining the PyTypeComponent Python type, we call a yet different +macro: PyTypeInheritedObjectDefinitions(), dedicated to derived classes. +For this this macro we need to give as argument the derived class and the +base class.
    2. +
+
#include "hurricane/isobar/PyComponent.h"
+#include "hurricane/isobar/PyNet.h"
+
+namespace  Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+#undef   ACCESS_OBJECT
+#undef   ACCESS_CLASS
+#define  ACCESS_OBJECT           _baseObject._object
+#define  ACCESS_CLASS(_pyObject)  &(_pyObject->_baseObject)
+#define  METHOD_HEAD(function)   GENERIC_METHOD_HEAD(Component,component,function)
+
+#if defined(__PYTHON_MODULE__)
+
+    DirectGetLongAttribute(PyComponent_getX,getX,PyComponent,Component)
+    DirectGetLongAttribute(PyComponent_getY,getY,PyComponent,Component)
+    DBoDestroyAttribute(PyComponent_destroy,PyComponent)
+
+    static PyObject* PyComponent_getNet ( PyComponent *self )
+    {
+      Net* net = NULL;
+      HTRY
+        METHOD_HEAD( "Component.getNet()" )
+        net = component->getNet( );
+      HCATCH
+      return PyNet_Link( net );
+    }
+
+    PyMethodDef PyComponent_Methods[] =
+      { { "getX"   , (PyCFunction)PyComponent_getX   , METH_NOARGS
+                   , "Return the Component X value." }
+      , { "getY"   , (PyCFunction)PyComponent_getY   , METH_NOARGS
+                   , "Return the Component Y value." }
+      , { "getNet" , (PyCFunction)PyComponent_getNet , METH_NOARGS
+                   , "Returns the net owning the component." }
+      , { "destroy", (PyCFunction)PyComponent_destroy, METH_NOARGS
+                   , "destroy associated hurricane object, the python object remains." }
+      , {NULL, NULL, 0, NULL}    /* sentinel */
+      };
+
+    DBoDeleteMethod(Component)
+    PyTypeObjectLinkPyType(Component)
+
+#else  // Python Module Code Part.
+
+    PyTypeInheritedObjectDefinitions(Component, Entity)
+
+#endif  // Shared Library Code Part.
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+
+
+
+

4.5 Terminal Class Header

+

The contents of this file is almost identical to 4.3 Intermediate Class Header, +save for the presence of a PyContact_Link() function. She is present +at this level because the class is a concrete one and can be instanciated.

+
#ifndef ISOBAR_PY_CONTACT_H
+#define ISOBAR_PY_CONTACT_H
+
+#include "hurricane/isobar/PyComponent.h"
+#include "hurricane/Contact.h"
+
+namespace  Isobar {
+  extern "C" {
+
+    typedef struct {
+      PyComponent _baseObject;
+    } PyContact;
+
+    extern PyTypeObject  PyTypeContact;
+    extern PyMethodDef   PyContact_Methods[];
+    extern PyObject*     PyContact_Link       ( Hurricane::Contact* object );
+    extern void          PyContact_LinkPyType ();
+
+#define IsPyContact(v)    ( (v)->ob_type == &PyTypeContact )
+#define PYCONTACT(v)      ( (PyContact*)(v) )
+#define PYCONTACT_O(v)    ( PYCONTACT(v)->_baseObject._baseObject._object )
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+#endif  // ISOBAR_PY_CONTACT_H
+
+
+
+
+

4.6 Terminal Class File

+

Changes from 4.4 Intermediate Class File are:

+
    +
  1. As previously, we have to redefine the macros ACCESS_OBJECT and ACCESS_CLASS. +But, as we are one level deeper into the hierarchy, one more level of +indirection using _baseObject must be used.
      +
    • ACCESS_OBJECT becomes _baseObject._baseObject._object.
      • +
    • ACCESS_CLASS becomes &(_pyObject->_baseObject._baseObject).
      • +
    +
    2. +
  2. For defining the PyTypeContact Python type, we call again +PyTypeInheritedObjectDefinitions(). It is the same whether the class is +terminal or not.
    3. +
  3. And, this time, as the Python class is concrete, we call the macro +DBoLinkCreateMethod() to create the PyContact_Link() function.
    4. +
+
#include "hurricane/isobar/PyContact.h"
+
+namespace  Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+#undef  ACCESS_OBJECT
+#undef  ACCESS_CLASS
+#define ACCESS_OBJECT           _baseObject._baseObject._object
+#define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject._baseObject)
+#define METHOD_HEAD(function)   GENERIC_METHOD_HEAD(Contact,contact,function)
+
+#if defined(__PYTHON_MODULE__)
+
+    DirectGetLongAttribute(PyContact_getWidth , getWidth , PyContact,Contact)
+    DirectGetLongAttribute(PyContact_getHeight, getHeight, PyContact,Contact)
+    DBoDestroyAttribute(PyContact_destroy, PyContact)
+
+    static PyObject* PyContact_create ( PyObject*, PyObject *args )
+    {
+      Contact* contact = NULL;
+      HTRY
+        // Usual signature then arguments parsing.
+      HCATCH
+      return PyContact_Link(contact);
+    }
+
+    PyMethodDef PyContact_Methods[] =
+      { { "create"   , (PyCFunction)PyContact_create   , METH_VARARGS|METH_STATIC
+                     , "Create a new Contact." }
+      , { "destroy"  , (PyCFunction)PyContact_destroy  , METH_NOARGS
+                     , "Destroy associated hurricane object, the python object remains." }
+      , { "getWidth" , (PyCFunction)PyContact_getWidth , METH_NOARGS
+                     , "Return the contact width." }
+      , { "getHeight", (PyCFunction)PyContact_getHeight, METH_NOARGS
+                     , "Return the contact height." }
+      , {NULL, NULL, 0, NULL}  /* sentinel */
+      };
+
+    DBoDeleteMethod(Contact)
+    PyTypeObjectLinkPyType(Contact)
+
+#else  // Python Module Code Part.
+
+    DBoLinkCreateMethod(Contact)
+    PyTypeInheritedObjectDefinitions(Contact, Component)
+
+#endif  // Shared Library Code Part.
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+
+
+
+

4.8 Python Module

+
DL_EXPORT(void) initHurricane ()
+{
+  PyEntity_LinkPyType();  // step 1.
+  PyComponent_LinkPyType();
+  PyContact_LinkPyType();
+
+  PYTYPE_READY( Entity )  // step 2.
+  PYTYPE_READY_SUB( Component, Entity )
+  PYTYPE_READY_SUB( Contact  , Component )
+
+  __cs.addType( "ent"    , &PyTypeEntity   , "<Entity>"   , false ); // step 3.
+  __cs.addType( "comp"   , &PyTypeComponent, "<Component>", false, "ent"  );
+  __cs.addType( "contact", &PyTypeContact  , "<Contact>"  , false, "comp" );
+
+  PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods );
+  if (module == NULL) {
+    cerr << "[ERROR]\n"
+         << "  Failed to initialize Hurricane module." << endl;
+    return;
+  }
+
+  Py_INCREF( &PyTypeContact );                                        // step 4.
+  PyModule_AddObject( module, "Contact", (PyObject*)&PyTypeContact ); // step 4.
+}
+
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/DBoStandalone.html b/documentation/_build/html/PythonCpp/DBoStandalone.html new file mode 100644 index 00000000..a0c8b805 --- /dev/null +++ b/documentation/_build/html/PythonCpp/DBoStandalone.html @@ -0,0 +1,671 @@ + + + + + + + + + + + + 3. Case 1 - DBo Derived, Standalone — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

3. Case 1 - DBo Derived, Standalone

+

As example, we take Library. This a DBo derived class, but we +choose not to export the parent classes. From Python, it will appear +as a base class.

+
+

3.1 Class Associated Header File

+

Here is the typical content of a header file (for PyLibrary):

+
#ifndef  PY_LIBRARY_H
+#define  PY_LIBRARY_H
+
+#include "hurricane/isobar/PyHurricane.h"
+#include "hurricane/Library.h"
+
+namespace  Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+    typedef struct {
+        PyObject_HEAD
+        Library* _object;
+    } PyLibrary;
+
+    extern  PyTypeObject  PyTypeLibrary;
+    extern  PyMethodDef   PyLibrary_Methods[];
+    extern  PyObject*     PyLibrary_Link       ( Hurricane::Library* lib );
+    extern  void          PyLibrary_LinkPyType ();
+
+
+#define IsPyLibrary(v) ( (v)->ob_type == &PyTypeLibrary )
+#define PYLIBRARY(v)   ( (PyLibrary*)(v) )
+#define PYLIBRARY_O(v) ( PYLIBRARY(v)->_object )
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+#endif  // PY_LIBRARY_H
+
+
+

The code is organized as follow:

+
    +

  1. It must have, as the first include PyHurricane.h, which provides +the complete bunch of macros needed to build the module. Then the include +of the C++ class we want to wrap (Library.h).

    +
    2. +

  2. As Python is written in C, all the wrapper code has to be but inside +an extern "C" namespace.

    +
    3. +

  3. Definition of the wrapped struct, PyLibrary. It is standard Python here.

    +
    +

    Note

    +

    For our set of macros to work, the name of the pointer to the +C++ class must always be _object, and the various functions and +macros defined here must take the name of the class (either in +lowercase, camel case or capitals).

    +
    +
    4. +

  4. Declaration of the Python type PyTypeLibrary (standard).

    +
    5. +

  5. Declaration of the Python type table of methods PyLibrary_Methods (standard).

    +
    6. +
+
    +
  1. Declaration of PyLibrary_Link(), helper to convert a C++ Lybrary into +a PyLibrary (put in the support shared library).
    2. +
  2. Declaration of PyLibrary_LinkPyType(), this function setup the class-level +function of the new Python type (here, PyTypeLibrary).
    3. +
  3. And, lastly, three macros to:
      +
    • IsPylibrary(), know if a Python object is a PyLibrary
      • +
    • PYLIBRARY(), force cast (C style) of a PyObject into a PyLibrary.
      • +
    • PYLIBRARY_O(), extract the C++ object (Library*) from the Python +object (PyLibrary).
      • +
    +
    4. +
+
+
+

3.2 Class Associated File

+
+

3.2.1 Head of the file

+
#include "hurricane/isobar/PyLibrary.h"
+#include "hurricane/isobar/PyDataBase.h"
+#include "hurricane/isobar/PyCell.h"
+
+namespace Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+#define  METHOD_HEAD(function)   GENERIC_METHOD_HEAD(Library,lib,function)
+
+
+

As for the header, all the code must be put inside a extern "C" namespace.

+

A convenience macro METHOD_HEAD() must be defined, by refining +GENERIC_METHOD_HEAD(). This macro will be used in the method wrappers +below to cast the _object field of the Python object into the +appropriate C++ class, this is done using a C-style cast. +The parameters of that macro are:

+
    +
  1. The C++ encapsulated class (Library).
    2. +
  2. The name of the variable that will be used to store a pointer +to the C++ working object.
    3. +
  3. The name of the C++ method which is to be wrapped.
    4. +
+
+
+

3.2.2 The Python Module Part

+

First, we have to build all the wrappers to the C++ methods of +the class. For common predicates, accessors, and mutators macros +are supplied.

+

Wrapping of the Library::getCell() method:

+
static PyObject* PyLibrary_getCell ( PyLibrary* self, PyObject* args )
+{
+  Cell* cell = NULL;
+
+  HTRY
+    METHOD_HEAD( "Library.getCell()" )
+    char* name = NULL;
+    if (PyArg_ParseTuple(args,"s:Library.getCell", &name)) {
+      cell = lib->getCell( Name(name) );
+    } else {
+      PyErr_SetString( ConstructorError
+                     , "invalid number of parameters for Library::getCell." );
+      return NULL;
+    }
+  HCATCH
+
+  return PyCell_Link(cell);
+}
+
+
+

Key points about this method wrapper:

+
    +
  1. The HTRY / HCATCH macros provides an insulation from the C++ +exceptions. If one is emitted, it will be catched and transformed in +a Python one. This way, the Python program will be cleanly interrupted +and the usual stack trace displayed.
    2. +
  2. The returned value of this method is of type Cell*, we have to +transform it into a Python one. This is done with PyCell_Link(). +This macro is supplied by the PyCell.h header and this is why +it must be included.
    3. +
+

+

Wrapping of the Library::create() method:

+
static PyObject* PyLibrary_create( PyObject*, PyObject* args )
+{
+  PyObject* arg0;
+  PyObject* arg1;
+  Library* library = NULL;
+
+  HTRY
+    __cs.init( "Library.create" );                          // Step (1).
+    if (not PyArg_ParseTuple( args, "O&O&:Library.create"
+                            , Converter, &arg0
+                            , Converter, &arg1 )) {         // Step (2).
+      PyErr_SetString( ConstructorError
+                     , "invalid number of parameters for Library constructor." );
+      return NULL;
+    }
+    if (__cs.getObjectIds() == ":db:string") {              // Step (3.a)
+      DataBase* db = PYDATABASE_O(arg0);
+      library = Library::create( db, Name(PyString_AsString(arg1)) );
+    } else if (__cs.getObjectIds() == ":library:string") {  // Step (3.b)
+      Library* masterLibrary = PYLIBRARY_O(arg0);
+      library = Library::create( masterLibrary, Name(PyString_AsString(arg1)) );
+    } else {
+      PyErr_SetString( ConstructorError
+                     , "invalid number of parameters for Library constructor." );
+      return NULL;
+    }
+  HCATCH
+
+  return PyLibrary_Link( library );
+}
+
+
+

Key point about this constructor:

+
    +
  1. We want the Python interface to mimic as closely as possible the +C++ API. As such, Python object will be created using a static +.create() method. So we do not use the usual Python allocation +mechanism.
    2. +
  2. As it is a static method, there is no first argument.
    3. +
  3. Python do not allow function overload like C++. To emulate that +behavior we use the __cs object (which is a global variable).
      +
    1. Init/reset the __cs object: see step (1).
      2. +
    2. Call PyArg_ParseTuple(), read every mandatory or optional +argument as a Python object ("O&") and use Converter +on each one. Converter will determine the real type of +the Python object given as argument by looking at the +encapsulated C++ class. It then update the __cs object. +Done in step (2)
      3. +
    3. After the call to PyArg_ParseTuple(), the function +__cs.getObjectIds() will return the signature of +the various arguments. In our case, the valid signatures +will be ":db:string" (step (3.a)*a) and ``”:library:string”`` +(*step (3.b)).
      4. +
    4. Call the C++ method after extracting the C++ objects from +the Python arguments. Note the use of the PYLIBRARY_O() +and PYDATABSE_O() macros to perform the conversion.
      5. +
    +
    4. +
  4. Return the result, encapsulated through a call to PyLibrary_Link().
    5. +
+

+

Wrapping of the Library::destroy() method:

+
DBoDestroyAttribute(PyLibrary_destroy, PyLibrary)
+
+
+

For C++ classes that are derived from DBo, the destroy method +wrapper must be defined using the macro DBoDestroyAttribute(). +This macro implements the bi-directional communication mechanism +using Hurricane::Property. It must not be used for +non DBo derived classes.

+

Defining the method table of the PyLibrary type:

+
PyMethodDef PyLibrary_Methods[] =
+  { { "create"    , (PyCFunction)PyLibrary_create , METH_VARARGS|METH_STATIC
+                  , "Creates a new library." }
+  , { "getCell"   , (PyCFunction)PyLibrary_getCell, METH_VARARGS
+                  , "Get the cell of name <name>" }
+  , { "destroy"   , (PyCFunction)PyLibrary_destroy, METH_NOARGS
+                  , "Destroy associated hurricane object The python object remains." }
+  , {NULL, NULL, 0, NULL}           /* sentinel */
+  };
+
+
+

This is standard Python/C API. The name of the PyMethodDef table must be +named from the class: PyLibrary_Methods.

+
+
+

3.2.3 Python Type Linking

+

Defining the PyTypeLibrary class methods and the type linking function.

+

Those are the functions for the Python object itself to work, not the +wrapped method from the C++ class.

+
+

Note

+

At this point we do not define the PyTypeLibrary itself. +Only it’s functions and a function to set them up once the +type will be defined.

+
+
DBoDeleteMethod(Library)
+PyTypeObjectLinkPyType(Library)
+
+
+

The macro DBoDeleteMethod() define the function to delete a +PyLibrary Python object. Again, do not mistake it for the deletion +of the C++ class (implemented by DBoDestroyAttribute()). +Here again, DBoDeleteMethod() is specially tailored for +DBo derived classes.

+

To define PyLibrary_LinkPyType(), use the PyTypeObjectLinkPyType() +macro. This macro is specific for DBo derived classes that are seen as +base classes under Python (i.e. we don’t bother exposing the base +class under Python). PyLibrary_LinkPyType() setup the class functions +in the PyTypeLibrary type object, it must be called in the +Python module this class is part of (in this case: PyHurricane.cpp). +This particular flavor of the macro will define and setup the +following class functions:

+
    +
  • PyTypeLibrary.tp_compare (defined by the macro).
    • +
  • PyTypeLibrary.tp_repr (defined by the macro).
    • +
  • PyTypeLibrary.tp_str (defined by the macro).
    • +
  • PyTypeLibrary.tp_hash (defined by the macro).
    • +
  • PyTypeLibrary.tp_methods sets to the previously defined PyLibrary_Methods table.
    • +
  • PyTypeLibrary.tp_dealloc is set to a function that must be named PyLibrary_DeAlloc, +this is what DBoDeleteMethod does. It is not done by PyTypeObjectLinkPyType.
    • +
+

Defining the PyTypeLibrary type:

+
+
+

3.2.4 The Shared Library Part

+

This part will be put in a separate supporting shared library, allowing +other Python module to link against it (and make use of its symbols).

+
DBoLinkCreateMethod(Library)
+PyTypeObjectDefinitions(Library)
+
+
+

To define PyTypeLibrary, use the PyTypeObjectDefinitions() macro. +This macro is specific for classes that, as exposed by Python, +are neither derived classes nor base classes for others. +That is, they are standalone from the inheritance point of view.

+

The DBoLinkCreateMethod() macro will define the PyLibrary_Link() +function which is responsible for encapsulating a C++ Library object +into a Python PyLibrary one.

+
+
+
+

3.3 Python Module (C++ namespace)

+

We use the Python module to replicate the C++ namespace. Thus, for the +Hurricane namespace we create a Python Hurricane module which is +defined in the PyHurricane.cpp file, then we add into that module +dictionary all the Python types encapsulating the C++ classes of that +namespace.

+
DL_EXPORT(void) initHurricane ()
+{
+  PyLibrary_LinkPyType();  // step 1.
+
+  PYTYPE_READY( Library )  // step 2.
+
+  __cs.addType( "library", &PyTypeLibrary, "<Library>", false ); // step 3.
+
+  PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods );
+  if (module == NULL) {
+    cerr << "[ERROR]\n"
+         << "  Failed to initialize Hurricane module." << endl;
+    return;
+  }
+
+  Py_INCREF( &PyTypeLibrary );                                        // step 4.
+  PyModule_AddObject( module, "Library", (PyObject*)&PyTypeLibrary ); // step 4.
+}
+
+
+

The initHurricane() initialisation function shown above has +been scrubbed of everything not relevant to the PyLibrary class. +The integration of the PyLibrary class into the module needs +four steps:

+
    +

  1. A call to PyLibrary_LinkPyType() to hook the Python type functions +in the Python type object.

    +
    2. +

  2. A call to the PYTYPE_READY() macro (standard Python).

    +
    3. +

  3. Registering the type into the __cs object, with addType(). +The arguments are self explanatory, save for the last which is a +boolean to tell if this is a derived class or not.

    +
    4. +

  4. Adding the type object (PyTypeLibrary) into the dictionnary of +the module itself. This allow to mimic closely the C++ syntax:

    +
    import Hurricane
+lib = Hurricane.Library.create( db, 'root' )
+
    +
    +
    5. +
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/DbU.html b/documentation/_build/html/PythonCpp/DbU.html new file mode 100644 index 00000000..287a2aa6 --- /dev/null +++ b/documentation/_build/html/PythonCpp/DbU.html @@ -0,0 +1,385 @@ + + + + + + + + + + + + 6. Encapsulating DbU — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

6. Encapsulating DbU

+

While Hurricane::DbU is a class, the Hurricane::DbU::Unit is only +a typedef over uint64_t. The DbU class only provides a set of +static methods to manipulate and convert to and from other units. +At Python level, DbU::Unit will be stored in plain long long.

+

When a DbU::Unit argument is expected in a Python functions, just use +the DbU::Unit  PyAny_AsLong( PyObject* ) function to convert it.

+

For example, if we explicit the expension of:

+
DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point)
+
+
+

+

We would get:

+
static PyObject* PyPoint_setX ( PyPoint *self, PyObject* args )
+{
+  Point* cobject = static_cast<Point*>( self->_object );
+  if (cobject == NULL) {
+    PyErr_SetString( ProxyError
+                   , "Attempt to call Point.setX() on an unbound Hurricane object" );
+    return NULL;
+  }
+
+  HTRY
+    PyObject* arg0 = NULL;
+    if (not PyArg_ParseTuple( args, "O:Point.setX()", &arg0 ))
+      return ( NULL );
+    cobject->setX( Isobar::PyAny_AsLong(arg0) );
+  HCATCH
+  Py_RETURN_NONE;
+}
+
+
+

For the other way around, use PyObject* PyDbU_FromLong( DbU::Unit ).

+
DirectGetLongAttribute(PyPoint_GetX,getX,PyPoint,Point)
+
+
+

We would get:

+
static PyObject* PyPoint_GetX ( PyPoint *self, PyObject* args )
+{
+  Point* cobject = static_cast<Point*>( self->_object );
+  if (cobject == NULL) {
+    PyErr_SetString( ProxyError
+                   , "Attempt to call Point.getX() on an unbound Hurricane object" );
+    return NULL;
+  }
+  return Isobar::PyDbU_FromLong(cobject->getX());
+}
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/Introduction.html b/documentation/_build/html/PythonCpp/Introduction.html new file mode 100644 index 00000000..b958c37b --- /dev/null +++ b/documentation/_build/html/PythonCpp/Introduction.html @@ -0,0 +1,499 @@ + + + + + + + + + + + + 1. Introduction — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

1. Introduction

+
    +
  • This document is written for people already familiar with the +Python/C API Reference Manual.
    • +
  • The macros provided by the Hurricane Python/C API are written using +the standard Python C/API. That is, you may not use them and write +directly your functions with the original API or any mix between. +You only have to respect some naming convention.
    • +
  • Coriolis is build against Python 2.7.
    • +
+
+

1.1 First, A Disclaimer

+

The Hurricane Python/C++ API has been written about ten years ago, at a time +my mastering of template programming was less than complete. This is why this +interface is build with old fashioned C macro instead of C++ template.

+

It is my hope that at some point in the future I will have time to completly +rewrite it, borrowing the interface from boost::python.

+
+
+

1.2 About Technical Choices

+

Some would say, why not use off the shelf wrappers like swig +or boost::python, here are some clues.

+
    +

  1. Partial exposure of the C++ class tree. We expose at Python level +C++ base classes, only if they provides common methods that we want +to see. Otherwise, we just show them as base classes under Python. +For instance Library is derived from DBo, but we won’t see +it under Python.

    +
    2. +

  2. Bi-directional communication. When a Python object is deleted, the +wrapper obviously has a pointer toward the underlying C++ object and +is able to delete it. But, the reverse case can occurs, meaning that +you have a C++ object wrapped in Python and the database delete the +underlying object. The wrapped Python object must be informed that +it no longer refer a valid C++ one. Moreover, as we do not control +when Python objects gets deleteds (that is, when their reference count +reaches zero), we can have valid Python object with a dangling +C++ pointer. So our Python objects can be warned by the C++ objects +that they are no longer valid and any other operation than the +deletion should result in a severe non-blocking error.

    +

    To be precise, this apply to persistent object in the C++ database, +like Cell, Net, Instance or Component. Short lived +objects like Box or Point retains the classic Python behavior.

    +

    Another aspect is that, for all derived DBo objects, one and only +one Python object is associated. For one given Instance object we +will always return the same PyInstance object, thanks to the +bi-directional link. Obviously, the reference count of the +PyInstance is managed accordingly. This mechanism is implemented +by the PyInstance_Link() function.

    +
    3. +

  3. Linking accross modules. As far as I understand, the wrappers +are for monolithic libraries. That is, you wrap the entire library +in one go. But Hurricane has a modular design, the core database +then various tools. We do not, and cannot, have one gigantic wrapper +that would encompass all the libraries in one go. We do one Python +module for one C++ library.

    +

    This brings another issue, at Python level this time. The Python +modules for the libraries have to share some functions. Python +provides a mechanism to pass C function pointers accross modules, +but I did found it cumbersome. Instead, all our modules are split +in two:

    +
      +
    • The first part contains the classic Python module code.
      • +
    • The second part is to be put in a separate dynamic library that +will hold the shared functions. The Python module is dynamically linked +against that library like any other. And any other Python module +requiring the functions will link against the associated shared +library.
      • +
    +

    Each module file will be compiled twice, once to build the Python +module (__PYTHON_MODULE is defined) and once to build the supporting +shared library (__PYTHON_MODULE__ not defined). This tricky +double compilation is taken care of though the add_python_module +cmake macro.

    +

    For the core Hurricane library we will have:

    +
      +
    • Hurricane.so the Python module (use with: import Hurricane).
      • +
    • libisobar.so.1.0 the supporting shared library.
      • +
    +

    The PyLibrary.cpp file will have the following structure:

    +
    #include "hurricane/isobar/PyLibrary.h"
+
+namespace  Isobar {
+
+  extern "C" {
+
+#if defined(__PYTHON_MODULE__)
+
+  // +=================================================================+
+  // |               "PyLibrary" Python Module Code Part               |
+  // +=================================================================+
+  //
+  // The classic part of a Python module. Goes into Hurricane.so.
+
+
+#else  // End of Python Module Code Part.
+
+  // x=================================================================x
+  // |              "PyLibrary" Shared Library Code Part               |
+  // x=================================================================x
+  //
+  // Functions here will be part of the associated shared library and
+  // made available to all other Python modules. Goes into libisobar.so.1.0
+
+
+# endif  // Shared Library Code Part.
+
+  }  // extern "C".
+
+}  // Isobar namespace.
+
    +
    +

    This way, we do not rely upon a pointer transmission through Python +modules, but directly uses linker capabilities.

    +
    4. +
+
+
+

1.3 Botched Design

+

The mechanism to compute the signature of a call to a Python function, +the __cs object, is much too complex and, in fact, not needed. +At some point I may root it out, but it is used in so many places...

+

What I should have used the "O!" capablity of PyArg_ParseTuple(), +like in the code below:

+

+
static PyObject* PyContact_create ( PyObject*, PyObject *args )
+{
+  Contact* contact = NULL;
+  HTRY
+    PyNet*       pyNet       = NULL;
+    PyLayer*     pyLayer     = NULL;
+    PyComponent* pyComponent = NULL;
+    DbU::Unit    x           = 0;
+    DbU::Unit    y           = 0;
+    DbU::Unit    width       = 0;
+    DbU::Unit    height      = 0;
+
+    if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create"
+                        , &PyTypeNet  , &pyNet
+                        , &PyTypeLayer, &pyLayer
+                        , &x, &y, &width, &height)) {
+      contact = Contact::create( PYNET_O(pyNet), PYLAYER_O(pyLayer)
+                               , x, y, width, height );
+    } else {
+      PyErr_Clear();
+      if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create"
+                          , &PyTypeComponent, &pyComponent
+                          , &PyTypeLayer    , &pyLayer
+                          , &x, &y, &width, &height)) {
+        contact = Contact::create( PYCOMPONENT_O(pyComponent), PYLAYER_O(pyLayer)
+                                 , x, y, width, height );
+      } else {
+        PyErr_SetString( ConstructorError
+                       , "invalid number of parameters for Contact constructor." );
+        return NULL;
+      }
+    }
+  HCATCH
+  return PyContact_Link( contact );
+}
+
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/Name.html b/documentation/_build/html/PythonCpp/Name.html new file mode 100644 index 00000000..c55d3ed2 --- /dev/null +++ b/documentation/_build/html/PythonCpp/Name.html @@ -0,0 +1,338 @@ + + + + + + + + + + + + 7. No C++ Hurricane::Name encapsulation — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

7. No C++ Hurricane::Name encapsulation

+

To be written.

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/NonDBo.html b/documentation/_build/html/PythonCpp/NonDBo.html new file mode 100644 index 00000000..8178a1d3 --- /dev/null +++ b/documentation/_build/html/PythonCpp/NonDBo.html @@ -0,0 +1,488 @@ + + + + + + + + + + + + 5. Case 3 - Non-DBo Standalone Classe — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

5. Case 3 - Non-DBo Standalone Classe

+

Let’s have a look at the encapsulation of Hurricane::Point.

+

Non-BDo derived classes do not support the bi-directionnal communication. +So each Python object is associated with one C++ object. The C++ object +is created and deleted along with the Python one. This behavior implies +that the C++ object is copy constructible (which should be the case).

+
+

5.1 Class Header

+

Changes from 3.1 Class Associated Header File:

+
    +
  • There is no PyPoint_Link() function, as it’s related to the +bi-directional communication mechanism.
    • +
+
+

Note

+

About the _object attribute of the PyPoint. As the C++ object life span +(Point) is linked to the Python (PyPoint) one, we may have used a +value instead of a pointer. It is best to keep a pointer as the macros +written for DBo derived classes will remain usables.

+
+
#ifndef ISOBAR_PY_POINT_H
+#define ISOBAR_PY_POINT_H
+
+#include "hurricane/isobar/PyHurricane.h"
+#include "hurricane/Point.h"
+
+namespace  Isobar {
+  extern "C" {
+
+    typedef struct {
+        PyObject_HEAD
+        Hurricane::Point* _object;
+    } PyPoint;
+
+    extern  PyTypeObject  PyTypePoint;
+    extern  PyMethodDef   PyPoint_Methods[];
+    extern  void          PyPoint_LinkPyType();
+
+#define IsPyPoint(v)    ( (v)->ob_type == &PyTypePoint )
+#define PYPOINT(v)      ( (PyPoint*)(v) )
+#define PYPOINT_O(v)    ( PYPOINT(v)->_object )
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+#endif  // ISOBAR_PY_POINT_H
+
+
+

+
+
+

5.2 Class File

+

Changes from 3.2 Class Associated File:

+
    +
  • As there is no PyPoint_Link() function, there is no call to any +flavor of the DBoLinkcreatemethod() macro (obvious as it’s not +a DBo).
    • +
  • To use the standard Python constructor, we have to define PyPoint_NEW() +and PyPoint_Init() functions, I’m not absolutely certain that the later +needs to be defined (that part is still not clear to me from the Python doc).
    • +
  • As it’s not a DBo there is no destroy() method, so no call to +DirectDestroyMethod()
    • +
  • Lastly, as this object has a PyPoint_NEW() (field tp_new) and +a PyPoint_Init() (field tp_init) we have to use the macro +PyTypeObjectLinkPyTypeNewInit() to define PyPoint_LinkPyType().
    • +
+
#include "hurricane/isobar/PyPoint.h"
+
+namespace Isobar {
+  using namespace Hurricane;
+
+  extern "C" {
+
+#define METHOD_HEAD(function)   GENERIC_METHOD_HEAD(Point,point,function)
+
+#if defined(__PYTHON_MODULE__)
+
+    static PyObject* PyPoint_NEW ( PyObject* module, PyObject *args )
+    {
+      Point* point = NULL;
+      HTRY
+        PyObject* arg0 = NULL;
+        PyObject* arg1 = NULL;
+
+        __cs.init( "Point.Point" );
+        if (not PyArg_ParseTuple( args,"|O&O&:Point.Point"
+                                , Converter,&arg0
+                                , Converter,&arg1 )) {
+          PyErr_SetString ( ConstructorError
+                          , "invalid number of parameters for Point constructor." );
+          return NULL;
+        }
+
+        if      (__cs.getObjectIds() == "")
+                { point = new Point()); }
+        else if (__cs.getObjectIds() == ":point")
+                { point = new Point( *PYPOINT_O(arg0) ); }
+        else if (__cs.getObjectIds() == ":int:int")
+                { point = new Point( PyAny_AsLong(arg0), PyAny_AsLong(arg1) ); }
+        else {
+          PyErr_SetString ( ConstructorError
+                          , "invalid number of parameters for Point constructor." );
+          return NULL;
+        }
+
+        PyPoint* pyPoint = PyObject_NEW( PyPoint, &PyTypePoint );
+        if (pyPoint == NULL) { delete point; return NULL; }
+        pyPoint->_object = point;
+      HCATCH
+
+      return (PyObject*)pyPoint;
+    }
+
+    static int  PyPoint_Init ( PyPoint* self, PyObject* args, PyObject* kwargs )
+    { return 0; }
+
+    DirectGetLongAttribute(PyPoint_getX,getX,PyPoint,Point)
+    DirectGetLongAttribute(PyPoint_getY,getY,PyPoint,Point)
+    DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point)
+    DirectSetLongAttribute(PyPoint_SetY,setY,PyPoint,Point)
+
+    PyMethodDef PyPoint_Methods[] =
+      { { "getX"   , (PyCFunction)PyPoint_getX     , METH_NOARGS
+                   , "Return the Point X value." }
+      , { "getY"   , (PyCFunction)PyPoint_getY     , METH_NOARGS
+                   , "Return the Point Y value." }
+      , { "setX"   , (PyCFunction)PyPoint_SetX     , METH_VARARGS
+                   , "Modify the Point X value." }
+      , { "setY"   , (PyCFunction)PyPoint_SetY     , METH_VARARGS
+                   , "Modify the Point Y value." }
+      , {NULL, NULL, 0, NULL}  /* sentinel */
+      };
+
+    DirectDeleteMethod(PyPoint_DeAlloc,PyPoint)
+    PyTypeObjectLinkPyTypeNewInit(Point)
+
+#else  // Python Module Code Part.
+
+    PyTypeObjectDefinitions(Point)
+
+#endif  // Shared Library Code Part.
+
+  }  // extern "C".
+}  // Isobar namespace.
+
+
+
+
+

5.2 Class File

+

To put it bluntly, there is no difference in the Python module for +a standalone DBo class and a non-DBo class.

+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/PythonCpp/index.html b/documentation/_build/html/PythonCpp/index.html new file mode 100644 index 00000000..2b1e97c5 --- /dev/null +++ b/documentation/_build/html/PythonCpp/index.html @@ -0,0 +1,370 @@ + + + + + + + + + + + + Hurricane Python/C++ API Tutorial — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Hurricane Python/C++ API Tutorial
    • +
  • + + + +
    • +
+
+
+
+ + + + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/RDS/RDSpage.html b/documentation/_build/html/RDS/RDSpage.html new file mode 100644 index 00000000..7c703879 --- /dev/null +++ b/documentation/_build/html/RDS/RDSpage.html @@ -0,0 +1,786 @@ + + + + + + + + + + + + Symbolic Layout — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +

+
+

Symbolic Layout

+
+

Symbolic Components

+

A symbolic layout is, in practice, made of only of three objects:

+ +++++ + + + + + + + + + + + + + + + + + + + + +
ObjectmbkExplanation
SegmentsphsegOriented segments with a width and an orientation.
VIAs & contactsphviaBoils down to just a point.
Big VIAs & Big ContactsphviaPoint with a width and a height +That is a rectangle of width by height centered +on the VIA coordinates.
+

Each of thoses objects is associated to a symbolic layer which will +control how the object is translated in many real rectangles.

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
mbkLayer NameUsable ByUsage
phsegnwellSegmentN Well
PWELLSegmentP Well
NDIFSegmentN Diffusion
PDIFSegmentP Diffusion
NTIESegmentN Tie
PTIESegmentP Tie
NTRANSSegmentN transistor, in Alliance, a transistor +is represented as a segment (it’s grid).
PTRANSSegmentP transistor
POLYSegmentPolysilicium
ALUxSegmentMetal level x
CALUxSegmentMetal level x, that can be used by the +upper hierarchical level as a connector. +From the layout point of view it is the +same as ALUx.
TALUxSegmentBlockage for metal level x. Will +diseappear in the real layout as it is an +information for the P&R tools only.
phviaCONT_BODY_NVIA, BIGVIAContact to N Well
CONT_BODY_PVIA, BIGVIAContact to P Well
CONT_DIF_NVIA, BIGVIAContact to N Diffusion
CONT_DIF_PVIA, BIGVIAContact to P Diffusion
CONT_POLYVIA, BIGVIAContact to polysilicium
CONT_VIAVIA, BIGVIAContact between metal1 and metal2
CONT_VIAxVIA, BIGVIAContact between metal x and metal x+1. +The index is the the one of the bottom +metal of the VIA.
C_X_NVIAN transistor corner, to build transistor +bend. Not used anymore in recent technos
C_X_PVIAP transistor corner, to build transistor +bend. Not used anymore in recent technos
+
+

Note

+

Not all association of object and symbolic layers are meaningful. +For instance you cannot associate a contact to a NTRANS layer.

+
+
+

Note

+

The symbolic layer associated with blockages is prefixed by a T, +for transparency, which may seems silly. It is for historical reasons, +it started as a true transparency, but at some point we had to invert +the meaning (blockage) with the rise of over-the-cell routing, but the +name stuck...

+
+
+
+

Symbolic Segments

+

In Alliance, segments are oriented (up, down, left, right). This disambiguate +the left or right side when using the LCW and RCW rules in the rds file. +It allows to generate, if needed, asymetric object in the real layout file.

+

Symbolic Segment Orientations

+

+
+
+
+

The RDS File

+

The RDS file control how a symbolic layout is transformed into it’s real +conterpart.

+
+

Note

+

Unit used inside the RDS file: all units are expressed in micrometers.

+
+

Alliance tools relying on the RDS file, and what layers are active for them:

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
ToolNameRDS Flags
Layout editorgraalALL
Design Rule CheckerdrucALL, DRC
Electrical extractorcougarALL, EXT
The symbolic to real layout translators2rALL
+
+

Physical Grid & Lambda Value

+

RDS file:

+
DEFINE  PHYSICAL_GRID  0.005
+DEFINE  LAMBDA         0.09
+
+

Tells that the physical grid (founder grid) step is 0.005µm and the lambda has +a value of 0.09µm. That is, one lambda is 18 grid steps.

+

We can distinguish two kind of rds files:

+
    +
  • The 1µm kind, odd segment widths and coordinates are allowed, but the LAMBDA +value must represent an even number of foundry grid step.
    • +
  • The 2µm kind, segments widths and coordinates must all be even. And in that case +the LAMBDA value can be any multiple of the foundry grid.
    • +
+
+
+

The MBK_TO_RDS_SEGMENT table

+

The MBK_TO_RDS_SEGMENT table control the way segments are translated into +real rectangles. Be aware that we are translating segments and not rectangles. +Segments are defined by their axis (source & target points) and their width. +The geometrical transformations are described according to that model. +Obviously, they are either horizontal or vertical.

+

The translation method of a symbolic segment is as follow:

+
    +

  1. The segment is translated into one or more physical rectangles. +The generated rectangles depends on the tool which is actually +using rds and the flag for the considered real layer. +For instance, real layers flagged with DRC will be generated +for s2r (for the cif or gds) and druc, but will not +be shown under graal.

    +
    2. +

  2. Translation into one real layer. First the source & target coordinates and width +of the symbolic segment are multiplied by the LAMBDA value to obtain a real +segment. Then one of the VW, LCW or RCW transformation is applied to +that segment to get the final real rectangle.

    +
      +

    • VW for Variable Width, expand the real layer staying centered from the +original one. In those rules, the third number is not used, it is only here +to make the life easier for the parser...

      +

      RDS Variable Width Rule

      +
      • +

    • LCW or RCW for Left/Right Constant Width, create an off-center rectangle +of fixed width relatively to the real segment. Note that the SP number +is the distance between the edge of the real segment and the edge of the +generated real rectangle (not from the axis). It is often zero.

      +

      RDS Left Constant Width Rule

      +
      • +
    +
    3. +
+

+

Examples:

+
TABLE MBK_TO_RDS_SEGMENT
+
+    # (Case 1)
+    ALU1       RDS_ALU1   VW  0.18  0.09  0.0  ALL
+
+    # (Case 2)
+    NDIF       RDS_NDIF   VW  0.18  0.0   0.0  ALL \
+               RDS_ACTIV  VW  0.18  0.0   0.0  DRC \
+               RDS_NIMP   VW  0.36  0.36  0.0  DRC
+
+    # (Case 3)
+    NTRANS     RDS_POLY   VW  0.27  0.00  0.0  ALL \
+               RDS_GATE   VW  0.27  0.00  0.0  DRC \
+               RDS_NDIF  LCW  0.0   0.27  0.0  EXT \
+               RDS_NDIF  RCW  0.0   0.27  0.0  EXT \
+               RDS_NDIF   VW  0.0   0.72  0.0  DRC \
+               RDS_ACTIV  VW  0.0   0.72  0.0  ALL \
+               RDS_NIMP   VW  0.18  1.26  0.0  DRC
+
+END
+
+

Case 1 the ALU1 is translated in exacltly one real rectangle of +RDS_ALU1, both ends are extended by 0.18µm and it’s width is increased +by 0.09µm.

+

Case 2 the NDIF will be translated into only one segment +under graal, for symbolic visualization. And into three real rectangles +for s2r and druc.

+

Case 3 the NTRANS, associated to a transistor is a little bit +more complex, the generated shapes are different for the extractor cougar +in one hand, and for both druc & s2r in the other hand.

+
    +

  • For the extractor (EXT & ALL flags) there will be four rectangles +generateds:

    +
      +
    1. The gate (RDS_GATE)
      2. +
    2. The left diffusion of the transistor (source or drain) (RDS_NDIF).
      3. +
    3. The right diffusion of the transistor (drain or source) (RDS_NDIF).
      4. +
    4. The active area (RDS_ACTIV).
      5. +
    +

    As the extractor must kept separate the source and the drain of the transistor, +they are generated as two offset rectangles, using the LCW and RCW directives.

    +
    • +

  • For s2r and druc (DRC and ALL), five rectangles are generateds:

    +
      +
    1. The poly (RDS_POLY).
      2. +
    2. The gate (RDS_GATE).
      3. +
    3. The diffusion, as one rectangle that covers both the LCW and the RCW (RDS_NDIF).
      4. +
    4. The active area (RDS_ACTIV).
      5. +
    5. The N implantation (RDS_NIMP).
      6. +
    +

    In the layout send to the foundry, the source & drain are draw as one rectangle +across the gate area (the transistor being defined by the intersection of both +rectangles).

    +
    • +
+

+
+
+

The MBK_TO_RDS_VIA table

+

This table is to translate default VIAs into real via. In the symbolic layout +the default VIA is simply a point and a set of layers. All layers are converted +in squares shapes centered on the VIA coordinate. The one dimension given is the +size of the side of that square.

+

Note that although we are refering to VIAs, which for the purists are between two +metal layers, this table also describe contacts.

+

Example:

+
TABLE MBK_TO_RDS_VIA
+
+    CONT_DIF_P RDS_PDIF  0.54 ALL \
+               RDS_CONT  0.18 ALL \
+               RDS_ALU1  0.36 ALL \
+               RDS_ACTIV 0.54 DRC \
+               RDS_PIMP  0.90 DRC
+
+    CONT_POLY  RDS_POLY  0.54 ALL \
+               RDS_CONT  0.18 ALL \
+               RDS_ALU1  0.36 ALL
+
+    CONT_VIA   RDS_ALU1  0.45 ALL \
+               RDS_VIA1  0.27 ALL \
+               RDS_ALU2  0.45 ALL
+
+END
+
+
+

Note

+

In CONT_DIF_P you may see that only three layers will be shown under +graal, but five will be generated in the gds layout.

+
+
+
+

The MBK_TO_RDS_BIGVIA_HOLE table

+

In s2r, when generating BIGVIAs, the matrix of holes they contains is +not draw relative to the position of the BIGVIA itself, but on a grid which +is common througout all the design real layout. This is to allow overlap +between two BIGVIA without risking the holes matrix to be not exactly overlapping. +As a consequence, when visualizing the gds file, the holes may not be centerend +inside one individual BIGVIA.

+

The MBK_TO_RDS_BIGVIA_HOLE table define the global hole matrix for the whole +design. The first number is the individual hole side and the second the grid step +(edge to edge). The figure below show the hole generation.

+

BIGVIA holes

+

Example of BIGVIA overlap:

+

BIGVIA holes overlap

+

Example:

+
TABLE MBK_TO_RDS_BIGVIA_HOLE
+
+    CONT_VIA   RDS_VIA1 0.27 0.27 ALL
+    CONT_VIA2  RDS_VIA2 0.27 0.27 ALL
+    CONT_VIA3  RDS_VIA3 0.27 0.27 ALL
+    CONT_VIA4  RDS_VIA4 0.27 0.27 ALL
+    CONT_VIA5  RDS_VIA5 0.36 0.36 ALL
+
+END
+
+
+

Note

+

BIGVIA demotion. If the size of the bigvia is too small, there is +a possibility that no hole from the global matrix will be under it. +To avoid that case, if the either side of the BIGVIA is less than +1.5 * step, the BIGVIA is demoted to a simple VIA.

+
+
+
+

The MBK_TO_RDS_BIGVIA_METAL table

+

This table describe how the metal part of a BIGVIA is expanded (for the hole +part, see the previous table MBK_TO_RDS_BIGVIA_HOLE). The rule give for each +metal:

+
    +
  1. The delta-with (have to ask Franck).
    2. +
  2. The overhang, the length the real rectangle is expanded on each side from +the symbolic rectange.
    3. +
+

Example:

+
TABLE MBK_TO_RDS_BIGVIA_METAL
+
+    CONT_VIA  RDS_ALU1 0.0 0.09  ALL \
+              RDS_ALU2 0.0 0.09  ALL
+
+    CONT_VIA2 RDS_ALU2 0.0 0.09  ALL \
+              RDS_ALU3 0.0 0.09  ALL
+
+    CONT_VIA3 RDS_ALU3 0.0 0.09  ALL \
+              RDS_ALU4 0.0 0.09  ALL
+
+    CONT_VIA4 RDS_ALU4 0.0 0.09  ALL \
+              RDS_ALU5 0.0 0.09  ALL
+
+    CONT_VIA5 RDS_ALU5 0.0 0.09  ALL \
+              RDS_ALU6 0.0 0.18  ALL
+END
+
+
+
+

The MBK_WIRESETTING table

+

From a strict standpoint this table shouldn’t be here but put in a separate +configuration file, because it contains informations only used by the symbolic +layout tools (ocp, nero, ring).

+

This table defines the cell gauge the routing pitch and minimal (symbolic) +wire width and minimal spacing for the routers. They are patly redundant.

+

Example:

+
TABLE MBK_WIRESETTING
+
+    X_GRID             10
+    Y_GRID             10
+    Y_SLICE           100
+    WIDTH_VDD          12
+    WIDTH_VSS          12
+    TRACK_WIDTH_ALU8    0
+    TRACK_WIDTH_ALU7    4
+    TRACK_WIDTH_ALU6    4
+    TRACK_WIDTH_ALU5    4
+    TRACK_WIDTH_ALU4    3
+    TRACK_WIDTH_ALU3    3
+    TRACK_WIDTH_ALU2    3
+    TRACK_WIDTH_ALU1    3
+    TRACK_SPACING_ALU8  0
+    TRACK_SPACING_ALU7  4
+    TRACK_SPACING_ALU6  4
+    TRACK_SPACING_ALU5  4
+    TRACK_SPACING_ALU4  4
+    TRACK_SPACING_ALU3  4
+    TRACK_SPACING_ALU2  4
+    TRACK_SPACING_ALU1  3
+
+END
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/RDS/index.html b/documentation/_build/html/RDS/index.html new file mode 100644 index 00000000..bfee2f8e --- /dev/null +++ b/documentation/_build/html/RDS/index.html @@ -0,0 +1,354 @@ + + + + + + + + + + + + Symbolic to Real Conversion in Alliance — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Symbolic to Real Conversion in Alliance
    • +
  • + + + +
    • +
+
+
+
+ +

Disclaimer: This document is still far from complete.

+ + + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Stratus/Stratus.html b/documentation/_build/html/Stratus/Stratus.html new file mode 100644 index 00000000..2712c698 --- /dev/null +++ b/documentation/_build/html/Stratus/Stratus.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Stratus Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Stratus Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Stratus Reference

+

The Stratus Language reference is generated by LaTeX2HTML and is +available here: Stratus

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Unicorn/Unicorn.html b/documentation/_build/html/Unicorn/Unicorn.html new file mode 100644 index 00000000..fd71048b --- /dev/null +++ b/documentation/_build/html/Unicorn/Unicorn.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Unicorn Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Unicorn Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Unicorn Reference

+

The Unicorn C++ API reference is generated by Doxygen and is +available here: Unicorn

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/Configuration.html b/documentation/_build/html/UsersGuide/Configuration.html new file mode 100644 index 00000000..d2b919a2 --- /dev/null +++ b/documentation/_build/html/UsersGuide/Configuration.html @@ -0,0 +1,655 @@ + + + + + + + + + + + + Coriolis Configuration & Initialisation — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +

+
+

Coriolis Configuration & Initialisation

+
+

General Software Architecture

+

Coriolis has been build with respect of the classical paradigm that the +computational instensive parts have been written in C++, and almost +everything else in Python. To build the Python interface we used +two methods:

+
    +
  • For self-contained modules boost::python (mainly in vlsisapd).
    • +
  • For all modules based on Hurricane, we created our own wrappers due +to very specific requirements such as shared functions between modules +or C++/Python secure bi-directional object deletion.
    • +
+
+

Note

+

Python Documentation: +Most of the documentation is related to the C++ API and implemetation of +the tools. However, the Python bindings have been created so they +mimic as closely as possible the C++ interface, so the documentation +applies to both languages with only minor syntactic changes.

+
+

Coriolis Software Schematic

+

All configuration & initialization files are Python scripts, despite their +.conf extention. From a syntactic point of view, there is no difference +between the system-wide configuration files and the user’s configuration, +they may use the same Python helpers. +

+

Configuration is done in two stages:

+
    +
  1. Selecting the symbolic technology.
    2. +
  2. Loading the complete configuration for the given technology.
    3. +
+

+
+
+

First Stage: Symbolic Technology Selection

+

+The initialization process is done by executing, in order, the following +file(s):

+ +++++ + + + + + + + + + + + + + + + + + + + + +
OrderMeaningFile
1The system setting/etc/coriolis2/techno.conf
2The user’s global setting${HOME}/.coriolis2/techno.py
3The user’s local setting<CWD>/.coriolis2/techno.py
+

Thoses files must provides only two variables, the name of the symbolic technology +and the one of the real technology. For example:

+
# -*- Mode:Python -*-
+
+symbolicTechno = 'cmos'
+realTechno     = 'hcmos9'
+
+
+
+
+

Second Stage: Technology Configuration Loading

+

+The TECHNO variable is set by the first stage and it’s the name of the +symbolic technology. A directory of that name, with all the configuration files, +must exists in the configuration directory. In addition to the technology-specific +directories, a common/ directory is there to provides a trunk for all the +identical datas across the various technologies. The initialization process is done +by executing, in order, the following file(s):

+ +++++ + + + + + + + + + + + + + + + + + + + + +
OrderMeaningFile
1The system initialization/etc/coriolis2/<TECHNO>/<TOOL>.conf
2The user’s global initialization${HOME}/.coriolis2/settings.py
3The user’s local initialization<CWD>/.coriolis2/settings.py
+
+

Note

+

The loading policy is not hard-coded. It is implemented +at Python level in /etc/coriolis2/coriolisInit.py, and thus may be easily be +amended to whatever site policy.

+

The truly mandatory requirement is the existence of coriolisInit.py +which must contain a coriolisConfigure() function with no argument.

+
+
+
+

Configuration Helpers

+

To ease the writing of configuration files, a set of small helpers +is available. They allow to setup the configuration parameters through +simple assembly of tuples. The helpers are installed under the directory:

+
<install>/etc/coriolis2/
+
+

Where <install>/ is the root of the installation.

+

+
+

Alliance Helper

+

The configuration file must provide a allianceConfig tuple of +the form:

+
cellsTop = '/usr/share/alliance/cells/'
+
+allianceConfig = \
+    ( ( 'SYMBOLIC_TECHNOLOGY', helpers.sysConfDir+'/technology.symbolic.xml'   )
+    , ( 'REAL_TECHNOLOGY'    , helpers.sysConfDir+'/technology.cmos130.s2r.xml')
+    , ( 'DISPLAY'            , helpers.sysConfDir+'/display.xml'               )
+    , ( 'CATALOG'            , 'CATAL')
+    , ( 'WORKING_LIBRARY'    , '.')
+    , ( 'SYSTEM_LIBRARY'     , ( (cellsTop+'sxlib'   , Environment.Append)
+                               , (cellsTop+'dp_sxlib', Environment.Append)
+                               , (cellsTop+'ramlib'  , Environment.Append)
+                               , (cellsTop+'romlib'  , Environment.Append)
+                               , (cellsTop+'rflib'   , Environment.Append)
+                               , (cellsTop+'rf2lib'  , Environment.Append)
+                               , (cellsTop+'pxlib'   , Environment.Append) ) )
+    , ( 'SCALE_X'            , 100)
+    , ( 'IN_LO'              , 'vst')
+    , ( 'IN_PH'              , 'ap')
+    , ( 'OUT_LO'             , 'vst')
+    , ( 'OUT_PH'             , 'ap')
+    , ( 'POWER'              , 'vdd')
+    , ( 'GROUND'             , 'vss')
+    , ( 'CLOCK'              , '^ck.*')
+    , ( 'BLOCKAGE'           , '^blockageNet*')
+    )
+
+
+

The example above shows the system configuration file, with all the +available settings. Some important remarks about thoses settings:

+
    +

  • In it’s configuration file, the user do not need to redefine all the settings, +just the one he wants to change. In most of the cases, the SYSTEM_LIBRARY, +the WORKING_LIBRARY and the special net names (at this point there is not +much alternatives for the others settings).

    +
    • +

  • SYSTEM_LIBRARY setting: Setting up the library search path. +Each library entry in the tuple will be added to the search path according +to the second parameter:

    +
      +
    • Environment::Append: append to the search path.
      • +
    • Environment::Prepend: insert in head of the search path.
      • +
    • Environment::Replace: look for a library of the same name and replace +it, whithout changing the search path order. If no library of that name +already exists, it is appended.
      • +
    +

    A library is identified by it’s name, this name is the last component of the +path name. For instance: /soc/alliance/sxlib will be named sxlib. +Implementing the Alliance specification, when looking for a Cell name, +the system will browse sequentially trought the library list and returns +the first Cell whose name match.

    +
    • +

  • For POWER, GROUND, CLOCK and BLOCKAGE net names, a regular +expression (gnu regexp) is expected.

    +
    • +

  • The helpers.sysConfDir variable is supplied by the helpers, it is the +directory in which the system-wide configuration files are locateds. +For a standard installation it would be: /soc/coriolis2.

    +
    • +
+

A typical user’s configuration file would be:

+
import os
+
+homeDir = os.getenv('HOME')
+
+allianceConfig = \
+    ( ('WORKING_LIBRARY'    , homeDir+'/worklib')
+    , ('SYSTEM_LIBRARY'     , ( (homeDir+'/mylib', Environment.Append) ) )
+    , ('POWER'              , 'vdd.*')
+    , ('GROUND'             , 'vss.*')
+    )
+
+
+
+
+

Tools Configuration Helpers

+

All the tools uses the same helper to load their configuration (a.k.a. +Configuration Helper). Currently the following configuration system-wide +configuration files are defined:

+
    +
  • misc.conf: commons settings or not belonging specifically to a tool.
    • +
  • etesian.conf: for the Etesian tool.
    • +
  • kite.conf: for the Kite tool.
    • +
  • stratus1.conf: for the Stratus1 tool.
    • +
+

Here is the contents of etesian.conf:

+
# Etesian parameters.
+parametersTable = \
+    ( ('etesian.aspectRatio'    , TypePercentage, 100    , { 'min':10, 'max':1000 } )
+    , ('etesian.spaceMargin'    , TypePercentage, 5      )
+    , ('etesian.uniformDensity' , TypeBool      , False  )
+    , ('etesian.routingDriven'  , TypeBool      , False  )
+    , ("etesian.effort"         , TypeEnumerate , 2
+      , { 'values':( ("Fast"    , 1)
+                   , ("Standard", 2)
+                   , ("High"    , 3)
+                   , ("Extreme" , 4) ) }
+      )
+    , ("etesian.graphics"       , TypeEnumerate , 2
+      , { 'values':( ("Show every step"  , 1)
+                   , ("Show lower bound" , 2)
+                   , ("Show result only" , 3) ) }
+      )
+    )
+
+layoutTable = \
+    ( (TypeTab   , 'Etesian', 'etesian')
+
+    , (TypeTitle , 'Placement area')
+    , (TypeOption, "etesian.aspectRatio"   , "Aspect Ratio, X/Y (%)", 0 )
+    , (TypeOption, "etesian.spaceMargin"   , "Space Margin"         , 1 )
+    , (TypeRule  ,)
+    , (TypeTitle , 'Etesian - Placer')
+    , (TypeOption, "etesian.uniformDensity", "Uniform density"      , 0 )
+    , (TypeOption, "etesian.routingDriven" , "Routing driven"       , 0 )
+    , (TypeOption, "etesian.effort"        , "Placement effort"     , 1 )
+    , (TypeOption, "etesian.graphics"      , "Placement view"       , 1 )
+    , (TypeRule  ,)
+    )
+
+
+

+

Taxonomy of the file:

+
    +
  • It must contains, at least, the two tables:
      +
    • parametersTable, defines & initialise the configuration variables.
      • +
    • layoutTables, defines how the various parameters will be displayed +in the configuration window (The Settings Tab).
      • +
    +
    • +
  • The parametersTable, is a tuple (list) of tuples. Each entry in the list +describe a configuration parameter. In it’s simplest form, it’s a quadruplet +(TypeOption, ‘paramId’, ParameterType, DefaultValue) with:
      +
    1. TypeOption, tells that this tuple describe a parameter.
      2. +
    2. paramId, the identifier of the parameter. Identifiers are defined +by the tools. The list of parameters is detailed in each tool section.
      3. +
    3. ParameterType, the kind of parameter. Could be:
        +
      • TypeBool, boolean.
        • +
      • TypeInt, signed integer.
        • +
      • TypeEnumerate, enumerated type, needs extra entry.
        • +
      • TypePercentage, percentage, expressed between 0 and 100.
        • +
      • TypeDouble, float.
        • +
      • TypeString, character string.
        • +
      +
      4. +
    4. DefaultValue, the default value for that parameter.
      5. +
    +
    • +
+
+
+
+

Hacking the Configuration Files

+

Asides from the symbols that gets used by the configuration helpers like +allianceConfig or parametersTable, you can put pretty much anything +in <CWD>/.coriolis2/settings.py (that is, written in Python).

+

For example:

+
# -*- Mode:Python -*-
+
+defaultStyle = 'Alliance.Classic [black]'
+
+# Regular Coriolis configuration.
+parametersTable = \
+    ( ('misc.catchCore'           , TypeBool      , False  )
+    , ('misc.info'                , TypeBool      , False  )
+    , ('misc.paranoid'            , TypeBool      , False  )
+    , ('misc.bug'                 , TypeBool      , False  )
+    , ('misc.logMode'             , TypeBool      , True   )
+    , ('misc.verboseLevel1'       , TypeBool      , False  )
+    , ('misc.verboseLevel2'       , TypeBool      , True   )
+    , ('misc.minTraceLevel'       , TypeInt       , 0      )
+    , ('misc.maxTraceLevel'       , TypeInt       , 0      )
+    )
+
+# Some ordinary Python script...
+import os
+
+print '       o  Cleaning up ClockTree previous run.'
+for fileName in os.listdir('.'):
+  if fileName.endswith('.ap') or (fileName.find('_clocked.') >= 0):
+    print '          - <%s>' % fileName
+    os.unlink(fileName)
+
+
+

See Python Interface for Hurricane / Coriolis for more details those capabilities.

+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/Installation.html b/documentation/_build/html/UsersGuide/Installation.html new file mode 100644 index 00000000..110b7d95 --- /dev/null +++ b/documentation/_build/html/UsersGuide/Installation.html @@ -0,0 +1,576 @@ + + + + + + + + + + + + Installation — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +

+
+

Installation

+
+

Note

+

As the sources are being released, the binary packaging is dropped. +You still may find older version here: http://asim.lip6.fr/pub/coriolis/2.0 .

+
+

In a nutshell, building source consist in pulling the git repository then +running the ccb installer.

+

Main building prerequisites:

+
    +
  • cmake
    • +
  • C++11-capable compiler
    • +
  • RapidJSON
    • +
  • python2.7
    • +
  • boost
    • +
  • libxml2
    • +
  • bzip2
    • +
  • yacc & lex
    • +
  • Qt 4 or Qt 5
    • +
+

Building documentation prerequisites:

+
    +
  • doxygen
    • +
  • latex
    • +
  • latex2html
    • +
  • python-docutils (for reStructuredText)
    • +
+

Optional libraries:

+
    +
  • LEF/DEF (from SI2)
    • +
+

For other distributions, refer to their own packaging system.

+

+
+

Fixed Directory Tree

+

In order to simplificate the work of the ccb installer, the source, build +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 +building it (noted ~/ or $HOME/). Only the source +directory needs to be manually created by the user, all others will be +automatically created either by ccb or the build system.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + +
Sources
+
Sources root
+
under git
+
+
+
~/coriolis-2.x/src
+
~/coriolis-2.x/src/coriolis
+
+
Architecture Dependant Build
+
Linux, SL 7, 64b
+
Linux, SL 6, 32b
+
Linux, SL 6, 64b
+
Linux, Fedora, 64b
+
Linux, Fedora, 32b
+
FreeBSD 8, 32b
+
FreeBSD 8, 64b
+
Windows 7, 32b
+
Windows 7, 64b
+
Windows 8.x, 32b
+
Windows 8.x, 64b
+
+
+
~/coriolis-2.x/Linux.el7_64/Release.Shared/build/<tool>
+
~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/<tool>
+
~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/<tool>
+
~/coriolis-2.x/Linux.fc_64/Release.Shared/build/<tool>
+
~/coriolis-2.x/Linux.fc/Release.Shared/build/<tool>
+
~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/<tool>
+
~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/<tool>
+
~/coriolis-2.x/Cygwin.W7/Release.Shared/build/<tool>
+
~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/<tool>
+
~/coriolis-2.x/Cygwin.W8/Release.Shared/build/<tool>
+
~/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
+
Libraries (Python)
+
Include by tool
+
Configuration files
+
Doc, by tool
+
+
+
.../install/bin
+
.../install/lib
+
.../install/include/coriolis2/<project>/<tool>
+
.../install/etc/coriolis2/
+
.../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.

+

Static do not work because I don’t know yet to mix statically linked binaries +and Python modules (which must be dynamic).

+
+

+
+
+

Building Coriolis

+

First step is to install the prerequisites. Currently, only RapidJSON. +As RapidJSON is evolving fast, if you encounter compatibility problems, +the exact version we compiled against is given below.

+
dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support
+dummy@lepka:~$ cd ~/coriolis-2.x/src/support
+dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson
+dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd
+
+

The second step is to create the source directory and pull the git repository:

+
dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src
+dummy@lepka:~$ cd ~/coriolis-2.x/src
+dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git
+
+

Third and final step, build & install:

+
dummy@lepka:src$ ./bootstrap/ccb.py --project=support  \
+                                    --project=coriolis \
+                                    --make="-j4 install"
+dummy@lepka:src$ ./bootstrap/ccb.py --project=support  \
+                                    --project=coriolis \
+                                    --doc --make="-j1 install"
+
+

We need to separate to perform a separate installation of the documentation because it +do not support to be generated with a parallel build. So we compile & install in a first +stage in -j4 (or whatever) then we generate the documentation in -j1

+

Under rhel6 or clones, you must build using the devtoolset2:

+
dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \
+                                    --devtoolset-2 --make="-j4 install"
+
+

If you want to uses Qt 5 instead of Qt 4, you may add the --qt5 argument.

+

The complete list of ccb functionalities can be accessed with the --help argument. +It also may be run in graphical mode (--gui).

+
+

Building the Devel Branch

+

In the Coriolis git repository, two branches are present:

+
    +

  • The master branch, which contains the latest stable version. This is the +one used by default if you follow the above instructions.

    +
    • +

  • The devel branch, which obviously contains the latest commits from the +development team. To use it instead of the master one, do the following +command just after the first step:

    +
    dummy@lepka:~$ git checkout devel
+dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \
+                                    --make="-j4 install" --debug
    +
    +

    Be aware that it may requires newer versions of the dependencies and may introduce +incompatibilites with the stable version.

    +

    In the (unlikely) event of a crash of cgt, as it is a Python script, the right +command to run gdb on it is:

    +
    dummy@lepka:work$ gdb python core.XXXX
    +
    +
    • +
+

+
+
+

Additionnal Requirement under MacOS

+

Coriolis make uses of the boost::python module, but the MacPorts boost +seems unable to work with the Python bundled with MacOS. So you have to install +both of them from MacPorts:

+
dummy@macos:~$ port install boost +python27
+dummy@macos:~$ port select python python27
+dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks
+
+

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

+

Packager should not uses ccb, instead bootstrap/Makefile.package is provided +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.

+

Sligthly outaded packaging configuration files can also be found under bootstrap/:

+
    +
  • 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.

+

This is done by editing the one variable cellsTop in the Alliance helper +(see Alliance Helper). This variable must point to the directory of the +cells libraries. In a typical installation, this is generally +/usr/share/alliance/cells.

+
+
+

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. +When used under rhel6 or clones, it needs to be run in the devtoolset2 +environement. The script then launch a new shell, which may cause an +infinite loop if it’s called again in, say ~/.bashrc.

+

Instead you may want to create an alias:

+
alias c2r='eval "`~/coriolis-2.x/src/coriolis/bootstrap/coriolisEnv.py`"'
+
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/LicenseCredits.html b/documentation/_build/html/UsersGuide/LicenseCredits.html new file mode 100644 index 00000000..0d9f7f6e --- /dev/null +++ b/documentation/_build/html/UsersGuide/LicenseCredits.html @@ -0,0 +1,363 @@ + + + + + + + + + + + + Credits & License — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Credits & License

+

Hurricane +Rémy Escassut & + Christian Masson

+
+

Etesian +Gabriel Gouvine

+
+

Stratus +Sophie Belloeil

+
+

Knik +Damien Dupuis

+
+

Kite, + Unicorn +Jean-Paul Chaput

+


+

The Hurricane data-base is copyright© Bull 2000-2016 and is +released under the terms of the lgpl license. All other tools are +copyright© upmc 2008-2016 and released under the gpl +license.

+

Others important contributors to Coriolis are Christophe Alexandre, +Hugo Clement, Marek Sroka and Wu Yifei.

+

The Knik router makes use of the Flute software, which is +copyright© Chris C. N. Chu from the Iowa State University +(http://home.eng.iastate.edu/~cnchu/).

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/Releases.html b/documentation/_build/html/UsersGuide/Releases.html new file mode 100644 index 00000000..9be3c64c --- /dev/null +++ b/documentation/_build/html/UsersGuide/Releases.html @@ -0,0 +1,420 @@ + + + + + + + + + + + + Release Notes — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Release Notes

+
+

Release 1.0.1475

+

This is the first preliminary release of the Coriolis 2 framework.

+

This release mainly ships the global router Knik and the detailed router +Kite. Together they aim to replace the Alliance Nero router. +Unlike Nero, Kite is based on an innovating routing modeling and ad-hoc +algorithm. Although it is released under gpl license, the source code +will be avalaible later. +

+

Contents of this release:

+
    +
  1. A graphical user interface (viewer only).
    2. +
  2. The Knik global router.
    3. +
  3. The Kite detailed router.
    4. +
+

Supported input/output formats:

+
    +
  • Alliance vst (netlist) & ap (physical) formats.
    • +
  • Even if there are some references to the Cadence lefdef format, its +support is not included because it depends on a library only available +to Si2 affiliated members.
    • +
+
+
+

Release 1.0.1963

+

Release 1963 is alpha. All the tools from Coriolis 1 have been ported into +this release.

+

Contents of this release:

+
    +
  1. The Stratus netlist capture language (GenLib replacement).
    2. +
  2. The Mauka placer (still contains bugs).
    3. +
  3. A graphical user interface (viewer only).
    4. +
  4. The Knik global router.
    5. +
  5. The Kite detailed router.
    6. +
  6. Partially implemented python support for configuration files +(alternative to xml).
    7. +
  7. A documentation (imcomplete/obsoleted in Hurricane‘s case).
    8. +
+
+
+

Release 1.0.2049

+

Release 2049 is Alpha.

+

Changes of this release:

+
    +
  1. The Hurricane documentation is now accurate. Documentation +for the Cell viewer and CRLcore has been added.
    2. +
  2. More extensive Python support for all the components of +Coriolis.
    3. +
  3. Configuration is now completly migrated under Python. +xml loaders can still be useds for compatibilty.
    4. +
  4. The cgt main has been rewritten in Python.
    5. +
+
+
+

Release v2.0.1

+
    +
  1. Migrated the repository from svn to git, and release complete sources. +As a consequence, we drop the distribution packaging support and give +public read-only access to the repository.
    2. +
  2. Deep rewrite of the Katabatic database and Kite detailed router, +achieve a speedup factor greater than 20...
    3. +
+
+
+

Release v2.1

+
    +
  1. Replace the old simulated annealing placer Mauka by the analytical placer +Etesian and its legalization and detailed placement tools.
    2. +
  2. Added a Blif format parser to process circuits generated by the Yosys and ABC +logic synthetizers.
    3. +
  3. The multiples user defined configuration files are now grouped under +a common hidden (dot) directory .coriolis2 and the file extension +is back from .conf to .py.
    4. +
+
+
+

Release v2.2

+
    +
  1. Added JSON import/export of the whole Hurricane DataBase. Two save mode +are supported: Cell mode (standalone) or Blob mode, which dump the +whole design down and including the standard cells.
    2. +
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/ScriptsPlugins.html b/documentation/_build/html/UsersGuide/ScriptsPlugins.html new file mode 100644 index 00000000..8c689a9a --- /dev/null +++ b/documentation/_build/html/UsersGuide/ScriptsPlugins.html @@ -0,0 +1,714 @@ + + + + + + + + + + + + Python Interface for Hurricane / Coriolis — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

Python Interface for Hurricane / Coriolis

+

The (almost) complete interface of Hurricane is exported as a Python module +and some part of the other components of Coriolis (each one in a separate +module). The interface has been made to mirror as closely as possible the +C++ one, so the C++ doxygen documentation could be used to write code with +either languages.

+

Summary of the C++ Documentation

+

A script could be run directly in text mode from the command line or through +the graphical interface (see Executing Python Scripts in Cgt).

+

Asides for this requirement, the python script can contain anything valid +in Python, so don’t hesitate to use any package or extention.

+

Small example of Python/Stratus script:

+
from Hurricane import *
+from Stratus   import *
+
+def doSomething ():
+    # ...
+    return
+
+def ScriptMain ( **kw ):
+  editor = None
+  if kw.has_key('editor') and kw['editor']:
+    editor = kw['editor']
+    stratus.setEditor( editor )
+
+  doSomething()
+  return
+
+if __name__ == "__main__" :
+  kw           = {}
+  success      = ScriptMain( **kw )
+  shellSuccess = 0
+  if not success: shellSuccess = 1
+
+  sys.exit( shellSuccess )
+      ScriptMain ()
+
+

This typical script can be executed in two ways:

+
    +

  1. Run directly as a Python script, thanks to the

    +
    if __name__ == "__main__" :
    +
    +

    part (this is standart Python). It is a simple adapter that will +calls ScriptMain().

    +
    2. +

  2. Through cgt, either in text or graphical mode. In that case, the +ScriptMain() is directly called trough a sub-interpreter. +The arguments of the script are passed through the **kw dictionnary.

    + ++++ + + + + + + + + + + + + + + + +
    **kw Dictionnary
    Parameter Key/NameContents type
    'cell'A Hurricane cell on which to work. Depending +on the context, it may be None. +For example, when run from cgt, it the cell +currently loaded in the viewer, if any.
    'editor'The viewer from which the script is run, when +lauched through cgt.
    +
    3. +
+
+

Plugins

+

Plugins are Python scripts specially crafted to integrate with cgt. +Their entry point is a ScriptMain() method as described in +Python Interface to Coriolis. They can be called by user scripts +through this method.

+
+

Chip Placement

+

Automatically perform the placement of a complete chip. This plugin, as well +as the other P&R tools expect a specific top-level hierarchy for the design. +The top-level hierarchy must contains the instances of all the I/O pads and +exactly one instance of the chip’s core model.

+

Chip Top Structure

+

The designer must provide a configuration file that define the rules for the +placement of the top-level hierarchy (that is, the pads and the core). +This file must be named after the chip’s name, by appending _chip.py +(obviously, it is a Python file). For instance if the chip netlist file +is called amd2901_crl.vst, then the configuration file must be named +amd2901_crl_chip.vst.

+

Example of chip placement configuration file (for AM2901):

+
chip = \
+  { 'pads.south'     : [ 'p_a3'     , 'p_a2'     , 'p_a1'     , 'p_r0'
+                       , 'p_vddick0', 'p_vssick0', 'p_a0'     , 'p_i6'
+                       , 'p_i8'     , 'p_i7'     , 'p_r3'     ]
+  , 'pads.east'      : [ 'p_zero'   , 'p_i0'     , 'p_i1'     , 'p_i2'
+                       , 'p_vddeck0', 'p_vsseck0', 'p_q3'     , 'p_b0'
+                       , 'p_b1'     , 'p_b2'     , 'p_b3'     ]
+  , 'pads.north'     : [ 'p_noe'    , 'p_y3'     , 'p_y2'     , 'p_y1'
+                       , 'p_y0'     , 'p_vddeck1', 'p_vsseck1', 'p_np'
+                       , 'p_ovr'    , 'p_cout'   , 'p_ng'     ]
+  , 'pads.west'      : [ 'p_cin'    , 'p_i4'     , 'p_i5'     , 'p_i3'
+                       , 'p_ck'     , 'p_d0'     , 'p_d1'     , 'p_d2'
+                       , 'p_d3'     , 'p_q0'     , 'p_f3'     ]
+  , 'core.size'      : ( 1500, 1500 )
+  , 'chip.size'      : ( 3000, 3000 )
+  , 'chip.clockTree' : True
+  }
+
+
+

The file must contain one dictionnary named chip.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Chip Dictionnary
Parameter Key/NameValue/Contents type
'pad.south'Ordered list (left to right) of pad instances names +to put on the south side of the chip
'pad.east'Ordered list (down to up) of pad instances names +to put on the east side of the chip
'pad.north'Ordered list (left to right) of pad instances names +to put on the north side of the chip
'pad.west'Ordered list (down to up) of pad instances names +to put on the west side of the chip
'core.size'The size of the core (to be used by the placer)
'chip.size'The size of the whole chip. The sides must be great +enough to accomodate all the pads
'chip.clockTree'Whether to generate a clock tree or not. This calls +the ClockTree plugin
+

Configuration parameters, defaults are defined in etc/coriolis2/<STECHNO>/plugins.conf.

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter IdentifierTypeDefault
Chip Plugin Parameters
chip.block.rails.countTypeInt5
The minimum number of rails around the core +block. Must be odd and suppérior to 5. +One rail for the clock and at least two pairs +of power/grounds
chip.block.rails.hWidthTypeInt12
The horizontal with of the rails
chip.block.rails.vWidthTypeInt12
The vertical with of the rails
chip.block.rails.hSpacingTypeInt6
The spacing, edge to edge of two adjacent +horizontal rails
chip.block.rails.vSpacingTypeInt6
The spacing, edge to edge of two adjacent +vertical rails
chip.pad.pckTypeStringpck_px
The model name of the pad connected to the +chip external clock
chip.pad.pvddeckTypeStringpvddeck_px
The model name of the pad connected to the +vdde (external power) and suppling it to +the core
chip.pad.pvsseckTypeStringpvsseck_px
The model name of the pad connected to the +vsse (external ground) and suppling it to +the core
chip.pad.pvddickTypeStringpvddick_px
The model name of the pad connected to the +vddi (internal power) and suppling it to +the core
chip.pad.pvssickTypeStringpvssick_px
The model name of the pad connected to the +vssi (internal ground) and suppling it to +the core
+
+

Note

+

If no clock tree is generated, then the clock rail is not created. +So even if the requested number of rails chip.block.rails.count is, say 5, +only four rails (2* power, 2* ground) will be generateds.

+
+
+
+

Clock Tree

+

Insert a clock tree into a block. The clock tree uses the H strategy. +The clock net is splitted into sub-nets, one for each branch of the +tree.

+
    +

  • On chips design, the sub-nets are createds in the model of the +core block (then trans-hierarchically flattened to be shown at +chip level).

    +
    • +

  • On blocks, the sub nets are created directly in the top block.

    +
    • +

  • The sub-nets are named according to a simple geometrical scheme. +A common prefix ck_htree, then one postfix by level telling +on which quarter of plane the sub-clock is located:

    +
      +
    1. _bl: bottom left plane quarter.
      2. +
    2. _br: bottom right plane quarter.
      3. +
    3. _tl: top left plane quarter.
      4. +
    4. _tr: top right plane quarter.
      5. +
    +

    We can have ck_htree_bl, ck_htree_bl_bl, ch_htree_bl_tl and so on.

    +
    • +
+

The clock tree plugin works in four steps:

+
    +
  1. Build the clock tree: creates the top-block abutment box, compute the +levels of H tree neededs and place the clock buffers.
    2. +
  2. Once the clock buffers are placed, calls the placer (Etesian) to place +the ordinary standart cells, whithout disturbing clock H-tree buffers.
    3. +
  3. At this point we know the exact positions of all the DFFs, so we can +connect them to the nearest H-tree leaf clock signal.
    4. +
  4. Leaf clock signals that are not connecteds to any DFFs are removed.
    5. +
+

Netlist reorganisation:

+
    +
  • Obviously the top block or chip core model netlist is modificated to +contains all the clock sub-nets. The interface is not changed.
    • +
  • If the top block contains instances of other models and those models +contains DFFs that get re-connecteds to the clock sub-nets (from the +top level). Change both the model netlist and interface to propagate +the relevant clock sub-nets to the instanciated model. The new model +with the added clock signal is renamed with a _clocked suffix. +For example, the sub-block model ram.vst will become ram_clocked.vst.
    • +
+
+

Note

+

If you are to re-run the clock tree plugin on a netlist, be careful +to erase any previously generated _clocked file (both netlist and +layout: rm *.clocked.{ap,vst}). And restart cgt to clear it’s +memory cache.

+
+

Configuration parameters, defaults are defined in etc/coriolis2/<STECHNO>/plugins.conf.

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter IdentifierTypeDefault
ClockTree Plugin Parameters
clockTree.minimumSideTypeInt300
The minimum size below which the clock tree +will stop to perform quadri-partitions
clockTree.bufferTypeStringbuf_x2
The buffer model to use to drive sub-nets
clockTree.placerEngineTypeStringEtesian
The placer to use. Other value is Mauka +the simulated annealing placer which will go +into retirement very soon
+
+
+

Recursive-Save (RSave)

+

Perform a recursive top down save of all the models from the top cell +loaded in cgt. Force a write of any non-terminal model. This plugin is used +by the clock tree plugin after the netlist clock sub-nets creation.

+
+
+
+

A Simple Example: AM2901

+

To illustrate the capabilities of Coriolis tools and Python scripting, a small +example, derived from the Alliance AM2901 is supplied.

+

This example contains only the synthetized netlists and the doChip.py script +which perform the whole P&R of the design.

+

You can generate the chip using one of the following method:

+
    +

  1. Command line mode: directly run the script:

    +
    dummy@lepka:AM2901$ ./doChip -V --cell=amd2901
    +
    +
    2. +

  2. Graphic mode: launch cgt, load chip netlist amd2901 (the top cell) +then run the Python script doChip.py.

    +
    3. +
+
+

Note

+

Between two consecutive run, be sure to erase the netlist/layout generateds:

+
dummy@lepka:AM2901$ rm *_clocked*.vst *.ap
+
+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/ViewerTools.html b/documentation/_build/html/UsersGuide/ViewerTools.html new file mode 100644 index 00000000..5a4f3e90 --- /dev/null +++ b/documentation/_build/html/UsersGuide/ViewerTools.html @@ -0,0 +1,1207 @@ + + + + + + + + + + + + CGT - The Graphical Interface — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+ +
+
+
+ +
+

CGT - The Graphical Interface

+

The Coriolis graphical interface is split up into two windows.

+
    +
  • The Viewer, with the following features:
      +
    • Basic load/save capabilities.
      • +
    • Display the current working cell. Could be empty if the design +is not yet placed.
      • +
    • Execute Stratus Scripts.
      • +
    • Menu to run the tools (placement, routage).
      • +
    +
    • +
+

Features are detailed in Viewer & Tools.

+

Viewer Basic Snapshot

+
    +
  • The Controller, which allows:
      +
    • Tweak what is displayer by the Viewer. Through the Look, +Filter and Layers&Gos tabs.
      • +
    • Browse the netlist with eponym tab.
      • +
    • Show the list of selected objects (if any) with selection
      • +
    • Walk through the Database, the Cell or the Selection with Inspector. +This is an advanced feature, reserved for experimented users.
      • +
    • The tab Settings which give access to all the settings. +They are closely related to Configuration & Initialisation.
      • +
    +
    • +
+

Controller Basic Snapshot

+
+

Viewer & Tools

+
+

Stratus Netlist Capture

+

Stratus is the replacement for GenLib procedural netlist capture language. +It is designed as a set of Python classes, and comes with it’s own documentation +(Stratus Documentation)

+
+
+

The Hurricane Data-Base

+

The Alliance flow is based on the mbk data-base, which has one data-structure +for each view. That is, Lofig for the logical view and Phfig for the physical +view. The place and route tools were responsible for maintaining (or not) the +coherency between views. Reflecting this weak coupling between views, each one +was stored in a separate file with a specific format. The logical view is stored +in a vst file in vhdl format and the physical in an ap file in an ad-hoc format.

+

The Coriolis flow is based on the Hurricane data-base, which has a unified +structure for logical and physical view. That data structure is the Cell object. +The Cell can have any state between pure netlist and completly placed and +routed design. Although the memory representation of the views has deeply +changed we still use the Alliance files format, but they now really represent +views of the same object. The point is that one must be very careful about +view coherency when going to and from Coriolis.

+

As for the second release, Coriolis can be used only for three purposes :

+
    +
  • Placing a design, in which case the netlist view must be present.
    • +
  • Routing a design, in that case the netlist +view and the layout view must be present and layout view must contain +a placement. Both views must have the same name. When saving the routed design, +it is advised to change the design name otherwise the original unrouted placement +in the layout view will be overwritten.
    • +
  • Viewing a design, the netlist view must be present, if a layout +view is present it still must have the same name but it can be in any +state.
    • +
+
+
+

Synthetizing and loading a design

+

Coriolis supports several file formats. It can load all file format +from the Alliance toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), +BLIF netlist format as well as benchmark formats from the ISPD contests.

+

It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license +and may not be compiled in your version of the software.

+
+

Synthesis under Yosys

+

You can create a BLIF file from the Yosys synthetizer, which can be imported under Coriolis. +Most libraries are specified as a .lib liberty file and a .lef LEF file. +Yosys opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2. +If Coriolis hasn’t been compiled against it, the library is given in Alliance .ap format. +Some free libraries already provide both .ap and .lib files.

+

Once you have installed a common library under Yosys and Coriolis, just synthetize your design +with Yosys and import it (as Blif without the extension) under Coriolis to perform place&route.

+
+
+

Synthesis under Alliance

+

Alliance is an older toolchain but has been extensively used for years. Coriolis can import +and write Alliance designs and libraries directly.

+
+
+
+

Etesian – Placer

+

The Etesian placer is a state of the art (as of 2015) analytical placer. It is +within 5% of other placers’ solutions, but is normally a bit worse than ePlace. +This Coriolis tool is actually an encapsulation of Coloquinte which is the placer.

+
+

Note

+

Instance Uniquification Unsupported: a same logical instance cannot have +two different placements. So, either you manually make a clone of it or you +supply a placement for it. We need to implement uniquification in the +Hurricane database.

+
+

+Hierarchical Placement

+

The placement area is defined by the top cell abutment box.

+

When placing a complete hierarchy, the abutment boxes of the cells (models) other than +the top cell are sets identical to the one of the top cell and their instances are +all placed at position (0,0,ID). That is, all the abutments boxes, whatever the +hierarchical level, defines the same area (they are exactly superposed).

+

We choose this scheme because the placer will see all the instances as virtually +flattened, so they can be placed anywhere inside the top-cell abutment box.

+

Etesian Abutment Box

+

+Computing the Placement Area

+

The placement area is computed using the etesian.aspectRatio and etesian.spaceMargin +parameters only if the top-cell has an empty abutment box. If the top-cell abutment +box has to be set, then it is propagated to all the instances models recursively.

+

+Reseting the Placement

+

Once a placement has been done, the placer cannot reset it (will be implemented +later). To perform a new placement, you must restart cgt. In addition, if you +have saved the placement on disk, you must erase any .ap file, which are +automatically reloaded along with the netlist (.vst).

+

+Limitations

+

Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version, +it doesn’t support movable macros, and you must place every macro beforehand. +Timing and routability analysis are not included either, and the returned placement +may be unroutable.

+
+

Etesian Configuration Parameters

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter IdentifierTypeDefault
Etesian Parameters
etesian.aspectRatioTypePercentage100
Define the height on width H/W aspect +ratio, can be comprised between 10 and 1000
etesian.spaceMarginTypePercentage5
The extra white space added to the total area +of the standard cells
etesian.uniformDensityTypeBoolFalse
Whether the cells will be spread envenly +across the area or allowed to form denser +clusters
etesian.effortTypeInt2
Sets the balance between the speed of the +placer and the solution quality
etesian.routingDrivenTypeBoolFalse
Whether the tool will try routing iterations +and whitespace allocation to improve +routability; to be implemented
etesian.graphicsTypeInt2

How often the display will be refreshed +More refreshing slows the placer.

+
    +
  • 1 shows both upper and lower bounds
    • +
  • 2 only shows lower bound results
    • +
  • 3 only shows the final results
    • +
+
+

+
+
+
+

Knik – Global Router

+

The quality of Knik global routing solutions are equivalent to those of FGR 1.0. +For an in-depth description of Knik algorithms, you may download the thesis of +D. Dupuis avalaible from here~: Knik Thesis.

+

The global router is (not yet) deterministic. To circumvent this limitation, +a global routing solution can be saved to disk and reloaded for later uses.

+

A global routing is saved into a file with the same name as the design and a +kgr extention. It is in Box Router output format.

+

Menus:

+
    +
  • \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Save Global Routing}
    • +
  • \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Load Global Routing}
    • +
+
+
+

Kite – Detailed Router

+

Kite no longer suffers from the limitations of Nero. It can route big designs +as its runtime and memory footprint is almost linear (with respect to the number +of gates). It has successfully routed design of more than 150K gates. +

+

However, this first release comes with the temporary the following +restrictions:

+
    +
  • Works only with SxLib standard cell gauge.
    • +
  • Works always with 4 routing metal layers (M2 through M5).
    • +
  • Do not allow (take into account) pre-routed wires on signals +other than power or ground.
    • +
+
+

Note

+

Slow Layer Assignment. Most of the time, the layer assignment stage is +fast (less than a dozen seconds), but in some instances it can take more +than a dozen minutes. This is a known bug and will be corrected in later +releases.

+
+

After each run, Kite displays a set of completion ratios which must all +be equal to 100% if the detailed routing has been successfull. +In the event of a failure, on a saturated design, you may decrease the +edge saturation ratio (argument –edge) to balance more evenly the design +saturation. That is, the maximum saturation decrease at the price of a wider +saturated area and increased wirelength. This is the saturation of the +global router Knik, and you may increase/decrease by steps of 5%, +which represent one track. The maximum capacity of the SxLib gauge is +10 tracks in two layers, that makes 20 tracks by Knik edge.

+

Routing a design is done in four ordered steps:

+
    +
  1. Detailed pre-route \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed PreRoute}
    2. +
  2. Global routing \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Global Route}
    3. +
  3. Detailed routing \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed Route}
    4. +
  4. Finalize routing \textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Finalize Route}
    5. +
+

It is possible to supply to the router a complete wiring for some nets that the user’s +wants to be routed according to a specific topology. The supplied topology must respect +the building rules of the Katabatic database (contacts must be, terminals, turns, h-tee +& v-tee only). During the first step Detailed Pre-Route the router will solve +overlaps between the segments, without making any dogleg. If no pre-routed topologies +are present, this step may be ommited. Any net routed at this step is then fixed and +become unmovable for the later stages.

+

After the detailed routing step the Kite data-structure is still active +(the Hurricane wiring is decorated). The finalize step performs the removal of +the Kite data-structure, and it is not advisable to save the design before +that step.

+

You may visualize the density (saturation) of either Knik (on edges) or +Kite (on GCells) until the routing is finalized. Special layers appears +to that effect in the The Layers&Go Tab.

+
+

Kite Configuration Parameters

+

As Knik is only called through Kite, it’s parameters also have +the kite. prefix.

+

The Katabatic parameters control the layer assignment step.

+

All the defaults value given below are from the default Alliance technology +(cmos and SxLib cell gauge/routing gauge).

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter IdentifierTypeDefault
Katabatic Parameters
katabatic.topRoutingLayerTypeStringMETAL5
Define the highest metal layer that will be +used for routing (inclusive).
katabatic.globalLengthThresholdTypeInt1450
This parameter is used by a layer assignment +method which is no longer used (did not give +good results)
katabatic.saturateRatioTypePercentage80
If M(x) density is above this ratio, +move up feedthru global segments up from +depth x to x+2
katabatic.saturateRpTypeInt8
If a GCell contains more terminals +(RoutingPad) than that number, force a +move up of the connecting segments to those +in excess
Knik Parameters
kite.hTracksReservedLocalTypeInt3
To take account the tracks needed inside a +GCell to build the local routing, decrease +the capacity of the edges of the global +router. Horizontal and vertical locally +reserved capacity can be distinguished for +more accuracy.
kite.vTracksReservedLocalTypeInt3
cf. kite.hTracksReservedLocal
Kite Parameters
kite.eventsLimitTypeInt4000002
The maximum number of segment displacements, +this is a last ditch safety against infinite +loop. It’s perhaps a little too low for big +designs
kite.ripupCostTypeInt3
Differential introduced between two ripup +cost to avoid a loop between two ripped up +segments
kite.strapRipupLimitTypeInt16
Maximum number of ripup for strap segments
kite.localRipupLimitTypeInt9
Maximum number of ripup for local segments
kite.globalRipupLimitTypeInt5
Maximum number of ripup for global segments, +when this limit is reached, triggers topologic +modification
kite.longGlobalRipupLimitTypeInt5
Maximum number of ripup for long global +segments, when this limit is reached, triggers +topological modification
+
+
+
+

Executing Python Scripts in Cgt

+

Python/Stratus scripts can be executed either in text or graphical mode.

+
+

Note

+

How Cgt Locates Python Scripts: +cgt uses the Python import mechanism to load Python scripts. +So you must give the name of your script whitout .py extention and +it must be reachable through the PYTHONPATH. You may uses the +dotted module notation.

+
+

A Python/Stratus script must contains a function called ScriptMain() +with one optional argument, the graphical editor into which it may be +running (will be set to None in text mode). The Python interface to +the editor (type: CellViewer) is limited to basic capabilities +only.

+

Any script given on the command line will be run immediatly after the +initializations and before any other argument is processed.

+

For more explanation on Python scripts see Python Interface for Hurricane / Coriolis.

+
+
+

Printing & Snapshots

+

Printing or saving into a pdf is fairly simple, just uses the File -> Print +menu or the CTRL+P shortcut to open the dialog box.

+

The print functionality uses exactly the same rendering mechanism as for the +screen, beeing almost WYSIWYG. Thus, to obtain the best results it is advisable +to select the Coriolis.Printer look (in the Controller), which uses a +white background and much suited for high resolutions 32x32 pixels patterns

+

There is also two mode of printing selectable through the Controller +Settings -> Misc -> Printer/Snapshot Mode:

+ +++++ + + + + + + + + + + + + + + +
ModeDPI (approx.)Intended Usage
Cell Mode150For single Cell printing or very small designs. +Patterns will be bigger and more readable.
Design Mode300For designs (mostly commposed of wires and cells +outlines).
+
+

Note

+

The pdf file size +Be aware that the generated pdf files are indeed only pixmaps. +So they can grew very large if you select paper format above A2 +or similar.

+
+

+Saving into an image is subject to the same remarks as for pdf.

+
+
+

Memento of Shortcuts in Graphic Mode

+

The main application binary is cgt.

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CategoryKeysAction
Moves
+
Up, +Down
+
Left, +Right
+
+		Shift the view in the according direction
FitfFit to the Cell abutment box
RefreshCTRL+LTriggers a complete display redraw
Gotogapperture is the minimum side of the area +displayed around the point to go to. It’s an +alternative way of setting the zoom level
Zoomz, +mRespectively zoom by a 2 factor and unzoom +by a 2 factor
+
BigMouse
+
Area Zoom
+
+		You can perform a zoom to an area. +Define the zoom area by holding down the left +mouse button while moving the mouse.
Selection
+
BigMouse
+
Area Selection
+
+		You can select displayed objects under an area. +Define the selection area by holding down the +right mouse button while moving the mouse.
+
BigMouse
+
Toggle Selection
+
+		You can toggle the selection of one object under +the mouse position by pressing CTRL and +pressing down the right mouse button. A popup +list of what’s under the position shows up into +which you can toggle the selection state of one +item.
SToggle the selection visibility
ControllerCTRL+I

Show/hide the controller window.

+

It’s the Swiss Army Knife of the viewer. +From it, you can fine-control the display and +inspect almost everything in your design.

+
Rulersk, +ESCOne stroke on k enters the ruler mode, in +which you can draw one ruler. You can exit the +ruler mode by pressing ESC. Once in ruler +mode, the first click on the left mouse button +sets the ruler’s starting point and the second +click the ruler’s end point. The second click +exits automatically the ruler mode.
KClears all the drawn rulers
PrintCTRL+PCurrently rather crude. It’s a direct copy of +what’s displayed in pixels. So the resulting +picture will be a little blurred due to +anti-aliasing mechanism.
Open/CloseCTRL+OOpens a new design. The design name must be +given without path or extention.
CTRL+WClose the current viewer window, but do not quit +the application.
CTRL+QCTRL+Q quit the application +(closing all windows).
HierarchyCTRL+DownGo one hierarchy level down. That is, if there +is an instance under the cursor position, load +it’s model Cell in place of the current one.
CTRL+UpGo one hierarchy level up. if we have entered +the current model through CTRL+Down +reload the previous model (the one +in which this model is instanciated).
+
+
+

Cgt Command Line Options

+

Appart from the obvious --text options, all can be used for text and graphical mode.

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentsMeaning
-t|–textInstruct cgt to run in text mode.
-L|–log-modeDisable the uses of ansi escape sequence on +the tty. Useful when the output is +redirected to a file.
-c <cell>|–cell=<cell>The name of the design to load, without +leading path or extention.
-g|–load-globalReload a global routing solution from disk. +The file containing the solution must be named +<cell>.kgr.
–save-globalSave the global routing solution, into a file +named <design>.kgr.
-e <ratio>|–edge=<ratio>Change the edge capacity for the global +router, between 0 and 1 (Knik).
-G|–global-routeRun the global router (Knik).
-R|–detailed-routeRun the detailed router (Kite).
-s|–save-design=<routed>The design into which the routed layout will +be saved. It is strongly recommanded to choose +a different name from the source (unrouted) +design.
–events-limit=<count>The maximal number of events after which the +router will stops. This is mainly a failsafe +against looping. The limit is sets to 4 +millions of iteration which should suffice to +any design of 100K. gates. For bigger +designs you may wants to increase this limit.
–stratus-script=<module>Run the Python/Stratus script module. +See Python Scripts in Cgt.
+

+

Some Examples :

+
    +

  • Run both global and detailed router, then save the routed design :

    +
    > cgt -v -t -G -R --cell=design --save-design=design_kite
    +
    +
    • +

  • Load a previous global solution, run the detailed router, then save the +routed design :

    +
    > cgt -v -t --load-global -R --cell=design --save-design=design_kite
    +
    +
    • +

  • Run the global router, then save the global routing solution :

    +
    > cgt -v -t -G --save-global --cell=design
    +
    +
    • +
+
+
+

Miscellaneous Settings

+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter IdentifierTypeDefault
Verbosity/Log Parameters
misc.infoTypeBoolFalse
Enable display of info level message +(cinfo stream)
misc.bugTypeBoolFalse
Enable display of bug level message +(cbug stream), messages can be a little +scarry
misc.logModeTypeBoolFalse
If enabled, assume that the output device +is not a tty and suppress any escaped +sequences
misc.verboseLevel1TypeBoolTrue
First level of verbosity, disable level 2
misc.verboseLevel2TypeBoolFalse
Second level of verbosity
Development/Debug Parameters
misc.minTraceLevelTypeInt0
misc.maxTraceLevelTypeInt0
Display trace information between those two +levels (cdebug stream)
misc.catchCoreTypeBoolFalse
By default, cgt do not dump core. +To generate one set this flag to True
+

+
+
+
+

The Controller

+

The Controller window is composed of seven tabs:

+
    +
  1. The Look Tab to select the display style.
    2. +
  2. The Filter Tab the hierarchical levels to be displayed, the look of +rubbers and the dimension units.
    3. +
  3. The Layers&Go Tab to selectively hide/display layers.
    4. +
  4. The Netlist Tab to browse through the netlist. Works in association +with the Selection tab.
    5. +
  5. The Selection Tab allow to view all the currently selected elements.
    6. +
  6. The Inspector Tab browse through either the DataBase, the Cell or +the current selection.
    7. +
  7. The Settings Tab access all the tool’s configuration settings.
    8. +
+
+

The Look Tab

+

You can select how the layout will be displayed. There is a special one +Printer.Coriolis specifically designed for Printing & Snapshots. +You should select it prior to calling the print or snapshot dialog boxes.

+

Controller Look, Snapshot 1

+

+
+
+

The Filter Tab

+

The filter tab let you select what hierarchical levels of your design will be +displayed. Hierarchy level are numbered top-down: the level 0 correspond to +the top-level cell, the level one to the instances of the top-level Cell and +so on.

+

There are also check boxes to enable/disable the processing of Terminal Cell, +Master Cells and Compnents. The processing of Terminal Cell (hierarchy leaf +cells) is disabled by default when you load a hierarchical design and enabled +when you load a single Cell.

+

You can choose what kind of form to give to the rubbers and the type of +unit used to display coordinates.

+
+

Note

+

What are Rubbers: Hurricane uses Rubbers to materialize +physical gaps in net topology. That is, if some wires are missing to +connect two or more parts of net, a rubber will be drawn between them +to signal the gap.

+

For example, after the detailed routing no rubbers should remains. +They have been made very visibles as big violet lines...

+
+

Controller Basic Snapshot

+

+
+
+

The Layers&Go Tab

+

Control the individual display of all layers and Gos.

+
    +
  • Layers correspond to a true physical layer. From a Hurricane point of +view they are all the BasicLayers (could be matched to GDSII).
    • +
  • Gos stands from Graphical Objects, they are drawings that have no +physical existence but are added by the various tools to display extra +information. One good exemple is the density map of the detailed router, +to easily locate congested areas.
    • +
+

For each layer/Go there are two check boxes:

+
    +
  • The normal one triggers the display.
    • +
  • The red-outlined allows objects of that layer to be selectable or not.
    • +
+

Controller Basic Snapshot

+
+
+

The Netlist Tab

+

The Netlist tab shows the list of nets... By default the tab is not +synched with the displayed Cell. To see the nets you must check the +Sync Netlist checkbox. You can narrow the set of displayed nets by +using the filter pattern (supports regular expressions).

+

An very useful feature is to enable the Sync Selection, which will +automatically select all the components of the selected net(s). You can +select multiple nets. In the figure the net auxsc35 is selected and +is highlited in the Viewer.

+

Controller Basic Snapshot + Controller Basic Snapshot

+
+
+

The Selection Tab

+

The Selection tab list all the components currently selecteds. They +can be filtered thanks to the filter pattern.

+

Used in conjunction with the Netlist Sync Selection you will all see +all the components part of net.

+

In this list, you can toggle individually the selection of component by +pressing the t key. When unselected in this way a component is not +removed from the the selection list but instead displayed in red italic. +To see where a component is you may make it blink by repeatedly press +the t key...

+

Controller Basic Snapshot

+
+
+

The Inspector Tab

+

This tab is very useful, but mostly for Coriolis developpers. It allows +to browse through the live DataBase. The Inspector provide three entry points:

+
    +
  • DataBase: Starts from the whole Hurricane DataBase.
    • +
  • Cell: Inspect the currently loaded Cell.
    • +
  • Selection: Inspect the object currently highlited in the Selection tab.
    • +
+

Once an entry point has been activated, you may recursively expore all +it’s fields using the right/left arrows.

+
+

Note

+

Do not put your fingers in the socket: when inspecting +anything, do not modify the DataBase. If any object under inspection +is deleted, you will crash the application...

+
+
+

Note

+

Implementation Detail: the inspector support is done with +Slot, Record and getString().

+
+

Controller Basic Snapshot + Controller Basic Snapshot + Controller Basic Snapshot

+
+
+

The Settings Tab

+

Here comes the description of the Settings tab.

+

Controller Basic Snapshot

+
+
+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/UsersGuide/index.html b/documentation/_build/html/UsersGuide/index.html new file mode 100644 index 00000000..7fff2eef --- /dev/null +++ b/documentation/_build/html/UsersGuide/index.html @@ -0,0 +1,375 @@ + + + + + + + + + + + + Coriolis User’s Guide — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Coriolis User’s Guide
    • +
  • + + + +
    • +
+
+
+
+ + + + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/Viewer/Viewer.html b/documentation/_build/html/Viewer/Viewer.html new file mode 100644 index 00000000..803dcc53 --- /dev/null +++ b/documentation/_build/html/Viewer/Viewer.html @@ -0,0 +1,336 @@ + + + + + + + + + + + + Viewer Reference — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+
+
    +
  • Docs »
    • + +
  • Viewer Reference
    • +
  • + + + +
    • +
+
+
+
+ +
+

Viewer Reference

+

The Viewer C++ API reference is generated by Doxygen and is +available here: Viewer

+
+ + +
+
+ + + + +
+ +
+ + + + + +
+ Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
+ + + + + +
Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
+
+ +
+ +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/_images/ComputerMouse.png b/documentation/_build/html/_images/ComputerMouse.png new file mode 100644 index 00000000..81b89ddf Binary files /dev/null and b/documentation/_build/html/_images/ComputerMouse.png differ diff --git a/documentation/_build/html/_images/Controller-1.png b/documentation/_build/html/_images/Controller-1.png new file mode 100644 index 00000000..964ddbf8 Binary files /dev/null and b/documentation/_build/html/_images/Controller-1.png differ diff --git a/documentation/_build/html/_images/Controller-Filter-1.png b/documentation/_build/html/_images/Controller-Filter-1.png new file mode 100644 index 00000000..71b669ba Binary files /dev/null and b/documentation/_build/html/_images/Controller-Filter-1.png differ diff --git a/documentation/_build/html/_images/Controller-Inspector-1.png b/documentation/_build/html/_images/Controller-Inspector-1.png new file mode 100644 index 00000000..618a1cde Binary files /dev/null and b/documentation/_build/html/_images/Controller-Inspector-1.png differ diff --git a/documentation/_build/html/_images/Controller-Inspector-2.png b/documentation/_build/html/_images/Controller-Inspector-2.png new file mode 100644 index 00000000..ac509d41 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Inspector-2.png differ diff --git a/documentation/_build/html/_images/Controller-Inspector-3.png b/documentation/_build/html/_images/Controller-Inspector-3.png new file mode 100644 index 00000000..0cb730b0 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Inspector-3.png differ diff --git a/documentation/_build/html/_images/Controller-LayersGos-1.png b/documentation/_build/html/_images/Controller-LayersGos-1.png new file mode 100644 index 00000000..fdcaa53d Binary files /dev/null and b/documentation/_build/html/_images/Controller-LayersGos-1.png differ diff --git a/documentation/_build/html/_images/Controller-Look-1.png b/documentation/_build/html/_images/Controller-Look-1.png new file mode 100644 index 00000000..1d095170 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Look-1.png differ diff --git a/documentation/_build/html/_images/Controller-Netlist-1.png b/documentation/_build/html/_images/Controller-Netlist-1.png new file mode 100644 index 00000000..b541b147 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Netlist-1.png differ diff --git a/documentation/_build/html/_images/Controller-Selection-1.png b/documentation/_build/html/_images/Controller-Selection-1.png new file mode 100644 index 00000000..326ab8d7 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Selection-1.png differ diff --git a/documentation/_build/html/_images/Controller-Settings-1.png b/documentation/_build/html/_images/Controller-Settings-1.png new file mode 100644 index 00000000..ef260368 Binary files /dev/null and b/documentation/_build/html/_images/Controller-Settings-1.png differ diff --git a/documentation/_build/html/_images/Coriolis-Soft-Schema.png b/documentation/_build/html/_images/Coriolis-Soft-Schema.png new file mode 100644 index 00000000..93c9135c Binary files /dev/null and b/documentation/_build/html/_images/Coriolis-Soft-Schema.png differ diff --git a/documentation/_build/html/_images/RDS_LCW.png b/documentation/_build/html/_images/RDS_LCW.png new file mode 100644 index 00000000..b6f22d24 Binary files /dev/null and b/documentation/_build/html/_images/RDS_LCW.png differ diff --git a/documentation/_build/html/_images/RDS_VW.png b/documentation/_build/html/_images/RDS_VW.png new file mode 100644 index 00000000..2bd2c1be Binary files /dev/null and b/documentation/_build/html/_images/RDS_VW.png differ diff --git a/documentation/_build/html/_images/SegmentOrientation.png b/documentation/_build/html/_images/SegmentOrientation.png new file mode 100644 index 00000000..4de3a6e4 Binary files /dev/null and b/documentation/_build/html/_images/SegmentOrientation.png differ diff --git a/documentation/_build/html/_images/Viewer-1.png b/documentation/_build/html/_images/Viewer-1.png new file mode 100644 index 00000000..01195845 Binary files /dev/null and b/documentation/_build/html/_images/Viewer-1.png differ diff --git a/documentation/_build/html/_images/Viewer-Netlist-1.png b/documentation/_build/html/_images/Viewer-Netlist-1.png new file mode 100644 index 00000000..6f357c0d Binary files /dev/null and b/documentation/_build/html/_images/Viewer-Netlist-1.png differ diff --git a/documentation/_build/html/_images/bigvia-1.png b/documentation/_build/html/_images/bigvia-1.png new file mode 100644 index 00000000..33a567d7 Binary files /dev/null and b/documentation/_build/html/_images/bigvia-1.png differ diff --git a/documentation/_build/html/_images/bigvia-2.png b/documentation/_build/html/_images/bigvia-2.png new file mode 100644 index 00000000..71f6b7e0 Binary files /dev/null and b/documentation/_build/html/_images/bigvia-2.png differ diff --git a/documentation/_build/html/_images/chip-structure-1.png b/documentation/_build/html/_images/chip-structure-1.png new file mode 100644 index 00000000..8af23393 Binary files /dev/null and b/documentation/_build/html/_images/chip-structure-1.png differ diff --git a/documentation/_build/html/_images/etesian-1.png b/documentation/_build/html/_images/etesian-1.png new file mode 100644 index 00000000..80552016 Binary files /dev/null and b/documentation/_build/html/_images/etesian-1.png differ diff --git a/documentation/_build/html/_images/math/0183b70ce5b7bb56d8ad838429a01d2858d99612.png b/documentation/_build/html/_images/math/0183b70ce5b7bb56d8ad838429a01d2858d99612.png new file mode 100644 index 00000000..ea9f234e Binary files /dev/null and b/documentation/_build/html/_images/math/0183b70ce5b7bb56d8ad838429a01d2858d99612.png differ diff --git a/documentation/_build/html/_images/math/642cf89034341e49c1fbc546ca776e1205ae49c0.png b/documentation/_build/html/_images/math/642cf89034341e49c1fbc546ca776e1205ae49c0.png new file mode 100644 index 00000000..c93ee4ca Binary files /dev/null and b/documentation/_build/html/_images/math/642cf89034341e49c1fbc546ca776e1205ae49c0.png differ diff --git a/documentation/_build/html/_images/math/6a2cfe8749bfed89e3c82527f74daaff6378d70e.png b/documentation/_build/html/_images/math/6a2cfe8749bfed89e3c82527f74daaff6378d70e.png new file mode 100644 index 00000000..1b39c2bb Binary files /dev/null and b/documentation/_build/html/_images/math/6a2cfe8749bfed89e3c82527f74daaff6378d70e.png differ diff --git a/documentation/_build/html/_images/math/7242aab75de488b349c95eca46e25a03ea80c207.png b/documentation/_build/html/_images/math/7242aab75de488b349c95eca46e25a03ea80c207.png new file mode 100644 index 00000000..82088e1c Binary files /dev/null and b/documentation/_build/html/_images/math/7242aab75de488b349c95eca46e25a03ea80c207.png differ diff --git a/documentation/_build/html/_images/math/d3499f8834024d33c997cd9730e31d3a02ebab18.png b/documentation/_build/html/_images/math/d3499f8834024d33c997cd9730e31d3a02ebab18.png new file mode 100644 index 00000000..adb6d5bf Binary files /dev/null and b/documentation/_build/html/_images/math/d3499f8834024d33c997cd9730e31d3a02ebab18.png differ diff --git a/documentation/_build/html/_images/math/e171f7265a6f90fdc6622dfa4a4fd08927ae5fea.png b/documentation/_build/html/_images/math/e171f7265a6f90fdc6622dfa4a4fd08927ae5fea.png new file mode 100644 index 00000000..23b1d137 Binary files /dev/null and b/documentation/_build/html/_images/math/e171f7265a6f90fdc6622dfa4a4fd08927ae5fea.png differ diff --git a/documentation/_build/html/_sources/Contents.txt b/documentation/_build/html/_sources/Contents.txt new file mode 100644 index 00000000..febd0e88 --- /dev/null +++ b/documentation/_build/html/_sources/Contents.txt @@ -0,0 +1,20 @@ +.. Coriolis documentation master file, created by + sphinx-quickstart on Mon Jul 10 15:08:36 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Comprenhensive Table of Contents +================================ + +.. toctree:: + + UsersGuide/index.rst + Stratus/Stratus.rst + DpGen/DpGen.rst + Patterns/Patterns.rst + Hurricane/Hurricane.rst + Viewer/Viewer.rst + CrlCore/CrlCore.rst + Unicorn/Unicorn.rst + PythonCpp/index.rst + RDS/index.rst diff --git a/documentation/_build/html/_sources/CrlCore/CrlCore.txt b/documentation/_build/html/_sources/CrlCore/CrlCore.txt new file mode 100644 index 00000000..d462e48e --- /dev/null +++ b/documentation/_build/html/_sources/CrlCore/CrlCore.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +==================== +CRL Core Reference +==================== + +The CRL Core C++ API reference is generated by Doxygen_ and is +available here: `CRL Core `_ diff --git a/documentation/_build/html/_sources/DpGen/DpGen.txt b/documentation/_build/html/_sources/DpGen/DpGen.txt new file mode 100644 index 00000000..0d8324d1 --- /dev/null +++ b/documentation/_build/html/_sources/DpGen/DpGen.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================= +DpGen Reference +================= + +The DpGen extension of the Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `DpGen `_ diff --git a/documentation/_build/html/_sources/Hurricane/Hurricane.txt b/documentation/_build/html/_sources/Hurricane/Hurricane.txt new file mode 100644 index 00000000..4b1ec994 --- /dev/null +++ b/documentation/_build/html/_sources/Hurricane/Hurricane.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +===================== +Hurricane Reference +===================== + +The Hurricane C++ API reference is generated by Doxygen_ and is +available here: `Hurricane `_ diff --git a/documentation/_build/html/_sources/Katabatic/Katabatic.txt b/documentation/_build/html/_sources/Katabatic/Katabatic.txt new file mode 100644 index 00000000..10f35831 --- /dev/null +++ b/documentation/_build/html/_sources/Katabatic/Katabatic.txt @@ -0,0 +1,14 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +===================== +Katabatic Reference +===================== + +The Katabatic C++ API reference is generated by Doxygen_ and is +available here: `Katana `_ + +.. note:: The Katabatic API has served as a base for it's + mixed signal conterpart **Anabatic**. diff --git a/documentation/_build/html/_sources/Kite/Kite.txt b/documentation/_build/html/_sources/Kite/Kite.txt new file mode 100644 index 00000000..41450be3 --- /dev/null +++ b/documentation/_build/html/_sources/Kite/Kite.txt @@ -0,0 +1,14 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================= +Kite Reference +================= + +The Kite C++ API reference is generated by Doxygen_ and is +available here: `Kite `_ + +.. note:: The Kite API has also served has a base for it's + mixed-signal conterpart Katana (:sc:`Kit[e]-Ana[logic]`). diff --git a/documentation/_build/html/_sources/Patterns/Patterns.txt b/documentation/_build/html/_sources/Patterns/Patterns.txt new file mode 100644 index 00000000..66c4791c --- /dev/null +++ b/documentation/_build/html/_sources/Patterns/Patterns.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +==================== +Patterns Reference +==================== + +The Patterns extension of the Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `Patterns `_ diff --git a/documentation/_build/html/_sources/PythonCpp/Configuration.txt b/documentation/_build/html/_sources/PythonCpp/Configuration.txt new file mode 100644 index 00000000..2e9d11e9 --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/Configuration.txt @@ -0,0 +1,42 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +2. Basic File Structure and CMake configuration +================================================= + +As a first example we will consider the ``Hurrican::Library`` +class. To export a class into Python, we must create three files: + +#. ``PyLibrary.h``, defines the ``PyLibrary`` C-Struct and the functions + needed outside the module istself (mostly for ``PyHurricane.cpp``). + +#. ``PyLibrary.cpp``, contains the complete wrapping of the class and + the Python type definition (``PyTypeLibrary``). + +#. ``PyHurricane.cpp``, the definition of the Python module into which + the classes are registered. The module act as a ``namespace`` in + Python so it is good practice to give it the same name as it's + associated C++ namespace. + +|newpage| + +To build a Python module in |cmake|, use the following macro: + + .. code-block:: cmake + + set( pyCpps PyLibrary.cpp + PyHurricane.cpp ) + set( pyIncludes hurricane/isobar/PyLibrary.h + + add_python_module( "${pyCpps}" + "${pyIncludes}" + "isobar;1.0;1" # Name & version of the supporting + # shared library. + Hurricane # Name of the Python module will give: + # Hurricane.so + "${depLibs}" # List of dependency libraries. + include/coriolis2/hurricane/isobar + # Where to install the include files. + ) diff --git a/documentation/_build/html/_sources/PythonCpp/DBoHierarchy.txt b/documentation/_build/html/_sources/PythonCpp/DBoHierarchy.txt new file mode 100644 index 00000000..4c72bf3b --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/DBoHierarchy.txt @@ -0,0 +1,439 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +|newpage| + + +4. Case 2 - Hierarchy of DBo Derived Classes +============================================== + +Now we want to export the following C++ class hierarchy into Python: :: + + PyEntity <-- PyComponent <-+- PyContact + +- PySegment <-+- PyHorizontal + +- PyVertical + + +4.1 Base Class Header +~~~~~~~~~~~~~~~~~~~~~~~ + +**Remark:** this is only a partial description of the tree for the sake of +clarity. + +One important fact to remember is that ``PyEntity`` and ``PyComponent`` +being related to C++ abstract classes, no objects of those types will be +created, only ``PyContact``, ``PyHorizontal`` or ``PyVertical`` will. + +The consequence is that there is no ``PyEntity_Link()`` like in :ref:`3.1` +but instead two functions: + +#. ``PyEntity_NEW()`` which create the relevant ``PyEntity`` *derived* + object from the ``Entity`` one. For example, if the ``Entity*`` given + as argument is in fact a ``Horizontal*``, then the function will + return a ``PyHorizontal*``. + +#. ``EntityCast()`` do the reverse of ``PyEntity_NEW()`` that is, from + a ``PyEntity``, return the C++ *derived* object. Again, if the + ``PyEntity*`` is a ``PyHorizontal*``, the function will cast it as + a ``Horizontal*`` *then* return it as an ``Entity*``. + +.. code-block:: python + + #ifndef ISOBAR_PY_ENTITY_H + #define ISOBAR_PY_ENTITY_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Entity.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyObject_HEAD + Hurricane::Entity* _object; + } PyEntity; + + extern PyObject* PyEntity_NEW ( Hurricane::Entity* entity ); + extern void PyEntity_LinkPyType (); + extern PyTypeObject PyTypeEntity; + extern PyMethodDef PyEntity_Methods[]; + + + #define IsPyEntity(v) ( (v)->ob_type == &PyTypeEntity ) + #define PYENTITY(v) ( (PyEntity*)(v) ) + #define PYENTITY_O(v) ( PYENTITY(v)->_object ) + + } // extern "C". + + Hurricane::Entity* EntityCast ( PyObject* derivedObject ); + + } // Isobar namespace. + + #endif // ISOBAR_PY_ENTITY_H + +|newpage| + + +4.2 Base Class File +~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File` are: + +#. No call to ``DBoLinkCreateMethod()`` because there must be no ``PyEntity_Link()``, + but the definitions of ``PyEntity_NEW()`` and ``EntityCast``. + +#. For defining the ``PyTypeEntity`` Python type, we call a different + macro: ``PyTypeRootObjectDefinitions``, dedicated to base classes. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyCell.h" + #include "hurricane/isobar/PyHorizontal.h" + #include "hurricane/isobar/PyVertical.h" + #include "hurricane/isobar/PyContact.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #if defined(__PYTHON_MODULE__) + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Entity,entity,function) + + DBoDestroyAttribute(PyEntity_destroy ,PyEntity) + + static PyObject* PyEntity_getCell ( PyEntity *self ) + { + Cell* cell = NULL; + HTRY + METHOD_HEAD( "Entity.getCell()" ) + cell = entity->getCell(); + HCATCH + return PyCell_Link( cell ); + } + + PyMethodDef PyEntity_Methods[] = + { { "getCell", (PyCFunction)PyEntity_getCell, METH_NOARGS + , "Returns the entity cell." } + , { "destroy", (PyCFunction)PyEntity_destroy, METH_NOARGS + , "Destroy associated hurricane object, the python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + + DBoDeleteMethod(Entity) + PyTypeObjectLinkPyType(Entity) + + #else // End of Python Module Code Part. + + PyObject* PyEntity_NEW ( Entity* entity ) + { + if (not entity) { + PyErr_SetString ( HurricaneError, "Invalid Entity (bad occurrence)" ); + return NULL; + } + + Horizontal* horizontal = dynamic_cast(entity); + if (horizontal) return PyHorizontal_Link( horizontal ); + + Vertical* vertical = dynamic_cast(entity); + if (vertical) return PyVertical_Link( vertical ); + + Contact* contact = dynamic_cast(entity); + if (contact) return PyContact_Link( contact ); + + Py_RETURN_NONE; + } + + PyTypeRootObjectDefinitions(Entity) + + #endif // Shared Library Code Part (1). + + } // extern "C". + + + #if !defined(__PYTHON_MODULE__) + + Hurricane::Entity* EntityCast ( PyObject* derivedObject ) { + if (IsPyHorizontal(derivedObject)) return PYHORIZONTAL_O(derivedObject); + if (IsPyVertical (derivedObject)) return PYVERTICAL_O(derivedObject); + if (IsPyContact (derivedObject)) return PYCONTACT_O(derivedObject); + return NULL; + } + + #endif // Shared Library Code Part (2). + + } // Isobar namespace. + +|newpage| + + +4.3 Intermediate Class Header +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.1 Class Associated Header File` are: + +#. As for ``PyEntity``, and because this is still an abstract class, + there is no ``PyComponent_Link()`` function. + +#. The definition of the ``PyComponent`` |struct| is differs. There is + no ``PyObject_HEAD`` (it is a Python *derived* class). The only + field is of the base class type ``PyEntity`` and for use with + Coriolis macros, **it must** be named ``_baseObject`` (note that + this is *not* a pointer but a whole object). + +.. code-block:: c++ + + #ifndef ISOBAR_PY_COMPONENT_H + #define ISOBAR_PY_COMPONENT_H + + #include "hurricane/isobar/PyEntity.h" + #include "hurricane/Component.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyEntity _baseObject; + } PyComponent; + + extern PyTypeObject PyTypeComponent; + extern PyMethodDef PyComponent_Methods[]; + extern void PyComponent_LinkPyType (); + + #define IsPyComponent(v) ((v)->ob_type == &PyTypeComponent) + #define PYCOMPONENT(v) ((PyComponent*)(v)) + #define PYCOMPONENT_O(v) (static_cast(PYCOMPONENT(v)->_baseObject._object)) + + } // extern "C". + } // Isobar namespace. + + #endif + + +4.4 Intermediate Class File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File` are: + +1. Redefinition of the default macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. + + * The pointer to the C++ encapsulated object (attribute ``_object``) is hold + by the base class ``PyEntity``. The ``ACCESS_OBJECT`` macro which is tasked + to give access to that attribute is then ``_baseObject._object`` as + ``PyComponent`` is a direct derived class of ``PyEntity``. + + * ``ACCESS_CLASS`` is similar to ``ACCESS_OBJECT`` for accessing the base + class, that is a pointer to ``PyEntity``. + +|newpage| + +2. For defining the ``PyTypeComponent`` Python type, we call a yet different + macro: ``PyTypeInheritedObjectDefinitions()``, dedicated to derived classes. + For this this macro we need to give as argument the derived class and the + base class. + +.. code-block:: c++ + + #include "hurricane/isobar/PyComponent.h" + #include "hurricane/isobar/PyNet.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #undef ACCESS_OBJECT + #undef ACCESS_CLASS + #define ACCESS_OBJECT _baseObject._object + #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject) + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Component,component,function) + + #if defined(__PYTHON_MODULE__) + + DirectGetLongAttribute(PyComponent_getX,getX,PyComponent,Component) + DirectGetLongAttribute(PyComponent_getY,getY,PyComponent,Component) + DBoDestroyAttribute(PyComponent_destroy,PyComponent) + + static PyObject* PyComponent_getNet ( PyComponent *self ) + { + Net* net = NULL; + HTRY + METHOD_HEAD( "Component.getNet()" ) + net = component->getNet( ); + HCATCH + return PyNet_Link( net ); + } + + PyMethodDef PyComponent_Methods[] = + { { "getX" , (PyCFunction)PyComponent_getX , METH_NOARGS + , "Return the Component X value." } + , { "getY" , (PyCFunction)PyComponent_getY , METH_NOARGS + , "Return the Component Y value." } + , { "getNet" , (PyCFunction)PyComponent_getNet , METH_NOARGS + , "Returns the net owning the component." } + , { "destroy", (PyCFunction)PyComponent_destroy, METH_NOARGS + , "destroy associated hurricane object, the python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DBoDeleteMethod(Component) + PyTypeObjectLinkPyType(Component) + + #else // Python Module Code Part. + + PyTypeInheritedObjectDefinitions(Component, Entity) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +4.5 Terminal Class Header +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The contents of this file is almost identical to `4.3 Intermediate Class Header`_, +save for the presence of a ``PyContact_Link()`` function. She is present +at this level because the class is a concrete one and can be instanciated. + +.. code-block:: c++ + + #ifndef ISOBAR_PY_CONTACT_H + #define ISOBAR_PY_CONTACT_H + + #include "hurricane/isobar/PyComponent.h" + #include "hurricane/Contact.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyComponent _baseObject; + } PyContact; + + extern PyTypeObject PyTypeContact; + extern PyMethodDef PyContact_Methods[]; + extern PyObject* PyContact_Link ( Hurricane::Contact* object ); + extern void PyContact_LinkPyType (); + + #define IsPyContact(v) ( (v)->ob_type == &PyTypeContact ) + #define PYCONTACT(v) ( (PyContact*)(v) ) + #define PYCONTACT_O(v) ( PYCONTACT(v)->_baseObject._baseObject._object ) + + } // extern "C". + } // Isobar namespace. + + #endif // ISOBAR_PY_CONTACT_H + + +4.6 Terminal Class File +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Changes from `4.4 Intermediate Class File`_ are: + +#. As previously, we have to redefine the macros ``ACCESS_OBJECT`` and ``ACCESS_CLASS``. + But, as we are one level deeper into the hierarchy, one more level of + indirection using ``_baseObject`` must be used. + + * ``ACCESS_OBJECT`` becomes ``_baseObject._baseObject._object``. + + * ``ACCESS_CLASS`` becomes ``&(_pyObject->_baseObject._baseObject)``. + +#. For defining the ``PyTypeContact`` Python type, we call again + ``PyTypeInheritedObjectDefinitions()``. It is the same whether the class is + terminal or not. + +#. And, this time, as the Python class is concrete, we call the macro + ``DBoLinkCreateMethod()`` to create the ``PyContact_Link()`` function. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyContact.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #undef ACCESS_OBJECT + #undef ACCESS_CLASS + #define ACCESS_OBJECT _baseObject._baseObject._object + #define ACCESS_CLASS(_pyObject) &(_pyObject->_baseObject._baseObject) + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Contact,contact,function) + + #if defined(__PYTHON_MODULE__) + + DirectGetLongAttribute(PyContact_getWidth , getWidth , PyContact,Contact) + DirectGetLongAttribute(PyContact_getHeight, getHeight, PyContact,Contact) + DBoDestroyAttribute(PyContact_destroy, PyContact) + + static PyObject* PyContact_create ( PyObject*, PyObject *args ) + { + Contact* contact = NULL; + HTRY + // Usual signature then arguments parsing. + HCATCH + return PyContact_Link(contact); + } + + PyMethodDef PyContact_Methods[] = + { { "create" , (PyCFunction)PyContact_create , METH_VARARGS|METH_STATIC + , "Create a new Contact." } + , { "destroy" , (PyCFunction)PyContact_destroy , METH_NOARGS + , "Destroy associated hurricane object, the python object remains." } + , { "getWidth" , (PyCFunction)PyContact_getWidth , METH_NOARGS + , "Return the contact width." } + , { "getHeight", (PyCFunction)PyContact_getHeight, METH_NOARGS + , "Return the contact height." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DBoDeleteMethod(Contact) + PyTypeObjectLinkPyType(Contact) + + #else // Python Module Code Part. + + DBoLinkCreateMethod(Contact) + PyTypeInheritedObjectDefinitions(Contact, Component) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +4.8 Python Module +~~~~~~~~~~~~~~~~~~~ + +.. code-block:: c++ + + DL_EXPORT(void) initHurricane () + { + PyEntity_LinkPyType(); // step 1. + PyComponent_LinkPyType(); + PyContact_LinkPyType(); + + PYTYPE_READY( Entity ) // step 2. + PYTYPE_READY_SUB( Component, Entity ) + PYTYPE_READY_SUB( Contact , Component ) + + __cs.addType( "ent" , &PyTypeEntity , "" , false ); // step 3. + __cs.addType( "comp" , &PyTypeComponent, "", false, "ent" ); + __cs.addType( "contact", &PyTypeContact , "" , false, "comp" ); + + PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); + if (module == NULL) { + cerr << "[ERROR]\n" + << " Failed to initialize Hurricane module." << endl; + return; + } + + Py_INCREF( &PyTypeContact ); // step 4. + PyModule_AddObject( module, "Contact", (PyObject*)&PyTypeContact ); // step 4. + } diff --git a/documentation/_build/html/_sources/PythonCpp/DBoStandalone.txt b/documentation/_build/html/_sources/PythonCpp/DBoStandalone.txt new file mode 100644 index 00000000..36cdb46e --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/DBoStandalone.txt @@ -0,0 +1,395 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +3. Case 1 - DBo Derived, Standalone +====================================== + +As example, we take ``Library``. This a ``DBo`` derived class, but we +choose not to export the parent classes. From Python, it will appear +as a base class. + +.. _3.1: + +.. _3.1 Class Associated Header File: + +3.1 Class Associated Header File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Here is the typical content of a header file (for ``PyLibrary``): + +.. code-block:: c++ + + #ifndef PY_LIBRARY_H + #define PY_LIBRARY_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Library.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + typedef struct { + PyObject_HEAD + Library* _object; + } PyLibrary; + + extern PyTypeObject PyTypeLibrary; + extern PyMethodDef PyLibrary_Methods[]; + extern PyObject* PyLibrary_Link ( Hurricane::Library* lib ); + extern void PyLibrary_LinkPyType (); + + + #define IsPyLibrary(v) ( (v)->ob_type == &PyTypeLibrary ) + #define PYLIBRARY(v) ( (PyLibrary*)(v) ) + #define PYLIBRARY_O(v) ( PYLIBRARY(v)->_object ) + + } // extern "C". + } // Isobar namespace. + + #endif // PY_LIBRARY_H + + +The code is organized as follow: + +1. It must have, *as the first include* ``PyHurricane.h``, which provides + the complete bunch of macros needed to build the module. Then the include + of the C++ class we want to wrap (``Library.h``). + +2. As Python is written in C, all the wrapper code has to be but inside + an ``extern "C"`` namespace. + +3. Definition of the wrapped |struct|, ``PyLibrary``. It is standard Python here. + + .. note:: + For our set of macros to work, the name of the pointer to the + C++ class must always be **_object**, and the various functions and + macros defined here must take the name of the class (either in + lowercase, camel case or capitals). + +4. Declaration of the Python type ``PyTypeLibrary`` (standard). + +5. Declaration of the Python type table of methods ``PyLibrary_Methods`` (standard). + +.. _3.6: + +6. Declaration of ``PyLibrary_Link()``, helper to convert a C++ ``Lybrary`` into + a ``PyLibrary`` (put in the support shared library). + +7. Declaration of ``PyLibrary_LinkPyType()``, this function setup the class-level + function of the new Python type (here, ``PyTypeLibrary``). + +8. And, lastly, three macros to: + + * ``IsPylibrary()``, know if a Python object is a ``PyLibrary`` + * ``PYLIBRARY()``, force cast (C style) of a ``PyObject`` into a ``PyLibrary``. + * ``PYLIBRARY_O()``, extract the C++ object (``Library*``) from the Python + object (``PyLibrary``). + + +.. _3.2 Class Associated File: + +3.2 Class Associated File +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +3.2.1 Head of the file +------------------------ + +.. code-block:: c++ + + #include "hurricane/isobar/PyLibrary.h" + #include "hurricane/isobar/PyDataBase.h" + #include "hurricane/isobar/PyCell.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Library,lib,function) + +As for the header, all the code must be put inside a ``extern "C"`` namespace. + +A convenience macro ``METHOD_HEAD()`` must be defined, by refining +``GENERIC_METHOD_HEAD()``. This macro will be used in the method wrappers +below to cast the ``_object`` field of the Python object into the +appropriate C++ class, this is done using a C-style cast. +The parameters of that macro are: + +#. The C++ encapsulated class (``Library``). +#. The name of the *variable* that will be used to store a pointer + to the C++ working object. +#. The name of the C++ method which is to be wrapped. + + +3.2.2 The Python Module Part +------------------------------ + +First, we have to build all the wrappers to the C++ methods of +the class. For common predicates, accessors, and mutators macros +are supplied. + +Wrapping of the ``Library::getCell()`` method: + +.. code-block:: c++ + + static PyObject* PyLibrary_getCell ( PyLibrary* self, PyObject* args ) + { + Cell* cell = NULL; + + HTRY + METHOD_HEAD( "Library.getCell()" ) + char* name = NULL; + if (PyArg_ParseTuple(args,"s:Library.getCell", &name)) { + cell = lib->getCell( Name(name) ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library::getCell." ); + return NULL; + } + HCATCH + + return PyCell_Link(cell); + } + +Key points about this method wrapper: + +#. The ``HTRY`` / ``HCATCH`` macros provides an insulation from the C++ + exceptions. If one is emitted, it will be catched and transformed in + a Python one. This way, the Python program will be cleanly interrupted + and the usual stack trace displayed. + +#. The returned value of this method is of type ``Cell*``, we have to + transform it into a Python one. This is done with ``PyCell_Link()``. + This macro is supplied by the ``PyCell.h`` header and this is why + it must be included. + +|newpage| + + +Wrapping of the ``Library::create()`` method: + +.. code-block:: c++ + + static PyObject* PyLibrary_create( PyObject*, PyObject* args ) + { + PyObject* arg0; + PyObject* arg1; + Library* library = NULL; + + HTRY + __cs.init( "Library.create" ); // Step (1). + if (not PyArg_ParseTuple( args, "O&O&:Library.create" + , Converter, &arg0 + , Converter, &arg1 )) { // Step (2). + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library constructor." ); + return NULL; + } + if (__cs.getObjectIds() == ":db:string") { // Step (3.a) + DataBase* db = PYDATABASE_O(arg0); + library = Library::create( db, Name(PyString_AsString(arg1)) ); + } else if (__cs.getObjectIds() == ":library:string") { // Step (3.b) + Library* masterLibrary = PYLIBRARY_O(arg0); + library = Library::create( masterLibrary, Name(PyString_AsString(arg1)) ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Library constructor." ); + return NULL; + } + HCATCH + + return PyLibrary_Link( library ); + } + +Key point about this constructor: + +#. We want the Python interface to mimic as closely as possible the + C++ API. As such, Python object will be created using a static + ``.create()`` method. So we do not use the usual Python allocation + mechanism. + +#. As it is a *static* method, there is no first argument. + +#. Python do not allow function overload like C++. To emulate that + behavior we use the ``__cs`` object (which is a global variable). + + #. Init/reset the ``__cs`` object: see *step (1)*. + + #. Call ``PyArg_ParseTuple()``, read every mandatory or optional + argument as a Python object (``"O&"``) and use ``Converter`` + on each one. ``Converter`` will determine the real type of + the Python object given as argument by looking at the + encapsulated C++ class. It then update the ``__cs`` object. + Done in *step (2)* + + #. After the call to ``PyArg_ParseTuple()``, the function + ``__cs.getObjectIds()`` will return the *signature* of + the various arguments. In our case, the valid signatures + will be ``":db:string"`` (*step (3.a)*a) and ``":library:string"`` + (*step (3.b)*). + + #. Call the C++ method after extracting the C++ objects from + the Python arguments. Note the use of the ``PYLIBRARY_O()`` + and ``PYDATABSE_O()`` macros to perform the conversion. + +#. Return the result, encapsulated through a call to ``PyLibrary_Link()``. + +|newpage| + + +Wrapping of the ``Library::destroy()`` method: + +.. code-block:: c++ + + DBoDestroyAttribute(PyLibrary_destroy, PyLibrary) + +For C++ classes **that are derived** from ``DBo``, the destroy method +wrapper must be defined using the macro ``DBoDestroyAttribute()``. +This macro implements the bi-directional communication mechanism +using ``Hurricane::Property``. It **must not** be used for +non ``DBo`` derived classes. + + +Defining the method table of the PyLibrary type: + +.. code-block:: c++ + + PyMethodDef PyLibrary_Methods[] = + { { "create" , (PyCFunction)PyLibrary_create , METH_VARARGS|METH_STATIC + , "Creates a new library." } + , { "getCell" , (PyCFunction)PyLibrary_getCell, METH_VARARGS + , "Get the cell of name " } + , { "destroy" , (PyCFunction)PyLibrary_destroy, METH_NOARGS + , "Destroy associated hurricane object The python object remains." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + +This is standard Python/C API. The name of the ``PyMethodDef`` table must be +named from the class: ``PyLibrary_Methods``. + + +3.2.3 Python Type Linking +--------------------------- + +Defining the ``PyTypeLibrary`` class methods and the type linking function. + +Those are the functions for the Python object itself to work, not the +wrapped method from the C++ class. + +.. note:: + At this point we **do not** define the ``PyTypeLibrary`` itself. + Only it's functions and a function to set them up *once* the + type will be defined. + +.. code-block:: c++ + + DBoDeleteMethod(Library) + PyTypeObjectLinkPyType(Library) + + +The macro ``DBoDeleteMethod()`` define the function to delete a +``PyLibrary`` *Python* object. Again, do not mistake it for the deletion +of the C++ class (implemented by ``DBoDestroyAttribute()``). +Here again, ``DBoDeleteMethod()`` is specially tailored for +``DBo`` derived classes. + +.. _PyLibrary_LinkPyType(): + +To define ``PyLibrary_LinkPyType()``, use the ``PyTypeObjectLinkPyType()`` +macro. This macro is specific for ``DBo`` derived classes that are seen as +base classes under Python (i.e. we don't bother exposing the base +class under Python). ``PyLibrary_LinkPyType()`` setup the class functions +in the ``PyTypeLibrary`` type object, it **must** be called in the +Python module this class is part of (in this case: ``PyHurricane.cpp``). +This particular flavor of the macro *will define* and setup the +following class functions: + +* ``PyTypeLibrary.tp_compare`` (defined by the macro). +* ``PyTypeLibrary.tp_repr`` (defined by the macro). +* ``PyTypeLibrary.tp_str`` (defined by the macro). +* ``PyTypeLibrary.tp_hash`` (defined by the macro). +* ``PyTypeLibrary.tp_methods`` sets to the previously defined ``PyLibrary_Methods`` table. +* ``PyTypeLibrary.tp_dealloc`` is set to a function that *must* be named ``PyLibrary_DeAlloc``, + this is what ``DBoDeleteMethod`` does. It is *not* done by ``PyTypeObjectLinkPyType``. + +Defining the ``PyTypeLibrary`` type: + + +3.2.4 The Shared Library Part +------------------------------- + +This part will be put in a separate supporting shared library, allowing +other Python module to link against it (and make use of its symbols). + +.. code-block:: c++ + + DBoLinkCreateMethod(Library) + PyTypeObjectDefinitions(Library) + + +To define ``PyTypeLibrary``, use the ``PyTypeObjectDefinitions()`` macro. +This macro is specific for classes that, as exposed by Python, +are neither *derived* classes nor *base* classes for others. +That is, they are standalone from the inheritance point of view. + +The ``DBoLinkCreateMethod()`` macro will define the ``PyLibrary_Link()`` +function which is responsible for encapsulating a C++ ``Library`` object +into a Python ``PyLibrary`` one. + + +3.3 Python Module (C++ namespace) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We use the Python module to replicate the C++ *namespace*. Thus, for the +``Hurricane`` namespace we create a Python ``Hurricane`` module which is +defined in the ``PyHurricane.cpp`` file, then we add into that module +dictionary all the Python types encapsulating the C++ classes of that +namespace. + +.. code-block:: c++ + + DL_EXPORT(void) initHurricane () + { + PyLibrary_LinkPyType(); // step 1. + + PYTYPE_READY( Library ) // step 2. + + __cs.addType( "library", &PyTypeLibrary, "", false ); // step 3. + + PyObject* module = Py_InitModule( "Hurricane", PyHurricane_Methods ); + if (module == NULL) { + cerr << "[ERROR]\n" + << " Failed to initialize Hurricane module." << endl; + return; + } + + Py_INCREF( &PyTypeLibrary ); // step 4. + PyModule_AddObject( module, "Library", (PyObject*)&PyTypeLibrary ); // step 4. + } + +The ``initHurricane()`` initialisation function shown above has +been scrubbed of everything not relevant to the ``PyLibrary`` class. +The integration of the ``PyLibrary`` class into the module needs +four steps: + +#. A call to `PyLibrary_LinkPyType()`_ to hook the Python type functions + in the Python type object. + +#. A call to the ``PYTYPE_READY()`` macro (standard Python). + +#. Registering the type into the ``__cs`` object, with ``addType()``. + The arguments are self explanatory, save for the last which is a + boolean to tell if this is a *derived* class or not. + +#. Adding the type object (``PyTypeLibrary``) into the dictionnary of + the module itself. This allow to mimic closely the C++ syntax: + + .. code-block:: python + + import Hurricane + lib = Hurricane.Library.create( db, 'root' ) diff --git a/documentation/_build/html/_sources/PythonCpp/DbU.txt b/documentation/_build/html/_sources/PythonCpp/DbU.txt new file mode 100644 index 00000000..930e76d1 --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/DbU.txt @@ -0,0 +1,67 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +6. Encapsulating DbU +====================== + +While ``Hurricane::DbU`` is a class, the ``Hurricane::DbU::Unit`` is only +a ``typedef`` over ``uint64_t``. The ``DbU`` class only provides a set of +static methods to manipulate and convert to and from other units. +At Python level, ``DbU::Unit`` will be stored in plain ``long long``. + +When a ``DbU::Unit`` argument is expected in a Python functions, just use +the ``DbU::Unit PyAny_AsLong( PyObject* )`` function to convert it. + +For example, if we explicit the expension of: + +.. code-block:: c++ + + DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) + +|newpage| + +We would get: + +.. code-block:: c++ + + static PyObject* PyPoint_setX ( PyPoint *self, PyObject* args ) + { + Point* cobject = static_cast( self->_object ); + if (cobject == NULL) { + PyErr_SetString( ProxyError + , "Attempt to call Point.setX() on an unbound Hurricane object" ); + return NULL; + } + + HTRY + PyObject* arg0 = NULL; + if (not PyArg_ParseTuple( args, "O:Point.setX()", &arg0 )) + return ( NULL ); + cobject->setX( Isobar::PyAny_AsLong(arg0) ); + HCATCH + Py_RETURN_NONE; + } + + +For the other way around, use ``PyObject* PyDbU_FromLong( DbU::Unit )``. + +.. code-block:: c++ + + DirectGetLongAttribute(PyPoint_GetX,getX,PyPoint,Point) + +We would get: + +.. code-block:: c++ + + static PyObject* PyPoint_GetX ( PyPoint *self, PyObject* args ) + { + Point* cobject = static_cast( self->_object ); + if (cobject == NULL) { + PyErr_SetString( ProxyError + , "Attempt to call Point.getX() on an unbound Hurricane object" ); + return NULL; + } + return Isobar::PyDbU_FromLong(cobject->getX()); + } diff --git a/documentation/_build/html/_sources/PythonCpp/Introduction.txt b/documentation/_build/html/_sources/PythonCpp/Introduction.txt new file mode 100644 index 00000000..5a3300e4 --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/Introduction.txt @@ -0,0 +1,185 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +1. Introduction +================= + +* This document is written for people already familiar with the + `Python/C API Reference Manual`_. + +* The macros provided by the Hurricane Python/C API are written using + the standard Python C/API. That is, you may not use them and write + directly your functions with the original API or any mix between. + You only have to respect some naming convention. + +* Coriolis is build against Python 2.7. + + +1.1 First, A Disclaimer +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Hurricane Python/C++ API has been written about ten years ago, at a time +my mastering of template programming was less than complete. This is why this +interface is build with old fashioned C macro instead of C++ template. + +It is my hope that at some point in the future I will have time to completly +rewrite it, borrowing the interface from ``boost::python``. + + +1.2 About Technical Choices +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Some would say, why not use *off the shelf* wrappers like ``swig`` +or ``boost::python``, here are some clues. + +#. **Partial exposure of the C++ class tree.** We expose at Python level + C++ base classes, only if they provides common methods that we want + to see. Otherwise, we just show them as base classes under Python. + For instance ``Library`` is derived from ``DBo``, but we won't see + it under Python. + +#. **Bi-directional communication.** When a Python object is deleted, the + wrapper obviously has a pointer toward the underlying C++ object and + is able to delete it. But, the reverse case can occurs, meaning that + you have a C++ object wrapped in Python and the database delete the + underlying object. The wrapped Python object *must* be informed that + it no longer refer a valid C++ one. Moreover, as we do not control + when Python objects gets deleteds (that is, when their reference count + reaches zero), we can have valid Python object with a dangling + C++ pointer. So our Python objects can be warned by the C++ objects + that they are no longer valid and any other operation than the + deletion should result in a severe non-blocking error. + + To be precise, this apply to persistent object in the C++ database, + like ``Cell``, ``Net``, ``Instance`` or ``Component``. Short lived + objects like ``Box`` or ``Point`` retains the classic Python behavior. + + Another aspect is that, for all derived ``DBo`` objects, one and only + one Python object is associated. For one given ``Instance`` object we + will always return the *same* ``PyInstance`` object, thanks to the + bi-directional link. Obviously, the *reference count* of the + ``PyInstance`` is managed accordingly. This mechanism is implemented + by the ``PyInstance_Link()`` function. + +#. **Linking accross modules.** As far as I understand, the wrappers + are for monolithic libraries. That is, you wrap the entire library + in one go. But Hurricane has a modular design, the core database + then various tools. We do not, and cannot, have one gigantic wrapper + that would encompass all the libraries in one go. We do one Python + module for one C++ library. + + This brings another issue, at Python level this time. The Python + modules for the libraries have to share some functions. Python + provides a mechanism to pass C function pointers accross modules, + but I did found it cumbersome. Instead, all our modules are split + in two: + + * The first part contains the classic Python module code. + * The second part is to be put in a separate dynamic library that + will hold the shared functions. The Python module is dynamically linked + against that library like any other. And any other Python module + requiring the functions will link against the associated shared + library. + + Each module file will be compiled *twice*, once to build the Python + module (``__PYTHON_MODULE`` is defined) and once to build the supporting + shared library (``__PYTHON_MODULE__`` **not** defined). This tricky + double compilation is taken care of though the ``add_python_module`` + ``cmake`` macro. + + For the core Hurricane library we will have: + + * ``Hurricane.so`` the Python module (use with: ``import Hurricane``). + * ``libisobar.so.1.0`` the supporting shared library. + + The ``PyLibrary.cpp`` file will have the following structure: + + .. code-block:: c++ + + #include "hurricane/isobar/PyLibrary.h" + + namespace Isobar { + + extern "C" { + + #if defined(__PYTHON_MODULE__) + + // +=================================================================+ + // | "PyLibrary" Python Module Code Part | + // +=================================================================+ + // + // The classic part of a Python module. Goes into Hurricane.so. + + + #else // End of Python Module Code Part. + + // x=================================================================x + // | "PyLibrary" Shared Library Code Part | + // x=================================================================x + // + // Functions here will be part of the associated shared library and + // made available to all other Python modules. Goes into libisobar.so.1.0 + + + # endif // Shared Library Code Part. + + } // extern "C". + + } // Isobar namespace. + + + This way, we do not rely upon a pointer transmission through Python + modules, but directly uses linker capabilities. + + +1.3 Botched Design +~~~~~~~~~~~~~~~~~~~~ + +The mechanism to compute the signature of a call to a Python function, +the ``__cs`` object, is much too complex and, in fact, not needed. +At some point I may root it out, but it is used in so many places... + +What I should have used the ``"O!"`` capablity of ``PyArg_ParseTuple()``, +like in the code below: + +|newpage| + +.. code-block:: c++ + + static PyObject* PyContact_create ( PyObject*, PyObject *args ) + { + Contact* contact = NULL; + HTRY + PyNet* pyNet = NULL; + PyLayer* pyLayer = NULL; + PyComponent* pyComponent = NULL; + DbU::Unit x = 0; + DbU::Unit y = 0; + DbU::Unit width = 0; + DbU::Unit height = 0; + + if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" + , &PyTypeNet , &pyNet + , &PyTypeLayer, &pyLayer + , &x, &y, &width, &height)) { + contact = Contact::create( PYNET_O(pyNet), PYLAYER_O(pyLayer) + , x, y, width, height ); + } else { + PyErr_Clear(); + if (PyArg_ParseTuple( args, "O!O!ll|ll:Contact.create" + , &PyTypeComponent, &pyComponent + , &PyTypeLayer , &pyLayer + , &x, &y, &width, &height)) { + contact = Contact::create( PYCOMPONENT_O(pyComponent), PYLAYER_O(pyLayer) + , x, y, width, height ); + } else { + PyErr_SetString( ConstructorError + , "invalid number of parameters for Contact constructor." ); + return NULL; + } + } + HCATCH + return PyContact_Link( contact ); + } diff --git a/documentation/_build/html/_sources/PythonCpp/Name.txt b/documentation/_build/html/_sources/PythonCpp/Name.txt new file mode 100644 index 00000000..bb4470e8 --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/Name.txt @@ -0,0 +1,9 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +7. No C++ Hurricane::Name encapsulation +========================================== + +To be written. diff --git a/documentation/_build/html/_sources/PythonCpp/NonDBo.txt b/documentation/_build/html/_sources/PythonCpp/NonDBo.txt new file mode 100644 index 00000000..db9f570a --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/NonDBo.txt @@ -0,0 +1,171 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +5. Case 3 - Non-DBo Standalone Classe +======================================= + +Let's have a look at the encapsulation of ``Hurricane::Point``. + +Non-BDo derived classes do not support the bi-directionnal communication. +So each Python object is associated with one C++ object. The C++ object +is created and deleted along with the Python one. This behavior implies +that the C++ object is *copy constructible* (which should be the case). + + +5.1 Class Header +~~~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.1 Class Associated Header File`: + +* There is no ``PyPoint_Link()`` function, as it's related to the + bi-directional communication mechanism. + +.. note:: + **About the _object attribute** of the PyPoint. As the C++ object life span + (``Point``) is linked to the Python (``PyPoint``) one, we may have used a + value instead of a pointer. It is best to keep a pointer as the macros + written for ``DBo`` derived classes will remain usables. + + +.. code-block:: c++ + + #ifndef ISOBAR_PY_POINT_H + #define ISOBAR_PY_POINT_H + + #include "hurricane/isobar/PyHurricane.h" + #include "hurricane/Point.h" + + namespace Isobar { + extern "C" { + + typedef struct { + PyObject_HEAD + Hurricane::Point* _object; + } PyPoint; + + extern PyTypeObject PyTypePoint; + extern PyMethodDef PyPoint_Methods[]; + extern void PyPoint_LinkPyType(); + + #define IsPyPoint(v) ( (v)->ob_type == &PyTypePoint ) + #define PYPOINT(v) ( (PyPoint*)(v) ) + #define PYPOINT_O(v) ( PYPOINT(v)->_object ) + + } // extern "C". + } // Isobar namespace. + + #endif // ISOBAR_PY_POINT_H + +|newpage| + + +5.2 Class File +~~~~~~~~~~~~~~~~ + +Changes from :ref:`3.2 Class Associated File`: + +* As there is no ``PyPoint_Link()`` function, there is no call to any + flavor of the ``DBoLinkcreatemethod()`` macro (obvious as it's *not* + a ``DBo``). + +* To use the standard Python constructor, we have to define ``PyPoint_NEW()`` + and ``PyPoint_Init()`` functions, I'm not absolutely certain that the later + needs to be defined (that part is still not clear to me from the Python doc). + +* As it's not a ``DBo`` there is no ``destroy()`` method, so no call to + ``DirectDestroyMethod()`` + +* Lastly, as this object has a ``PyPoint_NEW()`` (field ``tp_new``) and + a ``PyPoint_Init()`` (field ``tp_init``) we have to use the macro + ``PyTypeObjectLinkPyTypeNewInit()`` to define ``PyPoint_LinkPyType()``. + + +.. code-block:: c++ + + #include "hurricane/isobar/PyPoint.h" + + namespace Isobar { + using namespace Hurricane; + + extern "C" { + + #define METHOD_HEAD(function) GENERIC_METHOD_HEAD(Point,point,function) + + #if defined(__PYTHON_MODULE__) + + static PyObject* PyPoint_NEW ( PyObject* module, PyObject *args ) + { + Point* point = NULL; + HTRY + PyObject* arg0 = NULL; + PyObject* arg1 = NULL; + + __cs.init( "Point.Point" ); + if (not PyArg_ParseTuple( args,"|O&O&:Point.Point" + , Converter,&arg0 + , Converter,&arg1 )) { + PyErr_SetString ( ConstructorError + , "invalid number of parameters for Point constructor." ); + return NULL; + } + + if (__cs.getObjectIds() == "") + { point = new Point()); } + else if (__cs.getObjectIds() == ":point") + { point = new Point( *PYPOINT_O(arg0) ); } + else if (__cs.getObjectIds() == ":int:int") + { point = new Point( PyAny_AsLong(arg0), PyAny_AsLong(arg1) ); } + else { + PyErr_SetString ( ConstructorError + , "invalid number of parameters for Point constructor." ); + return NULL; + } + + PyPoint* pyPoint = PyObject_NEW( PyPoint, &PyTypePoint ); + if (pyPoint == NULL) { delete point; return NULL; } + pyPoint->_object = point; + HCATCH + + return (PyObject*)pyPoint; + } + + static int PyPoint_Init ( PyPoint* self, PyObject* args, PyObject* kwargs ) + { return 0; } + + DirectGetLongAttribute(PyPoint_getX,getX,PyPoint,Point) + DirectGetLongAttribute(PyPoint_getY,getY,PyPoint,Point) + DirectSetLongAttribute(PyPoint_SetX,setX,PyPoint,Point) + DirectSetLongAttribute(PyPoint_SetY,setY,PyPoint,Point) + + PyMethodDef PyPoint_Methods[] = + { { "getX" , (PyCFunction)PyPoint_getX , METH_NOARGS + , "Return the Point X value." } + , { "getY" , (PyCFunction)PyPoint_getY , METH_NOARGS + , "Return the Point Y value." } + , { "setX" , (PyCFunction)PyPoint_SetX , METH_VARARGS + , "Modify the Point X value." } + , { "setY" , (PyCFunction)PyPoint_SetY , METH_VARARGS + , "Modify the Point Y value." } + , {NULL, NULL, 0, NULL} /* sentinel */ + }; + + DirectDeleteMethod(PyPoint_DeAlloc,PyPoint) + PyTypeObjectLinkPyTypeNewInit(Point) + + #else // Python Module Code Part. + + PyTypeObjectDefinitions(Point) + + #endif // Shared Library Code Part. + + } // extern "C". + } // Isobar namespace. + + +5.2 Class File +~~~~~~~~~~~~~~~~ + +To put it bluntly, there is no difference in the Python module for +a standalone ``DBo`` class and a non-``DBo`` class. diff --git a/documentation/_build/html/_sources/PythonCpp/index.txt b/documentation/_build/html/_sources/PythonCpp/index.txt new file mode 100644 index 00000000..cb5575c2 --- /dev/null +++ b/documentation/_build/html/_sources/PythonCpp/index.txt @@ -0,0 +1,23 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +=================================== +Hurricane Python/C++ API Tutorial +=================================== + +Printable version of this document `PythonCpp.pdf <../../../pdf/main/PythonCpp.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + Introduction.rst + Configuration.rst + DBoStandalone.rst + DBoHierarchy.rst + NonDBo.rst + DbU.rst + Name.rst + diff --git a/documentation/_build/html/_sources/RDS/RDSpage.txt b/documentation/_build/html/_sources/RDS/RDSpage.txt new file mode 100644 index 00000000..be3aa644 --- /dev/null +++ b/documentation/_build/html/_sources/RDS/RDSpage.txt @@ -0,0 +1,474 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +.. Tools +.. |ocp| replace:: ``ocp`` +.. |nero| replace:: ``nero`` +.. |ring| replace:: ``ring`` +.. |s2r| replace:: ``s2r`` +.. |druc| replace:: ``druc`` +.. |graal| replace:: ``graal`` +.. |cougar| replace:: ``cougar`` +.. |cif| replace:: ``cif`` +.. |gds| replace:: ``gds`` +.. |phseg| replace:: ``phseg`` +.. |phvia| replace:: ``phvia`` + +.. RDS file syntax. +.. |MBK_TO_RDS_SEGMENT| replace:: ``MBK_TO_RDS_SEGMENT`` +.. |MBK_TO_RDS_VIA| replace:: ``MBK_TO_RDS_VIA`` +.. |MBK_TO_RDS_BIGVIA_HOLE| replace:: ``MBK_TO_RDS_BIGVIA_HOLE`` +.. |MBK_TO_RDS_BIGVIA_METAL| replace:: ``MBK_TO_RDS_BIGVIA_METAL`` +.. |MBK_WIRESETTING| replace:: ``MBK_WIRESETTING`` +.. |ALL| replace:: ``ALL`` +.. |DRC| replace:: ``DRC`` +.. |EXT| replace:: ``EXT`` +.. |VW| replace:: ``VW`` +.. |LCW| replace:: ``LCW`` +.. |RCW| replace:: ``RCW`` +.. |ALUx| replace:: ``ALUx`` +.. |CALUx| replace:: ``CALUx`` +.. |TALUx| replace:: ``TALUx`` +.. |ALU1| replace:: ``ALU1`` +.. |POLY| replace:: ``POLY`` +.. |NTIE| replace:: ``NTIE`` +.. |PTIE| replace:: ``PTIE`` +.. |NDIF| replace:: ``NDIF`` +.. |PDIF| replace:: ``PDIF`` +.. |PWELL| replace:: ``PWELL`` +.. |NTRANS| replace:: ``NTRANS`` +.. |PTRANS| replace:: ``PTRANS`` +.. |CONT_DIF_N| replace:: ``CONT_DIF_N`` +.. |CONT_DIF_P| replace:: ``CONT_DIF_P`` +.. |CONT_BODY_N| replace:: ``CONT_BODY_N`` +.. |CONT_BODY_P| replace:: ``CONT_BODY_P`` +.. |CONT_POLY| replace:: ``CONT_POLY`` +.. |CONT_VIA| replace:: ``CONT_VIA`` +.. |CONT_VIAx| replace:: ``CONT_VIAx`` +.. |C_X_N| replace:: ``C_X_N`` +.. |C_X_P| replace:: ``C_X_P`` +.. |RDS_NDIF| replace:: ``RDS_NDIF`` +.. |RDS_NIMP| replace:: ``RDS_NIMP`` +.. |RDS_ACTIV| replace:: ``RDS_ACTIV`` +.. |RDS_GATE| replace:: ``RDS_GATE`` +.. |RDS_POLY| replace:: ``RDS_POLY`` +.. |RDS_ALU1| replace:: ``RDS_ALU1`` + +.. Stand-alone images. +.. |RDS_VW| image:: ./images/RDS_VW.png + :alt: RDS Variable Width Rule + :align: middle + :width: 60% + +.. |RDS_LCW| image:: ./images/RDS_LCW.png + :alt: RDS Left Constant Width Rule + :align: middle + :width: 40% + +.. |SegmentOrientation| image:: ./images/SegmentOrientation.png + :alt: Symbolic Segment Orientations + :align: middle + :width: 50% + +.. |BIGVIA_1| image:: ./images/bigvia-1.png + :alt: BIGVIA holes + :align: middle + :width: 40% + +.. |BIGVIA_2| image:: ./images/bigvia-2.png + :alt: BIGVIA holes overlap + :align: middle + :width: 40% + + + +|newpage| + + +Symbolic Layout +=============== + +Symbolic Components +~~~~~~~~~~~~~~~~~~~ + +A symbolic layout is, in practice, made of only of three objects: + +=========================== ============ =================================================== +Object |MBK| Explanation +=========================== ============ =================================================== +Segments |phseg| Oriented segments with a width and an orientation. +VIAs & contacts |phvia| Boils down to just a point. +Big VIAs & Big Contacts |phvia| Point with a width and a height + That is a rectangle of width by height centered + on the VIA coordinates. +=========================== ============ =================================================== + +Each of thoses objects is associated to a *symbolic layer* which will +control how the object is translated in many *real rectangles*. + ++---------+---------------+-------------+--------------------------------------------+ +| |MBK| | Layer Name | Usable By | Usage | ++=========+===============+=============+============================================+ +| |phseg| | |NWELL| | Segment | N Well | +| +---------------+-------------+--------------------------------------------+ +| | |PWELL| | Segment | P Well | +| +---------------+-------------+--------------------------------------------+ +| | |NDIF| | Segment | N Diffusion | +| +---------------+-------------+--------------------------------------------+ +| | |PDIF| | Segment | P Diffusion | +| +---------------+-------------+--------------------------------------------+ +| | |NTIE| | Segment | N Tie | +| +---------------+-------------+--------------------------------------------+ +| | |PTIE| | Segment | P Tie | +| +---------------+-------------+--------------------------------------------+ +| | |NTRANS| | Segment | N transistor, in |Alliance|, a transistor | +| | | | is represented as a segment (it's grid). | +| +---------------+-------------+--------------------------------------------+ +| | |PTRANS| | Segment | P transistor | +| +---------------+-------------+--------------------------------------------+ +| | |POLY| | Segment | Polysilicium | +| +---------------+-------------+--------------------------------------------+ +| | |ALUx| | Segment | Metal level *x* | +| +---------------+-------------+--------------------------------------------+ +| | |CALUx| | Segment | Metal level *x*, that can be used by the | +| | | | upper hierarchical level as a connector. | +| | | | From the layout point of view it is the | +| | | | same as |ALUx|. | +| +---------------+-------------+--------------------------------------------+ +| | |TALUx| | Segment | Blockage for metal level *x*. Will | +| | | | diseappear in the real layout as it is an | +| | | | information for the P&R tools only. | ++---------+---------------+-------------+--------------------------------------------+ +| |phvia| | |CONT_BODY_N| | VIA, BIGVIA | Contact to N Well | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_BODY_P| | VIA, BIGVIA | Contact to P Well | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_DIF_N| | VIA, BIGVIA | Contact to N Diffusion | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_DIF_P| | VIA, BIGVIA | Contact to P Diffusion | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_POLY| | VIA, BIGVIA | Contact to polysilicium | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_VIA| | VIA, BIGVIA | Contact between metal1 and metal2 | +| +---------------+-------------+--------------------------------------------+ +| | |CONT_VIAx| | VIA, BIGVIA | Contact between metal *x* and metal *x+1*. | +| | | | The index is the the one of the bottom | +| | | | metal of the VIA. | +| +---------------+-------------+--------------------------------------------+ +| | |C_X_N| | VIA | N transistor corner, to build transistor | +| | | | bend. Not used anymore in recent technos | +| +---------------+-------------+--------------------------------------------+ +| | |C_X_P| | VIA | P transistor corner, to build transistor | +| | | | bend. Not used anymore in recent technos | ++---------+---------------+-------------+--------------------------------------------+ + +.. note:: + Not all association of object and symbolic layers are meaningful. + For instance you cannot associate a contact to a ``NTRANS`` layer. + +.. note:: + The symbolic layer associated with blockages is prefixed by a ``T``, + for *transparency*, which may seems silly. It is for historical reasons, + it started as a true transparency, but at some point we had to invert + the meaning (blockage) with the rise of over-the-cell routing, but the + name stuck... + + + +Symbolic Segments +~~~~~~~~~~~~~~~~~ + +In |Alliance|, segments are oriented (up, down, left, right). This disambiguate +the left or right side when using the ``LCW`` and ``RCW`` rules in the |RDS| file. +It allows to generate, if needed, asymetric object in the real layout file. + +|bcenter| |SegmentOrientation| |ecenter| + +|newpage| + + +The RDS File +============ + + +The RDS file control how a symbolic layout is transformed into it's real +conterpart. + +.. note:: **Unit used inside the RDS file:** all units are expressed in micrometers. + +Alliance tools relying on the RDS file, and what layers are active for them: + +======================================= ============= =============================== +Tool Name RDS Flags +======================================= ============= =============================== +Layout editor |graal| |ALL| +Design Rule Checker |druc| |ALL|, |DRC| +Electrical extractor |cougar| |ALL|, |EXT| +The symbolic to real layout translator |s2r| |ALL| +======================================= ============= =============================== + + +Physical Grid & Lambda Value +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +RDS file: :: + + DEFINE PHYSICAL_GRID 0.005 + DEFINE LAMBDA 0.09 + +Tells that the physical grid (founder grid) step is 0.005µm and the lambda has +a value of 0.09µm. That is, one lambda is 18 grid steps. + +We can distinguish two kind of |RDS| files: + +* The *1µm* kind, odd segment widths and coordinates are allowed, but the ``LAMBDA`` + value **must** represent an *even* number of foundry grid step. +* The *2µm* kind, segments widths and coordinates must all be even. And in that case + the ``LAMBDA`` value can be any multiple of the foundry grid. + + +The |MBK_TO_RDS_SEGMENT| table +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The |MBK_TO_RDS_SEGMENT| table control the way segments are translated into +real rectangles. Be aware that we are translating *segments* and not *rectangles*. +Segments are defined by their axis (source & target points) and their width. +The geometrical transformations are described according to that model. +Obviously, they are either horizontal or vertical. + +The translation method of a symbolic segment is as follow: + +1. The segment is translated into one or more physical rectangles. + The generated rectangles depends on the tool which is actually + using |RDS| and the flag for the considered real layer. + For instance, real layers flagged with |DRC| will be generated + for |s2r| (for the |cif| or |gds|) and |druc|, but will not + be shown under |graal|. + +2. Translation into one real layer. *First* the source & target coordinates and width + of the symbolic segment are multiplied by the ``LAMBDA`` value to obtain a real + segment. *Then* one of the |VW|, |LCW| or |RCW| transformation is applied to + that segment to get the final real rectangle. + + * |VW| for Variable Width, expand the real layer staying centered from the + original one. In those rules, the third number is not used, it is only here + to make the life easier for the parser... + + |bcenter| |RDS_VW| |ecenter| + + * |LCW| or |RCW| for Left/Right Constant Width, create an off-center rectangle + of fixed width relatively to the real segment. Note that the ``SP`` number + is the distance *between the edge* of the real segment and the edge of the + generated real rectangle (*not* from the axis). It is often zero. + + |bcenter| |RDS_LCW| |ecenter| + + +|newpage| + +Examples: :: + + TABLE MBK_TO_RDS_SEGMENT + + # (Case 1) + ALU1 RDS_ALU1 VW 0.18 0.09 0.0 ALL + + # (Case 2) + NDIF RDS_NDIF VW 0.18 0.0 0.0 ALL \ + RDS_ACTIV VW 0.18 0.0 0.0 DRC \ + RDS_NIMP VW 0.36 0.36 0.0 DRC + + # (Case 3) + NTRANS RDS_POLY VW 0.27 0.00 0.0 ALL \ + RDS_GATE VW 0.27 0.00 0.0 DRC \ + RDS_NDIF LCW 0.0 0.27 0.0 EXT \ + RDS_NDIF RCW 0.0 0.27 0.0 EXT \ + RDS_NDIF VW 0.0 0.72 0.0 DRC \ + RDS_ACTIV VW 0.0 0.72 0.0 ALL \ + RDS_NIMP VW 0.18 1.26 0.0 DRC + + END + +:fboxtt:`Case 1` the |ALU1| is translated in exacltly one real rectangle of +|RDS_ALU1|, both ends are extended by 0.18µm and it's width is increased +by 0.09µm. + +:fboxtt:`Case 2` the |NDIF| will be translated into only one segment +under |graal|, for symbolic visualization. And into three real rectangles +for |s2r| and |druc|. + +:fboxtt:`Case 3` the |NTRANS|, associated to a transistor is a little bit +more complex, the generated shapes are different for the extractor |cougar| +in one hand, and for both |druc| & |s2r| in the other hand. + +* For the extractor (|EXT| & |ALL| flags) there will be four rectangles + generateds: + + 1. The gate (|RDS_GATE|) + 2. The left diffusion of the transistor (source or drain) (|RDS_NDIF|). + 3. The right diffusion of the transistor (drain or source) (|RDS_NDIF|). + 4. The active area (|RDS_ACTIV|). + + As the extractor must kept separate the source and the drain of the transistor, + they are generated as two offset rectangles, using the |LCW| and |RCW| directives. + +* For |s2r| and |druc| (|DRC| and |ALL|), five rectangles are generateds: + + 1. The poly (|RDS_POLY|). + 2. The gate (|RDS_GATE|). + 3. The diffusion, as one rectangle that covers both the |LCW| and the |RCW| (|RDS_NDIF|). + 4. The active area (|RDS_ACTIV|). + 5. The N implantation (|RDS_NIMP|). + + In the layout send to the foundry, the source & drain are draw as one rectangle + across the gate area (the transistor being defined by the intersection of both + rectangles). + + +|newpage| + +The |MBK_TO_RDS_VIA| table +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This table is to translate *default* VIAs into real via. In the symbolic layout +the default VIA is simply a point and a set of layers. All layers are converted +in squares shapes centered on the VIA coordinate. The one dimension given is the +size of the side of that square. + +Note that although we are refering to VIAs, which for the purists are between two +metal layers, this table also describe *contacts*. + +Example: :: + + TABLE MBK_TO_RDS_VIA + + CONT_DIF_P RDS_PDIF 0.54 ALL \ + RDS_CONT 0.18 ALL \ + RDS_ALU1 0.36 ALL \ + RDS_ACTIV 0.54 DRC \ + RDS_PIMP 0.90 DRC + + CONT_POLY RDS_POLY 0.54 ALL \ + RDS_CONT 0.18 ALL \ + RDS_ALU1 0.36 ALL + + CONT_VIA RDS_ALU1 0.45 ALL \ + RDS_VIA1 0.27 ALL \ + RDS_ALU2 0.45 ALL + + END + +.. note:: **In CONT_DIF_P** you may see that only three layers will be shown under + |graal|, but five will be generated in the |gds| layout. + + +The |MBK_TO_RDS_BIGVIA_HOLE| table +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In |s2r|, when generating BIGVIAs, the matrix of holes they contains is +not draw relative to the position of the BIGVIA itself, but on a grid which +is common througout all the design real layout. This is to allow overlap +between two BIGVIA without risking the holes matrix to be not exactly overlapping. +As a consequence, when visualizing the |gds| file, the holes may not be centerend +inside one individual BIGVIA. + +The |MBK_TO_RDS_BIGVIA_HOLE| table define the global hole matrix for the whole +design. The first number is the individual hole side and the second the grid step +(edge to edge). The figure below show the hole generation. + +|bcenter| |BIGVIA_1| |ecenter| + +Example of BIGVIA overlap: + +|bcenter| |BIGVIA_2| |ecenter| + +Example: :: + + TABLE MBK_TO_RDS_BIGVIA_HOLE + + CONT_VIA RDS_VIA1 0.27 0.27 ALL + CONT_VIA2 RDS_VIA2 0.27 0.27 ALL + CONT_VIA3 RDS_VIA3 0.27 0.27 ALL + CONT_VIA4 RDS_VIA4 0.27 0.27 ALL + CONT_VIA5 RDS_VIA5 0.36 0.36 ALL + + END + +.. note:: **BIGVIA demotion.** If the size of the bigvia is too small, there is + a possibility that no hole from the global matrix will be under it. + To avoid that case, if the either side of the BIGVIA is less than + ``1.5 * step``, the BIGVIA is demoted to a simple VIA. + + +The |MBK_TO_RDS_BIGVIA_METAL| table +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This table describe how the metal part of a BIGVIA is expanded (for the hole +part, see the previous table |MBK_TO_RDS_BIGVIA_HOLE|). The rule give for each +metal: + +1. The *delta-with* (have to ask Franck). +2. The *overhang*, the length the real rectangle is expanded on each side from + the symbolic rectange. + +Example: :: + + TABLE MBK_TO_RDS_BIGVIA_METAL + + CONT_VIA RDS_ALU1 0.0 0.09 ALL \ + RDS_ALU2 0.0 0.09 ALL + + CONT_VIA2 RDS_ALU2 0.0 0.09 ALL \ + RDS_ALU3 0.0 0.09 ALL + + CONT_VIA3 RDS_ALU3 0.0 0.09 ALL \ + RDS_ALU4 0.0 0.09 ALL + + CONT_VIA4 RDS_ALU4 0.0 0.09 ALL \ + RDS_ALU5 0.0 0.09 ALL + + CONT_VIA5 RDS_ALU5 0.0 0.09 ALL \ + RDS_ALU6 0.0 0.18 ALL + END + + +The |MBK_WIRESETTING| table +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +From a strict standpoint this table shouldn't be here but put in a separate +configuration file, because it contains informations only used by the symbolic +layout tools (|ocp|, |nero|, |ring|). + +This table defines the cell gauge the routing pitch and minimal (symbolic) +wire width and minimal spacing for the routers. They are patly redundant. + +Example: :: + + TABLE MBK_WIRESETTING + + X_GRID 10 + Y_GRID 10 + Y_SLICE 100 + WIDTH_VDD 12 + WIDTH_VSS 12 + TRACK_WIDTH_ALU8 0 + TRACK_WIDTH_ALU7 4 + TRACK_WIDTH_ALU6 4 + TRACK_WIDTH_ALU5 4 + TRACK_WIDTH_ALU4 3 + TRACK_WIDTH_ALU3 3 + TRACK_WIDTH_ALU2 3 + TRACK_WIDTH_ALU1 3 + TRACK_SPACING_ALU8 0 + TRACK_SPACING_ALU7 4 + TRACK_SPACING_ALU6 4 + TRACK_SPACING_ALU5 4 + TRACK_SPACING_ALU4 4 + TRACK_SPACING_ALU3 4 + TRACK_SPACING_ALU2 4 + TRACK_SPACING_ALU1 3 + + END + diff --git a/documentation/_build/html/_sources/RDS/index.txt b/documentation/_build/html/_sources/RDS/index.txt new file mode 100644 index 00000000..757d647e --- /dev/null +++ b/documentation/_build/html/_sources/RDS/index.txt @@ -0,0 +1,26 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +:Date: 26, september 2014 +:Authors: Jean-Paul Chaput +:Contact: +:Version: 0.2 + + +**Disclaimer:** This document is still far from complete. + + +========================================= +Symbolic to Real Conversion in Alliance +========================================= + +Printable version of this document `RDS.pdf <../../../pdf/main/RDS.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + RDSpage.rst + diff --git a/documentation/_build/html/_sources/Stratus/Stratus.txt b/documentation/_build/html/_sources/Stratus/Stratus.txt new file mode 100644 index 00000000..f61b2dac --- /dev/null +++ b/documentation/_build/html/_sources/Stratus/Stratus.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +=================== +Stratus Reference +=================== + +The Stratus Language reference is generated by LaTeX2HTML_ and is +available here: `Stratus `_ diff --git a/documentation/_build/html/_sources/Unicorn/Unicorn.txt b/documentation/_build/html/_sources/Unicorn/Unicorn.txt new file mode 100644 index 00000000..c972e5f0 --- /dev/null +++ b/documentation/_build/html/_sources/Unicorn/Unicorn.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +=================== +Unicorn Reference +=================== + +The Unicorn C++ API reference is generated by Doxygen_ and is +available here: `Unicorn `_ diff --git a/documentation/_build/html/_sources/UsersGuide/Configuration.txt b/documentation/_build/html/_sources/UsersGuide/Configuration.txt new file mode 100644 index 00000000..e2da0de5 --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/Configuration.txt @@ -0,0 +1,342 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Coriolis Tools Documentation: file:///usr/share/doc/coriolis2/index.html + + + +.. |CoriolisSoftSchema| image:: ./images/Coriolis-Soft-Schema.png + :alt: Coriolis Software Schematic + :align: middle + :width: 60% + +|newpage| + + +Coriolis Configuration & Initialisation +======================================= + + +General Software Architecture +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|Coriolis| has been build with respect of the classical paradigm that the +computational instensive parts have been written in C++, and almost +everything else in |Python|. To build the |Python| interface we used +two methods: + +* For self-contained modules :cb:`boost::python` (mainly in :cb:`vlsisapd`). +* For all modules based on |Hurricane|, we created our own wrappers due + to very specific requirements such as shared functions between modules + or C++/|Python| secure bi-directional object deletion. + +.. note:: **Python Documentation:** + Most of the documentation is related to the C++ API and implemetation of + the tools. However, the |Python| bindings have been created so they + mimic *as closely as possible* the C++ interface, so the documentation + applies to both languages with only minor syntactic changes. + +|bcenter| |CoriolisSoftSchema| |ecenter| + +All configuration & initialization files are Python scripts, despite their +|dot_conf| extention. From a syntactic point of view, there is no difference +between the system-wide configuration files and the user's configuration, +they may use the same Python helpers. +|medskip| + +Configuration is done in two stages: + +#. Selecting the symbolic technology. +#. Loading the complete configuration for the given technology. + +|newpage| + + +First Stage: Symbolic Technology Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|noindent| +The initialization process is done by executing, in order, the following +file(s): + ++-------+----------------------------------+----------------------------------------------+ +| Order | Meaning | File | ++=======+==================================+==============================================+ +| **1** | The system setting | :cb:`/etc/coriolis2/techno.conf` | ++-------+----------------------------------+----------------------------------------------+ +| **2** | The user's global setting | :cb:`${HOME}/.coriolis2/techno.py` | ++-------+----------------------------------+----------------------------------------------+ +| **3** | The user's local setting | :cb:`/.coriolis2/techno.py` | ++-------+----------------------------------+----------------------------------------------+ + +Thoses files must provides only two variables, the name of the symbolic technology +and the one of the real technology. For example: :: + + # -*- Mode:Python -*- + + symbolicTechno = 'cmos' + realTechno = 'hcmos9' + + +Second Stage: Technology Configuration Loading +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +|noindent| +The :cb:`TECHNO` variable is set by the first stage and it's the name of the +symbolic technology. A directory of that name, with all the configuration files, +must exists in the configuration directory. In addition to the technology-specific +directories, a :cb:`common/` directory is there to provides a trunk for all the +identical datas across the various technologies. The initialization process is done +by executing, in order, the following file(s): + ++-------+----------------------------------+----------------------------------------------+ +| Order | Meaning | File | ++=======+==================================+==============================================+ +| **1** | The system initialization | :cb:`/etc/coriolis2//.conf` | ++-------+----------------------------------+----------------------------------------------+ +| **2** | The user's global initialization | :cb:`${HOME}/.coriolis2/settings.py` | ++-------+----------------------------------+----------------------------------------------+ +| **3** | The user's local initialization | :cb:`/.coriolis2/settings.py` | ++-------+----------------------------------+----------------------------------------------+ + +.. note:: *The loading policy is not hard-coded.* It is implemented + at Python level in :cb:`/etc/coriolis2/coriolisInit.py`, and thus may be easily be + amended to whatever site policy. + + The truly mandatory requirement is the existence of :cb:`coriolisInit.py` + which *must* contain a :cb:`coriolisConfigure()` function with no argument. + + +Configuration Helpers +~~~~~~~~~~~~~~~~~~~~~ + +To ease the writing of configuration files, a set of small helpers +is available. They allow to setup the configuration parameters through +simple assembly of tuples. The helpers are installed under the directory: :: + + /etc/coriolis2/ + +Where :cb:`/` is the root of the installation. + +|newpage| + + +.. _Alliance Helper: + +|Alliance| Helper +----------------- + +The configuration file must provide a :cb:`allianceConfig` tuple of +the form: :: + + cellsTop = '/usr/share/alliance/cells/' + + allianceConfig = \ + ( ( 'SYMBOLIC_TECHNOLOGY', helpers.sysConfDir+'/technology.symbolic.xml' ) + , ( 'REAL_TECHNOLOGY' , helpers.sysConfDir+'/technology.cmos130.s2r.xml') + , ( 'DISPLAY' , helpers.sysConfDir+'/display.xml' ) + , ( 'CATALOG' , 'CATAL') + , ( 'WORKING_LIBRARY' , '.') + , ( 'SYSTEM_LIBRARY' , ( (cellsTop+'sxlib' , Environment.Append) + , (cellsTop+'dp_sxlib', Environment.Append) + , (cellsTop+'ramlib' , Environment.Append) + , (cellsTop+'romlib' , Environment.Append) + , (cellsTop+'rflib' , Environment.Append) + , (cellsTop+'rf2lib' , Environment.Append) + , (cellsTop+'pxlib' , Environment.Append) ) ) + , ( 'SCALE_X' , 100) + , ( 'IN_LO' , 'vst') + , ( 'IN_PH' , 'ap') + , ( 'OUT_LO' , 'vst') + , ( 'OUT_PH' , 'ap') + , ( 'POWER' , 'vdd') + , ( 'GROUND' , 'vss') + , ( 'CLOCK' , '^ck.*') + , ( 'BLOCKAGE' , '^blockageNet*') + ) + + +|noindent| The example above shows the system configuration file, with all the +available settings. Some important remarks about thoses settings: + +* In it's configuration file, the user do not need to redefine all the settings, + just the one he wants to change. In most of the cases, the ``SYSTEM_LIBRARY``, + the ``WORKING_LIBRARY`` and the special net names (at this point there is not + much alternatives for the others settings). + +* ``SYSTEM_LIBRARY`` setting: Setting up the library search path. + Each library entry in the tuple will be added to the search path according + to the second parameter: + + * :cb:`Environment::Append`: append to the search path. + + * :cb:`Environment::Prepend`: insert in head of the search path. + + * :cb:`Environment::Replace`: look for a library of the same name and replace + it, whithout changing the search path order. If no library of that name + already exists, it is appended. + + A library is identified by it's name, this name is the last component of the + path name. For instance: ``/soc/alliance/sxlib`` will be named ``sxlib``. + Implementing the |Alliance| specification, when looking for a |Cell| ``name``, + the system will browse sequentially trought the library list and returns + the first |Cell| whose name match. + +* For ``POWER``, ``GROUND``, ``CLOCK`` and ``BLOCKAGE`` net names, a regular + expression (|GNU| regexp) is expected. + +* The ``helpers.sysConfDir`` variable is supplied by the helpers, it is the + directory in which the system-wide configuration files are locateds. + For a standard installation it would be: ``/soc/coriolis2``. + +.. * Trick and naming convention about ``SYMBOLIC_TECHNOLOGY``, ``REAL_TECHNOLOGY`` +.. and ``DISPLAY``. In the previous releases, thoses files where to read by +.. XML parsers, and still do if you triggers the XML compatibility mode. +.. But now, they have Python conterparts. In the configuration files, you +.. still have to name them as XML files, the Python file name will be +.. deduced from this one with thoses two translation rules: +.. +.. #. In the filename, all dots, except for the last (the file extention), +.. are replaced by underscores. +.. +.. #. The ``.xml`` extention is substituted by a ``.conf``. +.. +.. For the symbolic technology, it would give: :: +.. +.. /soc/coriolis2/technology.symbolic.xml +.. --> /soc/coriolis2/technology_symbolic.conf + +A typical user's configuration file would be: :: + + import os + + homeDir = os.getenv('HOME') + + allianceConfig = \ + ( ('WORKING_LIBRARY' , homeDir+'/worklib') + , ('SYSTEM_LIBRARY' , ( (homeDir+'/mylib', Environment.Append) ) ) + , ('POWER' , 'vdd.*') + , ('GROUND' , 'vss.*') + ) + + +Tools Configuration Helpers +--------------------------- + +All the tools uses the same helper to load their configuration (a.k.a. +*Configuration Helper*). Currently the following configuration system-wide +configuration files are defined: + +* :cb:`misc.conf`: commons settings or not belonging specifically to a tool. +* :cb:`etesian.conf`: for the |Etesian| tool. +* :cb:`kite.conf`: for the |Kite| tool. +* :cb:`stratus1.conf`: for the |stratus1| tool. + +Here is the contents of :cb:`etesian.conf`: :: + + # Etesian parameters. + parametersTable = \ + ( ('etesian.aspectRatio' , TypePercentage, 100 , { 'min':10, 'max':1000 } ) + , ('etesian.spaceMargin' , TypePercentage, 5 ) + , ('etesian.uniformDensity' , TypeBool , False ) + , ('etesian.routingDriven' , TypeBool , False ) + , ("etesian.effort" , TypeEnumerate , 2 + , { 'values':( ("Fast" , 1) + , ("Standard", 2) + , ("High" , 3) + , ("Extreme" , 4) ) } + ) + , ("etesian.graphics" , TypeEnumerate , 2 + , { 'values':( ("Show every step" , 1) + , ("Show lower bound" , 2) + , ("Show result only" , 3) ) } + ) + ) + + layoutTable = \ + ( (TypeTab , 'Etesian', 'etesian') + + , (TypeTitle , 'Placement area') + , (TypeOption, "etesian.aspectRatio" , "Aspect Ratio, X/Y (%)", 0 ) + , (TypeOption, "etesian.spaceMargin" , "Space Margin" , 1 ) + , (TypeRule ,) + , (TypeTitle , 'Etesian - Placer') + , (TypeOption, "etesian.uniformDensity", "Uniform density" , 0 ) + , (TypeOption, "etesian.routingDriven" , "Routing driven" , 0 ) + , (TypeOption, "etesian.effort" , "Placement effort" , 1 ) + , (TypeOption, "etesian.graphics" , "Placement view" , 1 ) + , (TypeRule ,) + ) + +|newpage| + + +Taxonomy of the file: + +* It must contains, at least, the two tables: + + * ``parametersTable``, defines & initialise the configuration variables. + + * ``layoutTables``, defines how the various parameters will be displayed + in the configuration window (:ref:`The Settings Tab`). + +* The ``parametersTable``, is a tuple (list) of tuples. Each entry in the list + describe a configuration parameter. In it's simplest form, it's a quadruplet + :cb:`(TypeOption, 'paramId', ParameterType, DefaultValue)` with: + + #. ``TypeOption``, tells that this tuple describe a parameter. + + #. ``paramId``, the identifier of the parameter. Identifiers are defined + by the tools. The list of parameters is detailed in each tool section. + + #. ``ParameterType``, the kind of parameter. Could be: + + * ``TypeBool``, boolean. + * ``TypeInt``, signed integer. + * ``TypeEnumerate``, enumerated type, needs extra entry. + * ``TypePercentage``, percentage, expressed between 0 and 100. + * ``TypeDouble``, float. + * ``TypeString``, character string. + + #. ``DefaultValue``, the default value for that parameter. + + +Hacking the Configuration Files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Asides from the symbols that gets used by the configuration helpers like +:cb:`allianceConfig` or :cb:`parametersTable`, you can put pretty much anything +in :cb:`/.coriolis2/settings.py` (that is, written in |Python|). + +For example: :: + + # -*- Mode:Python -*- + + defaultStyle = 'Alliance.Classic [black]' + + # Regular Coriolis configuration. + parametersTable = \ + ( ('misc.catchCore' , TypeBool , False ) + , ('misc.info' , TypeBool , False ) + , ('misc.paranoid' , TypeBool , False ) + , ('misc.bug' , TypeBool , False ) + , ('misc.logMode' , TypeBool , True ) + , ('misc.verboseLevel1' , TypeBool , False ) + , ('misc.verboseLevel2' , TypeBool , True ) + , ('misc.minTraceLevel' , TypeInt , 0 ) + , ('misc.maxTraceLevel' , TypeInt , 0 ) + ) + + # Some ordinary Python script... + import os + + print ' o Cleaning up ClockTree previous run.' + for fileName in os.listdir('.'): + if fileName.endswith('.ap') or (fileName.find('_clocked.') >= 0): + print ' - <%s>' % fileName + os.unlink(fileName) + + +See :ref:`Python Interface to Coriolis` for more details those capabilities. diff --git a/documentation/_build/html/_sources/UsersGuide/Installation.txt b/documentation/_build/html/_sources/UsersGuide/Installation.txt new file mode 100644 index 00000000..224ee5f4 --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/Installation.txt @@ -0,0 +1,230 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +|newpage| + + +Installation +============ + +.. note:: + As the sources are being released, the binary packaging is dropped. + You still may find older version here: http://asim.lip6.fr/pub/coriolis/2.0 . + +In a nutshell, building source consist in pulling the |git| repository then +running the |ccb| installer. + +Main building prerequisites: + +* cmake +* C++11-capable compiler +* RapidJSON_ +* python2.7 +* boost +* libxml2 +* bzip2 +* yacc & lex +* Qt 4 or Qt 5 + +Building documentation prerequisites: + +* doxygen +* latex +* latex2html +* python-docutils (for reStructuredText) + +Optional libraries: + +* LEF/DEF (from `SI2 `_) + +For other distributions, refer to their own packaging system. + +|newpage| + + +Fixed Directory Tree +~~~~~~~~~~~~~~~~~~~~ + +In order to simplificate the work of the |ccb| installer, the source, build +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 +building it (noted :fboxtt:`~/` or :fboxtt:`$HOME/`). Only the source +directory needs to be manually created by the user, all others will be +automatically created either by |ccb| or the build system. + ++--------------------------------------------------------------------------------------------------------------+ +| **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/ | +| | Linux, SL 6, 32b | | ~/coriolis-2.x/Linux.slsoc6x/Release.Shared/build/ | +| | Linux, SL 6, 64b | | ~/coriolis-2.x/Linux.slsoc6x_64/Release.Shared/build/ | +| | Linux, Fedora, 64b | | ~/coriolis-2.x/Linux.fc_64/Release.Shared/build/ | +| | Linux, Fedora, 32b | | ~/coriolis-2.x/Linux.fc/Release.Shared/build/ | +| | FreeBSD 8, 32b | | ~/coriolis-2.x/FreeBSD.8x.i386/Release.Shared/build/ | +| | FreeBSD 8, 64b | | ~/coriolis-2.x/FreeBSD.8x.amd64/Release.Shared/build/ | +| | Windows 7, 32b | | ~/coriolis-2.x/Cygwin.W7/Release.Shared/build/ | +| | Windows 7, 64b | | ~/coriolis-2.x/Cygwin.W7_64/Release.Shared/build/ | +| | Windows 8.x, 32b | | ~/coriolis-2.x/Cygwin.W8/Release.Shared/build/ | +| | Windows 8.x, 64b | | ~/coriolis-2.x/Cygwin.W8_64/Release.Shared/build/ | ++------------------------------+-------------------------------------------------------------------------------+ +| **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// | +| | Configuration files | | .../install/etc/coriolis2/ | +| | Doc, by tool | | .../install/share/doc/coriolis2/en/html/ | ++------------------------------+-------------------------------------------------------------------------------+ + +.. 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. + + ``Static`` do not work because I don't know yet to mix statically linked binaries + and Python modules (which must be dynamic). + +|newpage| + + +Building Coriolis +~~~~~~~~~~~~~~~~~ + +First step is to install the prerequisites. Currently, only RapidJSON_. +As RapidJSON is evolving fast, if you encounter compatibility problems, +the exact version we compiled against is given below. :: + + dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src/support + dummy@lepka:~$ cd ~/coriolis-2.x/src/support + dummy@lepka:~$ git clone http://github.com/miloyip/rapidjson + dummy@lepka:~$ git checkout ec322005072076ef53984462fb4a1075c27c7dfd + +The second step is to create the source directory and pull the |git| repository: :: + + dummy@lepka:~$ mkdir -p ~/coriolis-2.x/src + dummy@lepka:~$ cd ~/coriolis-2.x/src + dummy@lepka:~$ git clone https://www-soc.lip6.fr/git/coriolis.git + +Third and final step, build & install: :: + + dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + --project=coriolis \ + --make="-j4 install" + dummy@lepka:src$ ./bootstrap/ccb.py --project=support \ + --project=coriolis \ + --doc --make="-j1 install" + +We need to separate to perform a separate installation of the documentation because it +do not support to be generated with a parallel build. So we compile & install in a first +stage in ``-j4`` (or whatever) then we generate the documentation in ``-j1`` + +Under |RHEL6| or clones, you must build using the |devtoolset2|: :: + + dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + --devtoolset-2 --make="-j4 install" + +If you want to uses Qt 5 instead of Qt 4, you may add the ``--qt5`` argument. + +The complete list of |ccb| functionalities can be accessed with the ``--help`` argument. +It also may be run in graphical mode (``--gui``). + + +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:~$ git checkout devel + dummy@lepka:src$ ./bootstrap/ccb.py --project=coriolis \ + --make="-j4 install" --debug + + Be aware that it may requires newer versions of the dependencies and may introduce + incompatibilites with the stable version. + + In the (unlikely) event of a crash of |cgt|, as it is a |Python| script, the right + command to run |gdb| on it is: :: + + dummy@lepka:work$ gdb python core.XXXX + +|newpage| + + +Additionnal Requirement under |MacOS| +------------------------------------- + +|Coriolis| make uses of the :cb:`boost::python` module, but the |macports| |boost| +seems unable to work with the |Python| bundled with |MacOS|. So you have to install +both of them from |macports|: :: + + dummy@macos:~$ port install boost +python27 + dummy@macos:~$ port select python python27 + dummy@macos:-$ export DYLD_FRAMEWORK_PATH=/opt/local/Library/Frameworks + +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 +~~~~~~~~~~~~~~~~~~ + +Packager should not uses |ccb|, instead ``bootstrap/Makefile.package`` is provided +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. + +Sligthly outaded packaging configuration files can also be found under ``bootstrap/``: + +* ``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. + +This is done by editing the one variable :cb:`cellsTop` in the |Alliance| helper +(see :ref:`Alliance Helper`). This variable must point to the directory of the +cells libraries. In a typical installation, this is generally +:cb:`/usr/share/alliance/cells`. + + +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.** + When used under |RHEL6| or clones, it needs to be run in the |devtoolset2| + 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`"' diff --git a/documentation/_build/html/_sources/UsersGuide/LicenseCredits.txt b/documentation/_build/html/_sources/UsersGuide/LicenseCredits.txt new file mode 100644 index 00000000..3cf0eefe --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/LicenseCredits.txt @@ -0,0 +1,55 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +Credits & License +================= + +.. raw:: html + +

Hurricane + Rémy Escassut & + Christian Masson

+
+

Etesian + Gabriel Gouvine

+
+

Stratus + Sophie Belloeil

+
+

Knik + Damien Dupuis

+
+

Kite, + Unicorn + Jean-Paul Chaput

+
+ + +.. raw:: latex + + \begin{center}\begin{minipage}[t]{.8\textwidth} + \noindent\DUrole{sc}{Hurricane} \dotfill Rémy \DUrole{sc}{Escassut} \& + Christian \DUrole{sc}{Masson} \\ + \noindent\DUrole{sc}{Etesian} \dotfill Gabriel \DUrole{sc}{Gouvine} \\ + \noindent\DUrole{sc}{Stratus} \dotfill Sophie \DUrole{sc}{Belloeil} \\ + \noindent\DUrole{sc}{Knik} \dotfill Damien \DUrole{sc}{Dupuis} \\ + \noindent\DUrole{sc}{Kite}, + \DUrole{sc}{Unicorn} \dotfill Jean-Paul \DUrole{sc}{Chaput} \\ + \end{minipage}\end{center} + + +|medskip| + +The |Hurricane| data-base is copyright© |Bull| 2000-2016 and is +released under the terms of the |LGPL| license. All other tools are +copyright© |UPMC| 2008-2016 and released under the |GPL| +license. + +Others important contributors to |Coriolis| are Christophe |Alexandre|, +Hugo |Clement|, Marek |Sroka| and Wu |Yifei|. + +The |Knik| router makes use of the |Flute| software, which is +copyright© Chris C. N. |Chu| from the Iowa State University +(http://home.eng.iastate.edu/~cnchu/). diff --git a/documentation/_build/html/_sources/UsersGuide/Releases.txt b/documentation/_build/html/_sources/UsersGuide/Releases.txt new file mode 100644 index 00000000..c86243a1 --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/Releases.txt @@ -0,0 +1,102 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +Release Notes +============= + +Release 1.0.1475 +~~~~~~~~~~~~~~~~ + +This is the first preliminary release of the |Coriolis2| framework. + +This release mainly ships the global router |Knik| and the detailed router +|Kite|. Together they aim to replace the |Alliance| |Nero| router. +Unlike |Nero|, |Kite| is based on an innovating routing modeling and ad-hoc +algorithm. Although it is released under |GPL| license, the source code +will be avalaible later. +|medskip| + + +|noindent| Contents of this release: + +1. A graphical user interface (viewer only). +2. The |Knik| global router. +3. The |Kite| detailed router. + +|noindent| Supported input/output formats: + +* |Alliance| |vst| (netlist) & |ap| (physical) formats. +* Even if there are some references to the |Cadence| |LEFDEF| format, its + support is not included because it depends on a library only available + to |Si2| affiliated members. + + +Release 1.0.1963 +~~~~~~~~~~~~~~~~ + +Release 1963 is alpha. All the tools from |Coriolis1| have been ported into +this release. + +|noindent| Contents of this release: + +#. The |Stratus| netlist capture language (|GenLib| replacement). +#. The |Mauka| placer (still contains bugs). +#. A graphical user interface (viewer only). +#. The |Knik| global router. +#. The |Kite| detailed router. +#. Partially implemented python support for configuration files + (alternative to |XML|). +#. A documentation (imcomplete/obsoleted in |Hurricane|'s case). + + +Release 1.0.2049 +~~~~~~~~~~~~~~~~ + +Release `2049` is Alpha. + +|noindent| Changes of this release: + +#. The |Hurricane| documentation is now accurate. Documentation + for the Cell viewer and |CRLcore| has been added. +#. More extensive Python support for all the components of + |Coriolis|. +#. Configuration is now completly migrated under Python. + |XML| loaders can still be useds for compatibilty. +#. The |cgt| main has been rewritten in Python. + + +Release v2.0.1 +~~~~~~~~~~~~~~ + +#. Migrated the repository from |svn| to |git|, and release complete sources. + As a consequence, we drop the distribution packaging support and give + public read-only access to the repository. +#. Deep rewrite of the |Katabatic| database and |Kite| detailed router, + achieve a speedup factor greater than 20... + + +Release v2.1 +~~~~~~~~~~~~ + +#. Replace the old simulated annealing placer |Mauka| by the analytical placer + |Etesian| and its legalization and detailed placement tools. +#. Added a Blif format parser to process circuits generated by the Yosys and ABC + logic synthetizers. +#. The multiples user defined configuration files are now grouped under + a common hidden (dot) directory ``.coriolis2`` and the file extension + is back from ``.conf`` to ``.py``. + +.. #. Under |RHEL7| / |SL7|, there is a known bug in the graphical visualizer. +.. When shifting to the left, the right-half part of the screen gets +.. badly redrawn. Uses |CTRL_L| to refresh. It will be corrected as soon +.. as possible. + + +**Release v2.2** +~~~~~~~~~~~~~~~~ + +#. Added JSON import/export of the whole Hurricane DataBase. Two save mode + are supported: *Cell* mode (standalone) or *Blob* mode, which dump the + whole design down and including the standard cells. diff --git a/documentation/_build/html/_sources/UsersGuide/ScriptsPlugins.txt b/documentation/_build/html/_sources/UsersGuide/ScriptsPlugins.txt new file mode 100644 index 00000000..2e9e3d0c --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/ScriptsPlugins.txt @@ -0,0 +1,332 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Stratus Documentation: file:///usr/share/doc/coriolis2/en/html/stratus/index.html + +.. |ChipStructure-1| image:: ./images/chip-structure-1.png + :alt: Chip Top Structure + :align: middle + :width: 90% + + +.. _Python Interface to Coriolis: + +Python Interface for |Hurricane| / |Coriolis| +============================================= + +The (almost) complete interface of |Hurricane| is exported as a |Python| module +and some part of the other components of |Coriolis| (each one in a separate +module). The interface has been made to mirror as closely as possible the +C++ one, so the C++ doxygen documentation could be used to write code with +either languages. + +`Summary of the C++ Documentation `_ + +A script could be run directly in text mode from the command line or through +the graphical interface (see :ref:`Python Scripts in Cgt`). + +Asides for this requirement, the python script can contain anything valid +in |Python|, so don't hesitate to use any package or extention. + +Small example of Python/Stratus script: :: + + from Hurricane import * + from Stratus import * + + def doSomething (): + # ... + return + + def ScriptMain ( **kw ): + editor = None + if kw.has_key('editor') and kw['editor']: + editor = kw['editor'] + stratus.setEditor( editor ) + + doSomething() + return + + if __name__ == "__main__" : + kw = {} + success = ScriptMain( **kw ) + shellSuccess = 0 + if not success: shellSuccess = 1 + + sys.exit( shellSuccess ) + ScriptMain () + +This typical script can be executed in two ways: + +#. Run directly as a |Python| script, thanks to the :: + + if __name__ == "__main__" : + + part (this is standart |Python|). It is a simple adapter that will + calls :cb:`ScriptMain()`. +#. Through |cgt|, either in text or graphical mode. In that case, the + :cb:`ScriptMain()` is directly called trough a sub-interpreter. + The arguments of the script are passed through the ``**kw`` dictionnary. + + +----------------------+-----------------------------------------------+ + | \*\*kw Dictionnary | + +----------------------+-----------------------------------------------+ + | Parameter Key/Name | Contents type | + +======================+===============================================+ + | ``'cell'`` | A Hurricane cell on which to work. Depending | + | | on the context, it may be ``None``. | + | | For example, when run from |cgt|, it the cell | + | | currently loaded in the viewer, if any. | + +----------------------+-----------------------------------------------+ + | ``'editor'`` | The viewer from which the script is run, when | + | | lauched through |cgt|. | + +----------------------+-----------------------------------------------+ + + +Plugins +~~~~~~~ + +Plugins are |Python| scripts specially crafted to integrate with |cgt|. +Their entry point is a :cb:`ScriptMain()` method as described in +`Python Interface to Coriolis`_. They can be called by user scripts +through this method. + + + +Chip Placement +-------------- + +Automatically perform the placement of a complete chip. This plugin, as well +as the other P&R tools expect a specific top-level hierarchy for the design. +The top-level hierarchy must contains the instances of all the I/O pads and +**exactly one** instance of the chip's core model. + +|bcenter| |ChipStructure-1| |ecenter| + +The designer must provide a configuration file that define the rules for the +placement of the top-level hierarchy (that is, the pads and the core). +This file must be named after the chip's name, by appending ``_chip.py`` +(obviously, it is a |Python| file). For instance if the chip netlist file +is called ``amd2901_crl.vst``, then the configuration file must be named +``amd2901_crl_chip.vst``. + +Example of chip placement configuration file (for ``AM2901``): :: + + chip = \ + { 'pads.south' : [ 'p_a3' , 'p_a2' , 'p_a1' , 'p_r0' + , 'p_vddick0', 'p_vssick0', 'p_a0' , 'p_i6' + , 'p_i8' , 'p_i7' , 'p_r3' ] + , 'pads.east' : [ 'p_zero' , 'p_i0' , 'p_i1' , 'p_i2' + , 'p_vddeck0', 'p_vsseck0', 'p_q3' , 'p_b0' + , 'p_b1' , 'p_b2' , 'p_b3' ] + , 'pads.north' : [ 'p_noe' , 'p_y3' , 'p_y2' , 'p_y1' + , 'p_y0' , 'p_vddeck1', 'p_vsseck1', 'p_np' + , 'p_ovr' , 'p_cout' , 'p_ng' ] + , 'pads.west' : [ 'p_cin' , 'p_i4' , 'p_i5' , 'p_i3' + , 'p_ck' , 'p_d0' , 'p_d1' , 'p_d2' + , 'p_d3' , 'p_q0' , 'p_f3' ] + , 'core.size' : ( 1500, 1500 ) + , 'chip.size' : ( 3000, 3000 ) + , 'chip.clockTree' : True + } + +The file must contain *one dictionnary* named ``chip``. + ++----------------------+-------------------------------------------------------+ +| Chip Dictionnary | ++----------------------+-------------------------------------------------------+ +| Parameter Key/Name | Value/Contents type | ++======================+=======================================================+ +| ``'pad.south'`` | Ordered list (left to right) of pad instances names | +| | to put on the south side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.east'`` | Ordered list (down to up) of pad instances names | +| | to put on the east side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.north'`` | Ordered list (left to right) of pad instances names | +| | to put on the north side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'pad.west'`` | Ordered list (down to up) of pad instances names | +| | to put on the west side of the chip | ++----------------------+-------------------------------------------------------+ +| ``'core.size'`` | The size of the core (to be used by the placer) | ++----------------------+-------------------------------------------------------+ +| ``'chip.size'`` | The size of the whole chip. The sides must be great | +| | enough to accomodate all the pads | ++----------------------+-------------------------------------------------------+ +| ``'chip.clockTree'`` | Whether to generate a clock tree or not. This calls | +| | the ClockTree plugin | ++----------------------+-------------------------------------------------------+ + +Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Chip Plugin Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.count`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | The minimum number of rails around the core | +| | block. Must be odd and suppérior to 5. | +| | One rail for the clock and at least two pairs | +| | of power/grounds | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.hWidth`` | TypeInt | :cb:`12` | +| +------------------+----------------------------+ +| | The horizontal with of the rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.vWidth`` | TypeInt | :cb:`12` | +| +------------------+----------------------------+ +| | The vertical with of the rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.hSpacing`` | TypeInt | :cb:`6` | +| +------------------+----------------------------+ +| | The spacing, *edge to edge* of two adjacent | +| | horizontal rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.block.rails.vSpacing`` | TypeInt | :cb:`6` | +| +------------------+----------------------------+ +| | The spacing, *edge to edge* of two adjacent | +| | vertical rails | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pck`` | TypeString | :cb:`pck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | chip external clock | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvddeck`` | TypeString | :cb:`pvddeck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vdde`` (external power) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvsseck`` | TypeString | :cb:`pvsseck_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vsse`` (external ground) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvddick`` | TypeString | :cb:`pvddick_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vddi`` (internal power) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ +|``chip.pad.pvssick`` | TypeString | :cb:`pvssick_px` | +| +------------------+----------------------------+ +| | The model name of the pad connected to the | +| | ``vssi`` (internal ground) and suppling it to | +| | the core | ++-----------------------------------+------------------+----------------------------+ + +.. note:: + If no clock tree is generated, then the clock rail is *not* created. + So even if the requested number of rails ``chip.block.rails.count`` is, say 5, + only four rails (2* ``power``, 2* ``ground``) will be generateds. + + +Clock Tree +---------- + +Insert a clock tree into a block. The clock tree uses the H strategy. +The clock net is splitted into sub-nets, one for each branch of the +tree. + +* On **chips** design, the sub-nets are createds in the model of the + core block (then trans-hierarchically flattened to be shown at + chip level). +* On **blocks**, the sub nets are created directly in the top block. +* The sub-nets are named according to a simple geometrical scheme. + A common prefix ``ck_htree``, then one postfix by level telling + on which quarter of plane the sub-clock is located: + + #. ``_bl``: bottom left plane quarter. + #. ``_br``: bottom right plane quarter. + #. ``_tl``: top left plane quarter. + #. ``_tr``: top right plane quarter. + + We can have ``ck_htree_bl``, ``ck_htree_bl_bl``, ``ch_htree_bl_tl`` and so on. + +The clock tree plugin works in four steps: + +#. Build the clock tree: creates the top-block abutment box, compute the + levels of H tree neededs and place the clock buffers. +#. Once the clock buffers are placed, calls the placer (|etesian|) to place + the ordinary standart cells, whithout disturbing clock H-tree buffers. +#. At this point we know the exact positions of all the DFFs, so we can + connect them to the nearest H-tree leaf clock signal. +#. Leaf clock signals that are not connecteds to any DFFs are removed. + +Netlist reorganisation: + +* Obviously the top block or chip core model netlist is modificated to + contains all the clock sub-nets. The interface is *not* changed. +* If the top block contains instances of other models *and* those models + contains DFFs that get re-connecteds to the clock sub-nets (from the + top level). Change both the model netlist and interface to propagate + the relevant clock sub-nets to the instanciated model. The new model + with the added clock signal is renamed with a ``_clocked`` suffix. + For example, the sub-block model ``ram.vst`` will become ``ram_clocked.vst``. + +.. note:: + If you are to re-run the clock tree plugin on a netlist, be careful + to erase any previously generated ``_clocked`` file (both netlist and + layout: ``rm *.clocked.{ap,vst}``). And restart |cgt| to clear it's + memory cache. + +Configuration parameters, defaults are defined in ``etc/coriolis2//plugins.conf``. + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **ClockTree Plugin Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.minimumSide`` | TypeInt | :cb:`300` | +| +------------------+----------------------------+ +| | The minimum size below which the clock tree | +| | will stop to perform quadri-partitions | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.buffer`` | TypeString | :cb:`buf_x2` | +| +------------------+----------------------------+ +| | The buffer model to use to drive sub-nets | ++-----------------------------------+------------------+----------------------------+ +|``clockTree.placerEngine`` | TypeString | :cb:`Etesian` | +| +------------------+----------------------------+ +| | The placer to use. Other value is ``Mauka`` | +| | the simulated annealing placer which will go | +| | into retirement very soon | ++-----------------------------------+------------------+----------------------------+ + + +Recursive-Save (RSave) +---------------------- + +Perform a recursive top down save of all the models from the top cell +loaded in |cgt|. Force a write of any non-terminal model. This plugin is used +by the clock tree plugin after the netlist clock sub-nets creation. + + +A Simple Example: AM2901 +~~~~~~~~~~~~~~~~~~~~~~~~ + +To illustrate the capabilities of |Coriolis| tools and |Python| scripting, a small +example, derived from the |Alliance| :cb:`AM2901` is supplied. + +This example contains only the synthetized netlists and the :cb:`doChip.py` script +which perform the whole P&R of the design. + +You can generate the chip using one of the following method: + +#. **Command line mode:** directly run the script: :: + + dummy@lepka:AM2901$ ./doChip -V --cell=amd2901 + +#. **Graphic mode:** launch |cgt|, load chip netlist ``amd2901`` (the top cell) + then run the |Python| script :cb:`doChip.py`. + +.. note:: + Between two consecutive run, be sure to erase the netlist/layout generateds: :: + + dummy@lepka:AM2901$ rm *_clocked*.vst *.ap diff --git a/documentation/_build/html/_sources/UsersGuide/ViewerTools.txt b/documentation/_build/html/_sources/UsersGuide/ViewerTools.txt new file mode 100644 index 00000000..8313e1df --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/ViewerTools.txt @@ -0,0 +1,868 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + +.. URLs that changes between the various backends. +.. _Stratus Documentation: file:///usr/share/doc/coriolis2/en/html/stratus/index.html + + +.. |BigMouse| image:: ./images/ComputerMouse.png + :scale: 25% + +.. |ViewerSnapshot_1| image:: ./images/Viewer-1.png + :alt: Viewer Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSnapshot_1| image:: ./images/Controller-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerLook_1| image:: ./images/Controller-Look-1.png + :alt: Controller Look, Snapshot 1 + :align: middle + :width: 80% + +.. |ControllerFilter_1| image:: ./images/Controller-Filter-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerLayersGos_1| image:: ./images/Controller-LayersGos-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerNetlist_1| image:: ./images/Controller-Netlist-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ViewerNetlist_1| image:: ./images/Viewer-Netlist-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSelection_1| image:: ./images/Controller-Selection-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_1| image:: ./images/Controller-Inspector-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_2| image:: ./images/Controller-Inspector-2.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerInspector_3| image:: ./images/Controller-Inspector-3.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |ControllerSettings_1| image:: ./images/Controller-Settings-1.png + :alt: Controller Basic Snapshot + :align: middle + :width: 80% + +.. |Etesian-1| image:: ./images/etesian-1.png + :alt: Etesian Abutment Box + :align: middle + :width: 80% + + +CGT - The Graphical Interface +============================= + +The |Coriolis| graphical interface is split up into two windows. + +* The **Viewer**, with the following features: + + * Basic load/save capabilities. + * Display the current working cell. Could be empty if the design + is not yet placed. + * Execute Stratus Scripts. + * Menu to run the tools (placement, routage). + +Features are detailed in `Viewer & Tools`_. + +|ViewerSnapShot_1| + +* The **Controller**, which allows: + + * Tweak what is displayer by the *Viewer*. Through the *Look*, + *Filter* and *Layers&Gos* tabs. + * Browse the |netlist| with eponym tab. + * Show the list of selected objects (if any) with *selection* + * Walk through the Database, the Cell or the Selection with *Inspector*. + This is an advanced feature, reserved for experimented users. + * The tab *Settings* which give access to all the settings. + They are closely related to Configuration & Initialisation. + +|bcenter| |ControllerSnapShot_1| |ecenter| + + +.. _Viewer & Tools: + +Viewer & Tools +~~~~~~~~~~~~~~ + +|Stratus| Netlist Capture +------------------------- + +|Stratus| is the replacement for |GenLib| procedural netlist capture language. +It is designed as a set of |Python| classes, and comes with it's own documentation +(`Stratus Documentation`_) + + +The |Hurricane| Data-Base +------------------------- + +The |Alliance| flow is based on the |MBK| data-base, which has one data-structure +for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical* +view. The place and route tools were responsible for maintaining (or not) the +coherency between views. Reflecting this weak coupling between views, each one +was stored in a separate file with a specific format. The *logical* view is stored +in a |vst| file in |VHDL| format and the *physical* in an |ap| file in an ad-hoc format. + +The |Coriolis| flow is based on the |Hurricane| data-base, which has a unified +structure for *logical* and *physical* view. That data structure is the |Cell| object. +The |Cell| can have any state between pure netlist and completly placed and +routed design. Although the memory representation of the views has deeply +changed we still use the |Alliance| files format, but they now really represent +views of the same object. The point is that one must be very careful about +view coherency when going to and from |Coriolis|. + +As for the second release, |Coriolis| can be used only for three purposes : + +* **Placing a design**, in which case the |netlist| view must be present. +* **Routing a design**, in that case the |netlist| + view and the |layout| view must be present and |layout| view must contain + a placement. Both views must have the same name. When saving the routed design, + it is advised to change the design name otherwise the original unrouted placement + in the |layout| view will be overwritten. +* **Viewing a design**, the |netlist| view must be present, if a |layout| + view is present it still must have the same name but it can be in any + state. + + +Synthetizing and loading a design +--------------------------------- + +|Coriolis| supports several file formats. It can load all file format +from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst), +BLIF netlist format as well as benchmark formats from the ISPD contests. + +It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license +and may not be compiled in your version of the software. + +Synthesis under Yosys +..................... + +You can create a BLIF file from the |Yosys| synthetizer, which can be imported under Coriolis. +Most libraries are specified as a .lib liberty file and a .lef LEF file. +|Yosys| opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2. +If Coriolis hasn't been compiled against it, the library is given in |Alliance| .ap format. +`Some free libraries `_ already provide both .ap and .lib files. + +Once you have installed a common library under |Yosys| and Coriolis, just synthetize your design +with |Yosys| and import it (as Blif without the extension) under Coriolis to perform place&route. + +Synthesis under Alliance +........................ + +|Alliance| is an older toolchain but has been extensively used for years. Coriolis can import +and write Alliance designs and libraries directly. + +Etesian -- Placer +----------------- + +The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is +within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace. +This |Coriolis| tool is actually an encapsulation of |Coloquinte| which *is* the placer. + +.. note:: *Instance Uniquification Unsupported:* a same logical instance cannot have + two different placements. So, either you manually make a clone of it or you + supply a placement for it. We need to implement uniquification in the + |Hurricane| database. + + +|noindent| +**Hierarchical Placement** + +The placement area is defined by the top cell abutment box. + +When placing a complete hierarchy, the abutment boxes of the cells (models) other than +the top cell are sets identical to the one of the top cell and their instances are +all placed at position ``(0,0,ID)``. That is, all the abutments boxes, whatever the +hierarchical level, defines the same area (they are exactly superposed). + +We choose this scheme because the placer will see all the instances as virtually +flattened, so they can be placed anywhere inside the top-cell abutment box. + +|bcenter| |Etesian-1| |ecenter| + + +|noindent| +**Computing the Placement Area** + +The placement area is computed using the ``etesian.aspectRatio`` and ``etesian.spaceMargin`` +parameters only if the top-cell has an empty abutment box. If the top-cell abutment +box has to be set, then it is propagated to all the instances models recursively. + + +|noindent| +**Reseting the Placement** + +Once a placement has been done, the placer cannot reset it (will be implemented +later). To perform a new placement, you must restart |cgt|. In addition, if you +have saved the placement on disk, you must erase any :cb:`.ap` file, which are +automatically reloaded along with the netlist (:cb:`.vst`). + +|noindent| +**Limitations** + +Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version, +it doesn't support movable macros, and you must place every macro beforehand. +Timing and routability analysis are not included either, and the returned placement +may be unroutable. + + +Etesian Configuration Parameters +................................ + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Etesian Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``etesian.aspectRatio`` | TypePercentage | :cb:`100` | +| +------------------+----------------------------+ +| | Define the height on width ``H/W`` aspect | +| | ratio, can be comprised between 10 and 1000 | ++-----------------------------------+------------------+----------------------------+ +|``etesian.spaceMargin`` | TypePercentage | :cb:`5` | +| +------------------+----------------------------+ +| | The extra white space added to the total area | +| | of the standard cells | ++-----------------------------------+------------------+----------------------------+ +|``etesian.uniformDensity`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Whether the cells will be spread envenly | +| | across the area or allowed to form denser | +| | clusters | ++-----------------------------------+------------------+----------------------------+ +|``etesian.effort`` | TypeInt | :cb:`2` | +| +------------------+----------------------------+ +| | Sets the balance between the speed of the | +| | placer and the solution quality | ++-----------------------------------+------------------+----------------------------+ +|``etesian.routingDriven`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Whether the tool will try routing iterations | +| | and whitespace allocation to improve | +| | routability; to be implemented | ++-----------------------------------+------------------+----------------------------+ +|``etesian.graphics`` | TypeInt | :cb:`2` | +| +------------------+----------------------------+ +| | How often the display will be refreshed | +| | More refreshing slows the placer. | +| | | +| | * ``1`` shows both upper and lower bounds | +| | * ``2`` only shows lower bound results | +| | * ``3`` only shows the final results | ++-----------------------------------+-----------------------------------------------+ + +|newpage| + + +Knik -- Global Router +--------------------- + +The quality of |Knik| global routing solutions are equivalent to those of FGR_ 1.0. +For an in-depth description of |Knik| algorithms, you may download the thesis of +D. |Dupuis| avalaible from here~: `Knik Thesis`_. + +The global router is (not yet) deterministic. To circumvent this limitation, +a global routing *solution* can be saved to disk and reloaded for later uses. + +A global routing is saved into a file with the same name as the design and a +|kgr| extention. It is in `Box Router`_ output format. + +|noindent| Menus: + +* :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Save Global Routing}` +* :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Load Global Routing}` + + +Kite -- Detailed Router +----------------------- + +|Kite| no longer suffers from the limitations of |Nero|. It can route big designs +as its runtime and memory footprint is almost linear (with respect to the number +of gates). It has successfully routed design of more than `150K` gates. +|medskip| + +|noindent| However, this first release comes with the temporary the following +restrictions: + +* Works only with |SxLib| standard cell gauge. +* Works always with 4 routing metal layers (`M2` through `M5`). +* Do not allow (take into account) pre-routed wires on signals + other than |POWER| or |GROUND|. + +.. note:: + **Slow Layer Assignment.** Most of the time, the layer assignment stage is + fast (less than a dozen seconds), but in some instances it can take more + than a dozen *minutes*. This is a known bug and will be corrected in later + releases. + +After each run, |Kite| displays a set of *completion ratios* which must all +be equal to `100%` if the detailed routing has been successfull. +In the event of a failure, on a saturated design, you may decrease the +`edge saturation ratio` (argument `--edge`) to balance more evenly the design +saturation. That is, the maximum saturation decrease at the price of a wider +saturated area and increased wirelength. This is the saturation of the +*global* router |Knik|, and you may increase/decrease by steps of ``5%``, +which represent one track. The maximum capacity of the |SxLib| gauge is +10 tracks in two layers, that makes 20 tracks by |Knik| edge. + +Routing a design is done in four ordered steps: + +#. Detailed pre-route :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed PreRoute}` +#. Global routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Global Route}` +#. Detailed routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed Route}` +#. Finalize routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Finalize Route}` + +It is possible to supply to the router a complete wiring for some nets that the user's +wants to be routed according to a specific topology. The supplied topology must respect +the building rules of the |Katabatic| database (contacts must be, terminals, turns, h-tee +& v-tee only). During the first step :fboxtt:`Detailed Pre-Route` the router will solve +overlaps between the segments, without making any dogleg. If no pre-routed topologies +are present, this step may be ommited. Any net routed at this step is then fixed and +become unmovable for the later stages. + +After the detailed routing step the |Kite| data-structure is still active +(the Hurricane wiring is decorated). The finalize step performs the removal of +the |Kite| data-structure, and it is not advisable to save the design before +that step. + +You may visualize the density (saturation) of either |Knik| (on edges) or +|Kite| (on GCells) until the routing is finalized. Special layers appears +to that effect in the `The Layers&Go Tab`_. + + +Kite Configuration Parameters +............................. + +As |Knik| is only called through |Kite|, it's parameters also have +the :cb:`kite.` prefix. + +The |Katabatic| parameters control the layer assignment step. + +All the defaults value given below are from the default |Alliance| technology +(:cb:`cmos` and :cb:`SxLib` cell gauge/routing gauge). + ++-----------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++===================================+==================+============================+ +| **Katabatic Parameters** | ++-----------------------------------+------------------+----------------------------+ +|``katabatic.topRoutingLayer`` | TypeString | :cb:`METAL5` | +| +------------------+----------------------------+ +| | Define the highest metal layer that will be | +| | used for routing (inclusive). | ++-----------------------------------+------------------+----------------------------+ +|``katabatic.globalLengthThreshold``| TypeInt | :cb:`1450` | +| +------------------+----------------------------+ +| | This parameter is used by a layer assignment | +| | method which is no longer used (did not give | +| | good results) | ++-----------------------------------+------------------+----------------------------+ +| ``katabatic.saturateRatio`` | TypePercentage | :cb:`80` | +| +------------------+----------------------------+ +| | If ``M(x)`` density is above this ratio, | +| | move up feedthru global segments up from | +| | depth ``x`` to ``x+2`` | ++-----------------------------------+------------------+----------------------------+ +| ``katabatic.saturateRp`` | TypeInt | :cb:`8` | +| +------------------+----------------------------+ +| | If a GCell contains more terminals | +| | (:cb:`RoutingPad`) than that number, force a | +| | move up of the connecting segments to those | +| | in excess | ++-----------------------------------+------------------+----------------------------+ +| **Knik Parameters** | ++-----------------------------------+------------------+----------------------------+ +| ``kite.hTracksReservedLocal`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | To take account the tracks needed *inside* a | +| | GCell to build the *local* routing, decrease | +| | the capacity of the edges of the global | +| | router. Horizontal and vertical locally | +| | reserved capacity can be distinguished for | +| | more accuracy. | ++-----------------------------------+------------------+----------------------------+ +| ``kite.vTracksReservedLocal`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | cf. ``kite.hTracksReservedLocal`` | ++-----------------------------------+------------------+----------------------------+ +| **Kite Parameters** | ++-----------------------------------+------------------+----------------------------+ +| ``kite.eventsLimit`` | TypeInt | :cb:`4000002` | +| +------------------+----------------------------+ +| | The maximum number of segment displacements, | +| | this is a last ditch safety against infinite | +| | loop. It's perhaps a little too low for big | +| | designs | ++-----------------------------------+------------------+----------------------------+ +| ``kite.ripupCost`` | TypeInt | :cb:`3` | +| +------------------+----------------------------+ +| | Differential introduced between two ripup | +| | cost to avoid a loop between two ripped up | +| | segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.strapRipupLimit`` | TypeInt | :cb:`16` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *strap* segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.localRipupLimit`` | TypeInt | :cb:`9` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *local* segments | ++-----------------------------------+------------------+----------------------------+ +| ``kite.globalRipupLimit`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *global* segments,| +| | when this limit is reached, triggers topologic| +| | modification | ++-----------------------------------+------------------+----------------------------+ +| ``kite.longGlobalRipupLimit`` | TypeInt | :cb:`5` | +| +------------------+----------------------------+ +| | Maximum number of ripup for *long global* | +| | segments, when this limit is reached, triggers| +| | topological modification | ++-----------------------------------+------------------+----------------------------+ + + + +.. _Python Scripts in Cgt: + +Executing Python Scripts in Cgt +------------------------------- + +Python/Stratus scripts can be executed either in text or graphical mode. + +.. note:: **How Cgt Locates Python Scripts:** + |cgt| uses the Python ``import`` mechanism to load Python scripts. + So you must give the name of your script whitout ``.py`` extention and + it must be reachable through the ``PYTHONPATH``. You may uses the + dotted module notation. + +A Python/Stratus script must contains a function called ``ScriptMain()`` +with one optional argument, the graphical editor into which it may be +running (will be set to ``None`` in text mode). The Python interface to +the editor (type: :cb:`CellViewer`) is limited to basic capabilities +only. + +Any script given on the command line will be run immediatly *after* the +initializations and *before* any other argument is processed. + +For more explanation on Python scripts see :ref:`Python Interface to Coriolis`. + + +Printing & Snapshots +-------------------- + +Printing or saving into a |pdf| is fairly simple, just uses the **File -> Print** +menu or the |CTRL_P| shortcut to open the dialog box. + +The print functionality uses exactly the same rendering mechanism as for the +screen, beeing almost *WYSIWYG*. Thus, to obtain the best results it is advisable +to select the ``Coriolis.Printer`` look (in the *Controller*), which uses a +white background and much suited for high resolutions ``32x32`` pixels patterns + +There is also two mode of printing selectable through the *Controller* +**Settings -> Misc -> Printer/Snapshot Mode**: + +=============== ================= ===================================================== +Mode DPI (approx.) Intended Usage +--------------- ----------------- ----------------------------------------------------- +**Cell Mode** 150 For single ``Cell`` printing or very small designs. + Patterns will be bigger and more readable. +**Design Mode** 300 For designs (mostly commposed of wires and cells + outlines). +=============== ================= ===================================================== + +.. note:: *The pdf file size* + Be aware that the generated |pdf| files are indeed only pixmaps. + So they can grew very large if you select paper format above ``A2`` + or similar. + + +|noindent| +Saving into an image is subject to the same remarks as for |pdf|. + + +Memento of Shortcuts in Graphic Mode +------------------------------------ + +The main application binary is |cgt|. + ++---------------+-------------------+-----------------------------------------------------------+ +| Category | Keys | Action | ++===============+===================+===========================================================+ +| **Moves** | | |KeyUp|, | Shift the view in the according direction | +| | |KeyDown| | | +| | | |KeyLeft|, | | +| | |KeyRight| | | ++---------------+-------------------+-----------------------------------------------------------+ +| **Fit** | |KeyF| | Fit to the Cell abutment box | ++---------------+-------------------+-----------------------------------------------------------+ +| **Refresh** | |CTRL_L| | Triggers a complete display redraw | ++---------------+-------------------+-----------------------------------------------------------+ +| **Goto** | |KeyG| | *apperture* is the minimum side of the area | +| | | displayed around the point to go to. It's an | +| | | alternative way of setting the zoom level | ++---------------+-------------------+-----------------------------------------------------------+ +| **Zoom** | |KeyZ|, | Respectively zoom by a 2 factor and *unzoom* | +| | |KeyM| | by a 2 factor | +| +-------------------+-----------------------------------------------------------+ +| | | |BigMouse| | You can perform a zoom to an area. | +| | | Area Zoom | Define the zoom area by *holding down the left | +| | | mouse button* while moving the mouse. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Selection** | | |BigMouse| | You can select displayed objects under an area. | +| | | Area Selection | Define the selection area by *holding down the | +| | | right mouse button* while moving the mouse. | +| +-------------------+-----------------------------------------------------------+ +| | | |BigMouse| | You can toggle the selection of one object under | +| | | Toggle Selection| the mouse position by pressing |CTRL| and | +| | | pressing down *the right mouse button*. A popup | +| | | list of what's under the position shows up into | +| | | which you can toggle the selection state of one | +| | | item. | +| +-------------------+-----------------------------------------------------------+ +| | |KeyCapS| | Toggle the selection visibility | ++---------------+-------------------+-----------------------------------------------------------+ +| **Controller**| |CTRL_I| | Show/hide the controller window. | +| | | | +| | | It's the Swiss Army Knife of the viewer. | +| | | From it, you can fine-control the display and | +| | | inspect almost everything in your design. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Rulers** | |KeyK|, | One stroke on |KeyK| enters the ruler mode, in | +| | |KeyESC| | which you can draw one ruler. You can exit the | +| | | ruler mode by pressing |KeyESC|. Once in ruler | +| | | mode, the first click on the *left mouse button* | +| | | sets the ruler's starting point and the second | +| | | click the ruler's end point. The second click | +| | | exits automatically the ruler mode. | +| +-------------------+-----------------------------------------------------------+ +| | |KeyCapK| | Clears all the drawn rulers | ++---------------+-------------------+-----------------------------------------------------------+ +| **Print** | |CTRL_P| | Currently rather crude. It's a direct copy of | +| | | what's displayed in pixels. So the resulting | +| | | picture will be a little blurred due to | +| | | anti-aliasing mechanism. | ++---------------+-------------------+-----------------------------------------------------------+ +| **Open/Close**| |CTRL_O| | Opens a new design. The design name must be | +| | | given without path or extention. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_W| | Close the current viewer window, but do not quit | +| | | the application. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_Q| | `CTRL+Q` quit the application | +| | | (closing all windows). | ++---------------+-------------------+-----------------------------------------------------------+ +| **Hierarchy** | |CTRL_Down| | Go one hierarchy level down. That is, if there | +| | | is an *instance* under the cursor position, load | +| | | it's *model* Cell in place of the current one. | +| +-------------------+-----------------------------------------------------------+ +| | |CTRL_Up| | Go one hierarchy level up. if we have entered | +| | | the current model through |CTRL_Down| | +| | | reload the previous model (the one | +| | | in which this model is instanciated). | ++---------------+-------------------+-----------------------------------------------------------+ + + +Cgt Command Line Options +------------------------ + +Appart from the obvious ``--text`` options, all can be used for text and graphical mode. + ++-----------------------------+------------------------------------------------+ +| Arguments | Meaning | ++=============================+================================================+ +| `-t|--text` | Instruct |cgt| to run in text mode. | ++-----------------------------+------------------------------------------------+ +| `-L|--log-mode` | Disable the uses of |ANSI| escape sequence on | +| | the |tty|. Useful when the output is | +| | redirected to a file. | ++-----------------------------+------------------------------------------------+ +| `-c |--cell=` | The name of the design to load, without | +| | leading path or extention. | ++-----------------------------+------------------------------------------------+ +| `-g|--load-global` | Reload a global routing solution from disk. | +| | The file containing the solution must be named | +| | `.kgr`. | ++-----------------------------+------------------------------------------------+ +| `--save-global` | Save the global routing solution, into a file | +| | named `.kgr`. | ++-----------------------------+------------------------------------------------+ +| `-e |--edge=` | Change the edge capacity for the global | +| | router, between 0 and 1 (|Knik|). | ++-----------------------------+------------------------------------------------+ +| `-G|--global-route` | Run the global router (|Knik|). | ++-----------------------------+------------------------------------------------+ +| `-R|--detailed-route` | Run the detailed router (|Kite|). | ++-----------------------------+------------------------------------------------+ +| `-s|--save-design=` | The design into which the routed layout will | +| | be saved. It is strongly recommanded to choose | +| | a different name from the source (unrouted) | +| | design. | ++-----------------------------+------------------------------------------------+ +| `--events-limit=` | The maximal number of events after which the | +| | router will stops. This is mainly a failsafe | +| | against looping. The limit is sets to 4 | +| | millions of iteration which should suffice to | +| | any design of `100K`. gates. For bigger | +| | designs you may wants to increase this limit. | ++-----------------------------+------------------------------------------------+ +| `--stratus-script=` | Run the Python/Stratus script ``module``. | +| | See `Python Scripts in Cgt`_. | ++-----------------------------+------------------------------------------------+ + +|newpage| + + +Some Examples : + +* Run both global and detailed router, then save the routed design : :: + + > cgt -v -t -G -R --cell=design --save-design=design_kite + +* Load a previous global solution, run the detailed router, then save the + routed design : :: + + > cgt -v -t --load-global -R --cell=design --save-design=design_kite + +* Run the global router, then save the global routing solution : :: + + > cgt -v -t -G --save-global --cell=design + + +Miscellaneous Settings +---------------------- + ++---------------------------------------+------------------+----------------------------+ +| Parameter Identifier | Type | Default | ++=======================================+==================+============================+ +| **Verbosity/Log Parameters** | ++---------------------------------------+------------------+----------------------------+ +| ``misc.info`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Enable display of *info* level message | +| | (:cb:`cinfo` stream) | ++---------------------------------------+------------------+----------------------------+ +| ``misc.bug`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Enable display of *bug* level message | +| | (:cb:`cbug` stream), messages can be a little | +| | scarry | ++---------------------------------------+------------------+----------------------------+ +| ``misc.logMode`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | If enabled, assume that the output device | +| | is not a ``tty`` and suppress any escaped | +| | sequences | ++---------------------------------------+------------------+----------------------------+ +| ``misc.verboseLevel1`` | TypeBool | :cb:`True` | +| +------------------+----------------------------+ +| | First level of verbosity, disable level 2 | ++---------------------------------------+------------------+----------------------------+ +| ``misc.verboseLevel2`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | Second level of verbosity | ++---------------------------------------+------------------+----------------------------+ +| **Development/Debug Parameters** | ++---------------------------------------+------------------+----------------------------+ +| ``misc.minTraceLevel`` | TypeInt | :cb:`0` | ++---------------------------------------+------------------+----------------------------+ +| ``misc.maxTraceLevel`` | TypeInt | :cb:`0` | +| +------------------+----------------------------+ +| | Display trace information *between* those two | +| | levels (:cb:`cdebug` stream) | ++---------------------------------------+------------------+----------------------------+ +| ``misc.catchCore`` | TypeBool | :cb:`False` | +| +------------------+----------------------------+ +| | By default, |cgt| do not dump core. | +| | To generate one set this flag to :cb:`True` | ++---------------------------------------+------------------+----------------------------+ + +|newpage| + + +.. _The Controller: + +The Controller +~~~~~~~~~~~~~~ + +The *Controller* window is composed of seven tabs: + +#. `The Look Tab`_ to select the display style. +#. `The Filter Tab`_ the hierarchical levels to be displayed, the look of + rubbers and the dimension units. +#. `The Layers&Go Tab`_ to selectively hide/display layers. +#. `The Netlist Tab`_ to browse through the |netlist|. Works in association + with the *Selection* tab. +#. `The Selection Tab`_ allow to view all the currently selected elements. +#. `The Inspector Tab`_ browse through either the DataBase, the Cell or + the current selection. +#. `The Settings Tab`_ access all the tool's configuration settings. + + +.. _The Look Tab: + +The Look Tab +------------ + +You can select how the layout will be displayed. There is a special one +``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_. +You should select it prior to calling the print or snapshot dialog boxes. + +|bcenter| |ControllerLook_1| |ecenter| + +|newpage| + + +.. _The Filter Tab: + +The Filter Tab +-------------- + +The filter tab let you select what hierarchical levels of your design will be +displayed. Hierarchy level are numbered top-down: the level 0 correspond to +the top-level cell, the level one to the instances of the top-level Cell and +so on. + +There are also check boxes to enable/disable the processing of Terminal Cell, +Master Cells and Compnents. The processing of Terminal Cell (hierarchy leaf +cells) is disabled by default when you load a hierarchical design and enabled +when you load a single Cell. + +You can choose what kind of form to give to the rubbers and the type of +unit used to display coordinates. + +.. note:: *What are Rubbers:* |Hurricane| uses *Rubbers* to materialize + physical gaps in net topology. That is, if some wires are missing to + connect two or more parts of net, a *rubber* will be drawn between them + to signal the gap. + + For example, after the detailed routing no *rubbers* should remains. + They have been made *very* visibles as big violet lines... + +|bcenter| |ControllerFilter_1| |ecenter| + +|newpage| + + +.. _The Layers&Go Tab: + +The Layers&Go Tab +----------------- + +Control the individual display of all *layers* and *Gos*. + +* *Layers* correspond to a true physical layer. From a |Hurricane| point of + view they are all the *BasicLayers* (could be matched to GDSII). +* *Gos* stands from *Graphical Objects*, they are drawings that have no + physical existence but are added by the various tools to display extra + information. One good exemple is the density map of the detailed router, + to easily locate congested areas. + +For each layer/Go there are two check boxes: + +* The normal one triggers the display. +* The red-outlined allows objects of that layer to be selectable or not. + +|bcenter| |ControllerLayersGos_1| |ecenter| + + +.. _The Netlist Tab: + +The Netlist Tab +--------------- + +The *Netlist* tab shows the list of nets... By default the tab is not +*synched* with the displayed Cell. To see the nets you must check the +**Sync Netlist** checkbox. You can narrow the set of displayed nets by +using the filter pattern (supports regular expressions). + +An very useful feature is to enable the **Sync Selection**, which will +automatically select all the components of the selected net(s). You can +select multiple nets. In the figure the net ``auxsc35`` is selected and +is highlited in the *Viewer*. + +|bcenter| |ControllerNetlist_1| |ecenter| +|bcenter| |ViewerNetlist_1| |ecenter| + + +.. _The Selection Tab: + +The Selection Tab +----------------- + +The *Selection* tab list all the components currently selecteds. They +can be filtered thanks to the filter pattern. + +Used in conjunction with the *Netlist* **Sync Selection** you will all see +all the components part of *net*. + +In this list, you can toggle individually the selection of component by +pressing the ``t`` key. When unselected in this way a component is not +removed from the the selection list but instead displayed in red italic. +To see where a component is you may make it blink by repeatedly press +the ``t`` key... + +|bcenter| |ControllerSelection_1| |ecenter| + + +.. _The Inspector Tab: + +The Inspector Tab +----------------- + +This tab is very useful, but mostly for |Coriolis| developpers. It allows +to browse through the live DataBase. The *Inspector* provide three entry points: + +* **DataBase**: Starts from the whole |Hurricane| DataBase. +* **Cell**: Inspect the currently loaded Cell. +* **Selection**: Inspect the object currently highlited in the *Selection* tab. + +Once an entry point has been activated, you may recursively expore all +it's fields using the right/left arrows. + +.. note:: *Do not put your fingers in the socket:* when inspecting + anything, do not modify the DataBase. If any object under inspection + is deleted, you will crash the application... + +.. note:: *Implementation Detail:* the inspector support is done with + ``Slot``, ``Record`` and ``getString()``. + +|bcenter| |ControllerInspector_1| |ecenter| +|bcenter| |ControllerInspector_2| |ecenter| +|bcenter| |ControllerInspector_3| |ecenter| + + +.. _The Settings Tab: + +The Settings Tab +---------------- + +Here comes the description of the *Settings* tab. + +|bcenter| |ControllerSettings_1| |ecenter| diff --git a/documentation/_build/html/_sources/UsersGuide/index.txt b/documentation/_build/html/_sources/UsersGuide/index.txt new file mode 100644 index 00000000..7121510a --- /dev/null +++ b/documentation/_build/html/_sources/UsersGuide/index.txt @@ -0,0 +1,21 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. include:: ../etc/definitions.rst + + +======================= +Coriolis User's Guide +======================= + +Printable version of this document `UsersGuide.pdf <../../../pdf/main/UsersGuide.pdf>`_. + + +.. toctree:: + :maxdepth: 2 + + LicenseCredits.rst + Releases.rst + Installation.rst + Configuration.rst + ViewerTools.rst + ScriptsPlugins.rst diff --git a/documentation/_build/html/_sources/Viewer/Viewer.txt b/documentation/_build/html/_sources/Viewer/Viewer.txt new file mode 100644 index 00000000..c103b413 --- /dev/null +++ b/documentation/_build/html/_sources/Viewer/Viewer.txt @@ -0,0 +1,11 @@ +.. -*- Mode: rst -*- + +.. include:: ../etc/definitions.rst + + +================== +Viewer Reference +================== + +The Viewer C++ API reference is generated by Doxygen_ and is +available here: `Viewer `_ diff --git a/documentation/_build/html/_sources/etc/definitions.txt b/documentation/_build/html/_sources/etc/definitions.txt new file mode 100644 index 00000000..ab364f9b --- /dev/null +++ b/documentation/_build/html/_sources/etc/definitions.txt @@ -0,0 +1,182 @@ +.. -*- Mode: rst; explicit-buffer-name: "definition.rst" -*- + + +.. role:: raw-html(raw) + :format: html + +.. role:: raw-latex(raw) + :format: latex + +.. role:: ul +.. role:: cb +.. role:: sc +.. role:: fboxtt + +.. HTML/LaTeX backends mixed macros. +.. |br| replace:: :raw-latex:`\linebreak` :raw-html:`
` +.. |medskip| replace:: :raw-latex:`\medskip` :raw-html:`
` +.. |newpage| replace:: :raw-latex:`\newpage` +.. |linebreak| replace:: :raw-latex:`\smallskip` +.. |noindent| replace:: :raw-latex:`\noindent` :raw-html:`

` +.. |dotfill| replace:: :raw-html:`  ` +.. |bcenter| replace:: :raw-latex:`\begin{center}` +.. |ecenter| replace:: :raw-latex:`\end{center}` +.. |pagestylefancy| replace:: :raw-latex:`\thispagestyle{fancy}` + + +.. Acronyms & names. +.. |GNU| replace:: :sc:`gnu` +.. |LGPL| replace:: :sc:`lgpl` +.. |GPL| replace:: :sc:`gpl` +.. |UPMC| replace:: :sc:`upmc` +.. |Bull| replace:: :sc:`Bull` +.. |Cadence| replace:: :sc:`Cadence` +.. |Si2| replace:: :sc:`Si2` +.. |LEFDEF| replace:: :sc:`lefdef` +.. |Flute| replace:: :sc:`Flute` +.. |MacOS| replace:: :sc:`MacOS` +.. |RHEL6| replace:: :sc:`rhel6` +.. |RHEL7| replace:: :sc:`rhel7` +.. |SL6| replace:: :sc:`Scientific Linux 6` +.. |SL7| replace:: :sc:`Scientific Linux 7` +.. |Scientific Linux| replace:: :sc:`Scientific Linux` +.. |RedHat| replace:: :sc:`RedHat` +.. |Fedora| replace:: :sc:`Fedora` +.. |FC13| replace:: :sc:`fc13` +.. |Debian| replace:: :sc:`Debian` +.. |Ubuntu| replace:: :sc:`Ubuntu` + +.. |Alexandre| replace:: :sc:`Alexandre` +.. |Belloeil| replace:: :sc:`Belloeil` +.. |Chaput| replace:: :sc:`Chaput` +.. |Chu| replace:: :sc:`Chu` +.. |Clement| replace:: :sc:`Clement` +.. |Dupuis| replace:: :sc:`Dupuis` +.. |Escassut| replace:: :sc:`Escassut` +.. |Gouvine| replace:: :sc:`Gouvine` +.. |Masson| replace:: :sc:`Masson` +.. |Sroka| replace:: :sc:`Sroka` +.. |Yifei| replace:: :sc:`Yifei` + +.. |ANSI| replace:: :sc:`ansi` +.. |MIPS| replace:: :sc:`mips` +.. |Am2901| replace:: :sc:`Am2901` +.. |Hurricane| replace:: :sc:`Hurricane` +.. |HurricaneAMS| replace:: :sc:`HurricaneAMS` +.. |Alliance| replace:: :sc:`Alliance` +.. |Yosys| replace:: :sc:`Yosys` +.. |GenLib| replace:: :sc:`GenLib` +.. |Nero| replace:: :sc:`Nero` +.. |Druc| replace:: :cb:`Druc` +.. |Coloquinte| replace:: :sc:`Coloquinte` +.. |Coriolis| replace:: :sc:`Coriolis` +.. |Coriolis1| replace:: :sc:`Coriolis 1` +.. |Coriolis2| replace:: :sc:`Coriolis 2` +.. |VLSISAPD| replace:: :sc:`vlsisapd` +.. |CRLcore| replace:: :sc:`CRLcore` +.. |Cyclop| replace:: :sc:`Cyclop` +.. |Nimbus| replace:: :sc:`Nimbus` +.. |hMetis| replace:: :sc:`hMetis` +.. |Mauka| replace:: :sc:`Mauka` +.. |Etesian| replace:: :sc:`Etesian` +.. |Knik| replace:: :sc:`Knik` +.. |Katabatic| replace:: :sc:`Katabatic` +.. |Kite| replace:: :sc:`Kite` +.. |Stratus| replace:: :sc:`Stratus` +.. |Stratus1| replace:: :sc:`Stratus1` +.. |Stratus2| replace:: :sc:`Stratus2` +.. |Unicorn| replace:: :sc:`Unicorn` +.. |ccb| replace:: :cb:`ccb` +.. |cgt| replace:: :cb:`cgt` +.. |Chams| replace:: :sc:`Chams` +.. |OpenChams| replace:: :sc:`OpenChams` +.. |Pharos| replace:: :cb:`Pharos` +.. |API| replace:: :sc:`api` +.. |STL| replace:: :sc:`stl` +.. |XML| replace:: :sc:`xml` +.. |pdf| replace:: :sc:`pdf` +.. |UTF-8| replace:: :sc:`utf-8` +.. |Python| replace:: :sc:`Python` +.. |Linux| replace:: :sc:`Linux` +.. |MacPorts| replace:: :sc:`MacPorts` +.. |devtoolset2| replace:: :cb:`devtoolset2` +.. |boost| replace:: :cb:`boost` +.. |Qt| replace:: :sc:`qt` +.. |tty| replace:: :cb:`tty` +.. |svn| replace:: :cb:`svn` +.. |git| replace:: :cb:`git` +.. |rpm| replace:: :cb:`rpm` +.. |gdb| replace:: :cb:`gdb` +.. |cmake| replace:: :cb:`cmake` +.. |struct| replace:: :cb:`struct` + +.. |KeyUp| replace:: :fboxtt:`Up` +.. |KeyDown| replace:: :fboxtt:`Down` +.. |KeyLeft| replace:: :fboxtt:`Left` +.. |KeyRight| replace:: :fboxtt:`Right` +.. |KeyF| replace:: :fboxtt:`f` +.. |KeyL| replace:: :fboxtt:`l` +.. |KeyG| replace:: :fboxtt:`g` +.. |KeyZ| replace:: :fboxtt:`z` +.. |KeyM| replace:: :fboxtt:`m` +.. |KeyI| replace:: :fboxtt:`i` +.. |KeyK| replace:: :fboxtt:`k` +.. |KeyP| replace:: :fboxtt:`p` +.. |KeyO| replace:: :fboxtt:`o` +.. |KeyW| replace:: :fboxtt:`w` +.. |KeyQ| replace:: :fboxtt:`q` +.. |KeyCapK| replace:: :fboxtt:`K` +.. |KeyCapS| replace:: :fboxtt:`S` +.. |Plus| replace:: :fboxtt:`+` +.. |KeyESC| replace:: :fboxtt:`ESC` +.. |CTRL| replace:: :fboxtt:`CTRL` +.. |CTRL_L| replace:: :fboxtt:`CTRL+L` +.. |CTRL_I| replace:: :fboxtt:`CTRL+I` +.. |CTRL_P| replace:: :fboxtt:`CTRL+P` +.. |CTRL_O| replace:: :fboxtt:`CTRL+O` +.. |CTRL_W| replace:: :fboxtt:`CTRL+W` +.. |CTRL_Q| replace:: :fboxtt:`CTRL+Q` +.. |CTRL_Down| replace:: :fboxtt:`CTRL+Down` +.. |CTRL_Up| replace:: :fboxtt:`CTRL+Up` +.. |CTRL_Left| replace:: :fboxtt:`CTRL+Left` +.. |CTRL_Right| replace:: :fboxtt:`CTRL+Right` + +.. URLs +.. _Doxygen: http://www.stack.nl/~dimitri/doxygen/ +.. _LaTeX2HTML: http://www.latex2html.org/ +.. _FGR: http://vlsicad.eecs.umich.edu/BK/FGR/ +.. _Box Router: http://www.cerc.utexas.edu/~thyeros/boxrouter/boxrouter.htm +.. _hMETIS: http://glaros.dtc.umn.edu/gkhome/views/metis +.. _Knik Thesis: http://www-soc.lip6.fr/en/users/damiendupuis/PhD/ +.. _RapidJSON: http://miloyip.github.io/rapidjson/ +.. _Python/C API Reference Manual: https://docs.python.org/2/c-api/index.html + +.. Standard CAO/VLSI Concepts. +.. |netlist| replace:: *netlist* +.. |netlists| replace:: *netlists* +.. |layout| replace:: *layout* +.. |layouts| replace:: *layouts* +.. |CMOS| replace:: :sc:`cmos` +.. |VHDL| replace:: :sc:`vhdl` +.. |NWELL| replace:: :sc:`nwell` +.. |POWER| replace:: :sc:`power` +.. |GROUND| replace:: :sc:`ground` + +.. MBK Concepts +.. |MBK| replace:: :sc:`mbk` +.. |LOFIG| replace:: :cb:`Lofig` +.. |PHFIG| replace:: :cb:`Phfig` +.. |SxLib| replace:: :sc:`SxLib` +.. |RDS| replace:: :sc:`rds` + +.. Hurricane Concepts. +.. |hypernet| replace:: *hypernet* +.. |hypernets| replace:: *hypernets* +.. |Cell| replace:: *Cell* +.. |Rings| replace:: *Rings* +.. |QuadTrees| replace:: *QuadTrees* +.. |Collections| replace:: *Collections* +.. |ap| replace:: :cb:`ap` +.. |vst| replace:: :cb:`vst` +.. |kgr| replace:: :cb:`kgr` +.. |dot_conf| replace:: :cb:`.conf` diff --git a/documentation/_build/html/_sources/index.txt b/documentation/_build/html/_sources/index.txt new file mode 100644 index 00000000..09bf0f90 --- /dev/null +++ b/documentation/_build/html/_sources/index.txt @@ -0,0 +1,36 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. Coriolis documentation master file, created by + sphinx-quickstart on Mon Jul 10 15:08:36 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Coriolis's documentation! +==================================== + +Contents: + +.. toctree:: + + UsersGuide/index.rst + Stratus/Stratus.rst + DpGen/DpGen.rst + Patterns/Patterns.rst + Hurricane/Hurricane.rst + Viewer/Viewer.rst + CrlCore/CrlCore.rst + Katabatic/Katabatic.rst + Kite/Kite.rst + Unicorn/Unicorn.rst + PythonCpp/index.rst + RDS/index.rst + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/documentation/etc/SoC-ReST.css b/documentation/_build/html/_static/SoC-ReST.css similarity index 96% rename from documentation/etc/SoC-ReST.css rename to documentation/_build/html/_static/SoC-ReST.css index eb5b2304..6b45edf2 100644 --- a/documentation/etc/SoC-ReST.css +++ b/documentation/_build/html/_static/SoC-ReST.css @@ -34,8 +34,10 @@ hr { color: #09550b; border: 1px dotted #09550b; border-style: none none dotted; +/* padding-top: 10pt; padding-bottom: 10pt; + */ } h2, h3 { @@ -77,6 +79,17 @@ div.contents p.first { font-weight: bold; } +table.contentstable { + width: 90%; +} + +table.contentstable, +table.contentstable tr, +table.contentstable tr td +{ + border: none; +} + div#centered { margin-left: auto; @@ -172,14 +185,14 @@ img.addborder { border: 1px solid black; } -img.align-center { +img.align-center, img.align-middle { display: block; /* clear: both; */ margin-left: auto; margin-right: auto; - width: 99%; + width: 70%; text-align: center; } @@ -206,7 +219,7 @@ div.note { border-left-style: solid; padding: 1px 10pt 1px 55px; /*background: #fff676 url('/dsk/l1/jpc/pictures/ReST/clipboard.png') no-repeat 0% 50%;;*/ - background: #ffdd66 url('../etc/images/clipboard.png') no-repeat 0% 50%;; + background: #ffdd66 url('../_static/images/clipboard.png') no-repeat 0% 50%;; font-size: 90% } @@ -216,7 +229,7 @@ div.error { border-left-width: 4px; border-left-style: solid; padding: 1px 10pt 1px 55px; - background: #ffddcc url('../etc/images/i-core.png') no-repeat 0% 50%;; + background: #ffddcc url('../_static/images/i-core.png') no-repeat 0% 50%;; font-size: 90% } diff --git a/documentation/_build/html/_static/SoC.css b/documentation/_build/html/_static/SoC.css new file mode 100644 index 00000000..391cd3e0 --- /dev/null +++ b/documentation/_build/html/_static/SoC.css @@ -0,0 +1,5 @@ + +@import url("../_static/css/theme.css"); +@import url("../_static/www-SoC.css"); +@import url("../_static/SoC-ReST.css"); +@import url("../_static/pygments.css"); diff --git a/documentation/_build/html/_static/ajax-loader.gif b/documentation/_build/html/_static/ajax-loader.gif new file mode 100644 index 00000000..61faf8ca Binary files /dev/null and b/documentation/_build/html/_static/ajax-loader.gif differ diff --git a/documentation/_build/html/_static/basic.css b/documentation/_build/html/_static/basic.css new file mode 100644 index 00000000..43e8bafa --- /dev/null +++ b/documentation/_build/html/_static/basic.css @@ -0,0 +1,540 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/documentation/_build/html/_static/comment-bright.png b/documentation/_build/html/_static/comment-bright.png new file mode 100644 index 00000000..551517b8 Binary files /dev/null and b/documentation/_build/html/_static/comment-bright.png differ diff --git a/documentation/_build/html/_static/comment-close.png b/documentation/_build/html/_static/comment-close.png new file mode 100644 index 00000000..09b54be4 Binary files /dev/null and b/documentation/_build/html/_static/comment-close.png differ diff --git a/documentation/_build/html/_static/comment.png b/documentation/_build/html/_static/comment.png new file mode 100644 index 00000000..92feb52b Binary files /dev/null and b/documentation/_build/html/_static/comment.png differ diff --git a/documentation/_build/html/_static/css/badge_only.css b/documentation/_build/html/_static/css/badge_only.css new file mode 100644 index 00000000..7e17fb14 --- /dev/null +++ b/documentation/_build/html/_static/css/badge_only.css @@ -0,0 +1,2 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}} +/*# sourceMappingURL=badge_only.css.map */ diff --git a/documentation/_build/html/_static/css/theme.css b/documentation/_build/html/_static/css/theme.css new file mode 100644 index 00000000..c865f138 --- /dev/null +++ b/documentation/_build/html/_static/css/theme.css @@ -0,0 +1,3886 @@ + +/* +*{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box} + +article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block} + +audio,canvas,video{display:inline-block; + *display:inline; + *zoom:1} + +audio:not([controls]){display:none} + +[hidden]{display:none} + +*{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box} + +html{font-size:80%; + -webkit-text-size-adjust:80%; + -ms-text-size-adjust:80%} +*/ + +body { margin: 0; } + +a:hover, a:active { outline: 0; } + +/* +abbr[title]{border-bottom:1px dotted} + +b,strong{font-weight:bold} + +blockquote{margin:0} + +dfn{font-style:italic} + +ins{background:#ff9; + color:#000; + text-decoration:none} + +mark{background:#ff0; + color:#000; + font-style:italic; + font-weight:bold} + +pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif; + _font-family:"courier new",monospace; + font-size:1em} + +pre{white-space:pre} + +q{quotes:none} + +q:before,q:after{content:""; + content:none} + +small{font-size:85%} + +sub,sup{font-size:75%; + line-height:0; + position:relative; + vertical-align:baseline} + +sup{top:-0.5em} + +sub{bottom:-0.25em} +*/ + +.wy-menu ul, +.wy-menu ol, +.wy-menu dl +{ + margin: 0; + padding: 0; + list-style: none; + list-style-image: none; +} + +.wy-menu li { list-style: none; } + +/* +dd{margin:0} + +img{border:0; + -ms-interpolation-mode:bicubic; + vertical-align:middle; + max-width:100%} + +svg:not(:root){overflow:hidden} + +figure{margin:0} + +form{margin:0} + +fieldset{border:0; + margin:0; + padding:0} + +label{cursor:pointer} + +legend{border:0; + *margin-left:-7px; + padding:0; + white-space:normal} + +button,input,select,textarea{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle} + +button,input{line-height:normal} + +button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer; + -webkit-appearance:button; + *overflow:visible} + +button[disabled],input[disabled]{cursor:default} + +input[type="checkbox"],input[type="radio"]{box-sizing:border-box; + padding:0; + *width:13px; + *height:13px} + +input[type="search"]{-webkit-appearance:textfield; + -moz-box-sizing:content-box; + -webkit-box-sizing:content-box; + box-sizing:content-box} + +input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none} + +button::-moz-focus-inner,input::-moz-focus-inner{border:0; + padding:0} + +textarea{overflow:auto; + vertical-align:top; + resize:vertical} + +.chromeframe{margin:0.2em 0; + background:#ccc; + color:#000; + padding:0.2em 0} + +.ir{display:block; + border:0; + text-indent:-999em; + overflow:hidden; + background-color:transparent; + background-repeat:no-repeat; + text-align:left; + direction:ltr; + *line-height:0} + +.ir br{display:none} + +.hidden{display:none !important; + visibility:hidden} + +.visuallyhidden{border:0; + clip:rect(0 0 0 0); + height:1px; + margin:-1px; + overflow:hidden; + padding:0; + position:absolute; + width:1px} + +.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto; + height:auto; + margin:0; + overflow:visible; + position:static; + width:auto} + +.invisible{visibility:hidden} + +.relative{position:relative} + +big,small{font-size:100%} + +@media print{html,body,section{background:none !important} + +*{box-shadow:none !important; + text-shadow:none !important; + filter:none !important; + -ms-filter:none !important} + +a,a:visited{text-decoration:underline} +*/ + +.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""} + +/* +pre,blockquote{page-break-inside:avoid} + +thead{display:table-header-group} + +tr,img{page-break-inside:avoid} + +img{max-width:100% !important} + +@page{margin:0.5cm} + +p,h2,.rst-content p.caption,h3{orphans:3; + widows:3} + +h2,.rst-content p.caption,h3{page-break-after:avoid} + +} +*/ + +.fa:before, +.wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before, +.rst-content h1 .headerlink:before, +.rst-content h2 .headerlink:before, +.rst-content p.caption .headerlink:before, +.rst-content h3 .headerlink:before, +.rst-content h4 .headerlink:before, +.rst-content h5 .headerlink:before, +.rst-content h6 .headerlink:before, +.rst-content dl dt .headerlink:before, +.rst-content tt.download span:first-child:before, +.rst-content code.download span:first-child:before, +.icon:before, +.wy-dropdown .caret:before, +.wy-inline-validate.wy-inline-validate-success .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before, +.wy-alert, +.btn, +input[type="text"], +input[type="password"], +input[type="email"], +input[type="url"], +input[type="date"], +input[type="month"], +input[type="time"], +input[type="datetime"], +input[type="datetime-local"], +input[type="week"], +input[type="number"], +input[type="search"], +input[type="tel"], +input[type="color"], +select, +textarea, +.wy-menu-vertical li.on a, +.wy-menu-vertical li.current>a, +.wy-side-nav-search>a, +.wy-side-nav-search .wy-dropdown>a, +.wy-nav-top a +{ -webkit-font-smoothing:antialiased; } + +/* +.clearfix{*zoom:1} + +.clearfix:before,.clearfix:after{display:table; + content:""} + +.clearfix:after{clear:both} +*/ + +/*! + * Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */ +@font-face { + font-family: 'FontAwesome'; + src: url("../fonts/fontawesome-webfont.eot?v=4.2.0"); + src: url("../fonts/fontawesome-webfont.eot?#iefix&v=4.2.0") format("embedded-opentype"), + url("../fonts/fontawesome-webfont.woff?v=4.2.0") format("woff"), + url("../fonts/fontawesome-webfont.ttf?v=4.2.0") format("truetype"), + url("../fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular") format("svg"); + font-weight: normal; + font-style: normal; +} + +.fa, +.wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +.rst-content h1 .headerlink, +.rst-content h2 .headerlink, +.rst-content h3 .headerlink, +.rst-content h4 .headerlink, +.rst-content h5 .headerlink, +.rst-content h6 .headerlink, +.rst-content dl dt .headerlink, +.rst-content p.caption .headerlink, +.rst-content tt.download span:first-child, +.rst-content code.download span:first-child, +.icon { + display: inline-block; + font: normal normal normal 14px/1 FontAwesome; + font-size: inherit; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +/* +.fa-lg{font-size:1.33333em; + line-height:0.75em; + vertical-align:-15%} + +.fa-2x{font-size:2em} + +.fa-3x{font-size:3em} + +.fa-4x{font-size:4em} + +.fa-5x{font-size:5em} + +.fa-fw{width:1.28571em; + text-align:center} + +.fa-ul{padding-left:0; + margin-left:2.14286em; + list-style-type:none} + +.fa-ul>li{position:relative} + +.fa-li{position:absolute; + left:-2.14286em; + width:2.14286em; + top:0.14286em; + text-align:center} + +.fa-li.fa-lg{left:-1.85714em} + +.fa-border{padding:.2em .25em .15em; + border:solid 0.08em #eee; + border-radius:.1em} + +.pull-right{float:right} + +.pull-left{float:left} +*/ + +/* +.rst-content .pull-left.admonition-title, +.rst-content h1 .pull-left.headerlink, +.rst-content h2 .pull-left.headerlink, +.rst-content p.caption .pull-left.headerlink, +.rst-content h3 .pull-left.headerlink, +.rst-content h4 .pull-left.headerlink, +.rst-content h5 .pull-left.headerlink, +.rst-content h6 .pull-left.headerlink, +.rst-content dl dt .pull-left.headerlink, +.rst-content tt.download span.pull-left:first-child, +.rst-content code.download span.pull-left:first-child, +*/ +.fa.pull-left, +.wy-menu-vertical li span.pull-left.toctree-expand, +.wy-menu-vertical li.on a span.pull-left.toctree-expand, +.wy-menu-vertical li.current>a span.pull-left.toctree-expand, +.pull-left.icon +{ margin-right:.3em; } + +/* +.rst-content .pull-right.admonition-title, +.rst-content h1 .pull-right.headerlink, +.rst-content h2 .pull-right.headerlink, +.rst-content p.caption .pull-right.headerlink, +.rst-content h3 .pull-right.headerlink, +.rst-content h4 .pull-right.headerlink, +.rst-content h5 .pull-right.headerlink, +.rst-content h6 .pull-right.headerlink, +.rst-content dl dt .pull-right.headerlink, +.rst-content tt.download span.pull-right:first-child, +.rst-content code.download span.pull-right:first-child, +*/ +.fa.pull-right, +.wy-menu-vertical li span.pull-right.toctree-expand, +.wy-menu-vertical li.on a span.pull-right.toctree-expand, +.wy-menu-vertical li.current>a span.pull-right.toctree-expand, +.pull-right.icon +{ margin-left:.3em; } + +/* +.fa-spin{-webkit-animation:fa-spin 2s infinite linear; + animation:fa-spin 2s infinite linear} + +@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg); + transform:rotate(0deg)} + +100%{-webkit-transform:rotate(359deg); + transform:rotate(359deg)} + +} + +@keyframes fa-spin{0%{-webkit-transform:rotate(0deg); + transform:rotate(0deg)} + +100%{-webkit-transform:rotate(359deg); + transform:rotate(359deg)} + +} + +.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1); + -webkit-transform:rotate(90deg); + -ms-transform:rotate(90deg); + transform:rotate(90deg)} + +.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2); + -webkit-transform:rotate(180deg); + -ms-transform:rotate(180deg); + transform:rotate(180deg)} + +.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3); + -webkit-transform:rotate(270deg); + -ms-transform:rotate(270deg); + transform:rotate(270deg)} + +.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0); + -webkit-transform:scale(-1, 1); + -ms-transform:scale(-1, 1); + transform:scale(-1, 1)} + +.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2); + -webkit-transform:scale(1, -1); + -ms-transform:scale(1, -1); + transform:scale(1, -1)} + +:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none} + +.fa-stack{position:relative; + display:inline-block; + width:2em; + height:2em; + line-height:2em; + vertical-align:middle} + +.fa-stack-1x,.fa-stack-2x{position:absolute; + left:0; + width:100%; + text-align:center} + +.fa-stack-1x{line-height:inherit} + +.fa-stack-2x{font-size:2em} + +.fa-inverse{color:#fff} +*/ + +.fa-glass:before{content:""} + +.fa-music:before{content:""} + +.fa-search:before,.icon-search:before{content:""} + +.fa-envelope-o:before{content:""} + +.fa-heart:before{content:""} + +.fa-star:before{content:""} + +.fa-star-o:before{content:""} + +.fa-user:before{content:""} + +.fa-film:before{content:""} + +.fa-th-large:before{content:""} + +.fa-th:before{content:""} + +.fa-th-list:before{content:""} + +.fa-check:before{content:""} + +.fa-remove:before,.fa-close:before,.fa-times:before{content:""} + +.fa-search-plus:before{content:""} + +.fa-search-minus:before{content:""} + +.fa-power-off:before{content:""} + +.fa-signal:before{content:""} + +.fa-gear:before,.fa-cog:before{content:""} + +.fa-trash-o:before{content:""} + +.fa-home:before,.icon-home:before { content: ""; } + +.fa-file-o:before{content:""} + +.fa-clock-o:before{content:""} + +.fa-road:before{content:""} + +.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""} + +.fa-arrow-circle-o-down:before{content:""} + +.fa-arrow-circle-o-up:before{content:""} + +.fa-inbox:before{content:""} + +.fa-play-circle-o:before{content:""} + +.fa-rotate-right:before,.fa-repeat:before{content:""} + +.fa-refresh:before{content:""} + +.fa-list-alt:before{content:""} + +.fa-lock:before{content:""} + +.fa-flag:before{content:""} + +.fa-headphones:before{content:""} + +.fa-volume-off:before{content:""} + +.fa-volume-down:before{content:""} + +.fa-volume-up:before{content:""} + +.fa-qrcode:before{content:""} + +.fa-barcode:before{content:""} + +.fa-tag:before{content:""} + +.fa-tags:before{content:""} + +.fa-book:before,.icon-book:before{content:""} + +.fa-bookmark:before{content:""} + +.fa-print:before{content:""} + +.fa-camera:before{content:""} + +.fa-font:before{content:""} + +.fa-bold:before{content:""} + +.fa-italic:before{content:""} + +.fa-text-height:before{content:""} + +.fa-text-width:before{content:""} + +.fa-align-left:before{content:""} + +.fa-align-center:before{content:""} + +.fa-align-right:before{content:""} + +.fa-align-justify:before{content:""} + +.fa-list:before{content:""} + +.fa-dedent:before,.fa-outdent:before{content:""} + +.fa-indent:before{content:""} + +.fa-video-camera:before{content:""} + +.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""} + +.fa-pencil:before{content:""} + +.fa-map-marker:before{content:""} + +.fa-adjust:before{content:""} + +.fa-tint:before{content:""} + +.fa-edit:before,.fa-pencil-square-o:before{content:""} + +.fa-share-square-o:before{content:""} + +.fa-check-square-o:before{content:""} + +.fa-arrows:before{content:""} + +.fa-step-backward:before{content:""} + +.fa-fast-backward:before{content:""} + +.fa-backward:before{content:""} + +.fa-play:before{content:""} + +.fa-pause:before{content:""} + +.fa-stop:before{content:""} + +.fa-forward:before{content:""} + +.fa-fast-forward:before{content:""} + +.fa-step-forward:before{content:""} + +.fa-eject:before{content:""} + +.fa-chevron-left:before{content:""} + +.fa-chevron-right:before{content:""} + +.fa-plus-circle:before{content:""} + +.fa-minus-circle:before{content:""} + +.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""} + +.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""} + +.fa-question-circle:before{content:""} + +.fa-info-circle:before{content:""} + +.fa-crosshairs:before{content:""} + +.fa-times-circle-o:before{content:""} + +.fa-check-circle-o:before{content:""} + +.fa-ban:before{content:""} + +.fa-arrow-left:before{content:""} + +.fa-arrow-right:before{content:""} + +.fa-arrow-up:before{content:""} + +.fa-arrow-down:before{content:""} + +.fa-mail-forward:before,.fa-share:before{content:""} + +.fa-expand:before{content:""} + +.fa-compress:before{content:""} + +.fa-plus:before{content:""} + +.fa-minus:before{content:""} + +.fa-asterisk:before{content:""} + +.fa-exclamation-circle:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before +{content:""} + +.fa-gift:before{content:""} + +.fa-leaf:before{content:""} + +.fa-fire:before,.icon-fire:before{content:""} + +.fa-eye:before{content:""} + +.fa-eye-slash:before{content:""} + +.fa-warning:before,.fa-exclamation-triangle:before{content:""} + +.fa-plane:before{content:""} + +.fa-calendar:before{content:""} + +.fa-random:before{content:""} + +.fa-comment:before{content:""} + +.fa-magnet:before{content:""} + +.fa-chevron-up:before{content:""} + +.fa-chevron-down:before{content:""} + +.fa-retweet:before{content:""} + +.fa-shopping-cart:before{content:""} + +.fa-folder:before{content:""} + +.fa-folder-open:before{content:""} + +.fa-arrows-v:before{content:""} + +.fa-arrows-h:before{content:""} + +.fa-bar-chart-o:before,.fa-bar-chart:before{content:""} + +.fa-twitter-square:before{content:""} + +.fa-facebook-square:before{content:""} + +.fa-camera-retro:before{content:""} + +.fa-key:before{content:""} + +.fa-gears:before,.fa-cogs:before{content:""} + +.fa-comments:before{content:""} + +.fa-thumbs-o-up:before{content:""} + +.fa-thumbs-o-down:before{content:""} + +.fa-star-half:before{content:""} + +.fa-heart-o:before{content:""} + +.fa-sign-out:before{content:""} + +.fa-linkedin-square:before{content:""} + +.fa-thumb-tack:before{content:""} + +.fa-external-link:before{content:""} + +.fa-sign-in:before{content:""} + +.fa-trophy:before{content:""} + +.fa-github-square:before{content:""} + +.fa-upload:before{content:""} + +.fa-lemon-o:before{content:""} + +.fa-phone:before{content:""} + +.fa-square-o:before{content:""} + +.fa-bookmark-o:before{content:""} + +.fa-phone-square:before{content:""} + +.fa-twitter:before{content:""} + +.fa-facebook:before{content:""} + +.fa-github:before,.icon-github:before{content:""} + +.fa-unlock:before{content:""} + +.fa-credit-card:before{content:""} + +.fa-rss:before{content:""} + +.fa-hdd-o:before{content:""} + +.fa-bullhorn:before{content:""} + +.fa-bell:before{content:""} + +.fa-certificate:before{content:""} + +.fa-hand-o-right:before{content:""} + +.fa-hand-o-left:before{content:""} + +.fa-hand-o-up:before{content:""} + +.fa-hand-o-down:before{content:""} + +.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""} + +.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""} + +.fa-arrow-circle-up:before{content:""} + +.fa-arrow-circle-down:before{content:""} + +.fa-globe:before{content:""} + +.fa-wrench:before{content:""} + +.fa-tasks:before{content:""} + +.fa-filter:before{content:""} + +.fa-briefcase:before{content:""} + +.fa-arrows-alt:before{content:""} + +.fa-group:before,.fa-users:before{content:""} + +.fa-chain:before,.fa-link:before,.icon-link:before{content:""} + +.fa-cloud:before{content:""} + +.fa-flask:before{content:""} + +.fa-cut:before,.fa-scissors:before{content:""} + +.fa-copy:before,.fa-files-o:before{content:""} + +.fa-paperclip:before{content:""} + +.fa-save:before,.fa-floppy-o:before{content:""} + +.fa-square:before{content:""} + +.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""} + +.fa-list-ul:before{content:""} + +.fa-list-ol:before{content:""} + +.fa-strikethrough:before{content:""} + +.fa-underline:before{content:""} + +.fa-table:before{content:""} + +.fa-magic:before{content:""} + +.fa-truck:before{content:""} + +.fa-pinterest:before{content:""} + +.fa-pinterest-square:before{content:""} + +.fa-google-plus-square:before{content:""} + +.fa-google-plus:before{content:""} + +.fa-money:before{content:""} + +.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""} + +.fa-caret-up:before{content:""} + +.fa-caret-left:before{content:""} + +.fa-caret-right:before{content:""} + +.fa-columns:before{content:""} + +.fa-unsorted:before,.fa-sort:before{content:""} + +.fa-sort-down:before,.fa-sort-desc:before{content:""} + +.fa-sort-up:before,.fa-sort-asc:before{content:""} + +.fa-envelope:before{content:""} + +.fa-linkedin:before{content:""} + +.fa-rotate-left:before,.fa-undo:before{content:""} + +.fa-legal:before,.fa-gavel:before{content:""} + +.fa-dashboard:before,.fa-tachometer:before{content:""} + +.fa-comment-o:before{content:""} + +.fa-comments-o:before{content:""} + +.fa-flash:before,.fa-bolt:before{content:""} + +.fa-sitemap:before{content:""} + +.fa-umbrella:before{content:""} + +.fa-paste:before,.fa-clipboard:before{content:""} + +.fa-lightbulb-o:before{content:""} + +.fa-exchange:before{content:""} + +.fa-cloud-download:before{content:""} + +.fa-cloud-upload:before{content:""} + +.fa-user-md:before{content:""} + +.fa-stethoscope:before{content:""} + +.fa-suitcase:before{content:""} + +.fa-bell-o:before{content:""} + +.fa-coffee:before{content:""} + +.fa-cutlery:before{content:""} + +.fa-file-text-o:before{content:""} + +.fa-building-o:before{content:""} + +.fa-hospital-o:before{content:""} + +.fa-ambulance:before{content:""} + +.fa-medkit:before{content:""} + +.fa-fighter-jet:before{content:""} + +.fa-beer:before{content:""} + +.fa-h-square:before{content:""} + +.fa-plus-square:before{content:""} + +.fa-angle-double-left:before{content:""} + +.fa-angle-double-right:before{content:""} + +.fa-angle-double-up:before{content:""} + +.fa-angle-double-down:before{content:""} + +.fa-angle-left:before{content:""} + +.fa-angle-right:before{content:""} + +.fa-angle-up:before{content:""} + +.fa-angle-down:before{content:""} + +.fa-desktop:before{content:""} + +.fa-laptop:before{content:""} + +.fa-tablet:before{content:""} + +.fa-mobile-phone:before,.fa-mobile:before{content:""} + +.fa-circle-o:before{content:""} + +.fa-quote-left:before{content:""} + +.fa-quote-right:before{content:""} + +.fa-spinner:before{content:""} + +.fa-circle:before{content:""} + +.fa-mail-reply:before,.fa-reply:before{content:""} + +.fa-github-alt:before{content:""} + +.fa-folder-o:before{content:""} + +.fa-folder-open-o:before{content:""} + +.fa-smile-o:before{content:""} + +.fa-frown-o:before{content:""} + +.fa-meh-o:before{content:""} + +.fa-gamepad:before{content:""} + +.fa-keyboard-o:before{content:""} + +.fa-flag-o:before{content:""} + +.fa-flag-checkered:before{content:""} + +.fa-terminal:before{content:""} + +.fa-code:before{content:""} + +.fa-mail-reply-all:before,.fa-reply-all:before{content:""} + +.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""} + +.fa-location-arrow:before{content:""} + +.fa-crop:before{content:""} + +.fa-code-fork:before{content:""} + +.fa-unlink:before,.fa-chain-broken:before{content:""} + +.fa-question:before{content:""} + +.fa-info:before{content:""} + +.fa-exclamation:before{content:""} + +.fa-superscript:before{content:""} + +.fa-subscript:before{content:""} + +.fa-eraser:before{content:""} + +.fa-puzzle-piece:before{content:""} + +.fa-microphone:before{content:""} + +.fa-microphone-slash:before{content:""} + +.fa-shield:before{content:""} + +.fa-calendar-o:before{content:""} + +.fa-fire-extinguisher:before{content:""} + +.fa-rocket:before{content:""} + +.fa-maxcdn:before{content:""} + +.fa-chevron-circle-left:before{content:""} + +.fa-chevron-circle-right:before{content:""} + +.fa-chevron-circle-up:before{content:""} + +.fa-chevron-circle-down:before{content:""} + +.fa-html5:before{content:""} + +.fa-css3:before{content:""} + +.fa-anchor:before{content:""} + +.fa-unlock-alt:before{content:""} + +.fa-bullseye:before{content:""} + +.fa-ellipsis-h:before{content:""} + +.fa-ellipsis-v:before{content:""} + +.fa-rss-square:before{content:""} + +.fa-play-circle:before{content:""} + +.fa-ticket:before{content:""} + +.fa-minus-square:before{content:""} + +.fa-minus-square-o:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before +{ content:""; } + +.fa-level-up:before{content:""} + +.fa-level-down:before{content:""} + +.fa-check-square:before{content:""} + +.fa-pencil-square:before{content:""} + +.fa-external-link-square:before{content:""} + +.fa-share-square:before{content:""} + +.fa-compass:before{content:""} + +.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""} + +.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""} + +.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""} + +.fa-euro:before,.fa-eur:before{content:""} + +.fa-gbp:before{content:""} + +.fa-dollar:before,.fa-usd:before{content:""} + +.fa-rupee:before,.fa-inr:before{content:""} + +.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""} + +.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""} + +.fa-won:before,.fa-krw:before{content:""} + +.fa-bitcoin:before,.fa-btc:before{content:""} + +.fa-file:before{content:""} + +.fa-file-text:before{content:""} + +.fa-sort-alpha-asc:before{content:""} + +.fa-sort-alpha-desc:before{content:""} + +.fa-sort-amount-asc:before{content:""} + +.fa-sort-amount-desc:before{content:""} + +.fa-sort-numeric-asc:before{content:""} + +.fa-sort-numeric-desc:before{content:""} + +.fa-thumbs-up:before{content:""} + +.fa-thumbs-down:before{content:""} + +.fa-youtube-square:before{content:""} + +.fa-youtube:before{content:""} + +.fa-xing:before{content:""} + +.fa-xing-square:before{content:""} + +.fa-youtube-play:before{content:""} + +.fa-dropbox:before{content:""} + +.fa-stack-overflow:before{content:""} + +.fa-instagram:before{content:""} + +.fa-flickr:before{content:""} + +.fa-adn:before{content:""} + +.fa-bitbucket:before,.icon-bitbucket:before{content:""} + +.fa-bitbucket-square:before{content:""} + +.fa-tumblr:before{content:""} + +.fa-tumblr-square:before{content:""} + +.fa-long-arrow-down:before{content:""} + +.fa-long-arrow-up:before{content:""} + +.fa-long-arrow-left:before{content:""} + +.fa-long-arrow-right:before{content:""} + +.fa-apple:before{content:""} + +.fa-windows:before{content:""} + +.fa-android:before{content:""} + +.fa-linux:before{content:""} + +.fa-dribbble:before{content:""} + +.fa-skype:before{content:""} + +.fa-foursquare:before{content:""} + +.fa-trello:before{content:""} + +.fa-female:before{content:""} + +.fa-male:before{content:""} + +.fa-gittip:before{content:""} + +.fa-sun-o:before{content:""} + +.fa-moon-o:before{content:""} + +.fa-archive:before{content:""} + +.fa-bug:before{content:""} + +.fa-vk:before{content:""} + +.fa-weibo:before{content:""} + +.fa-renren:before{content:""} + +.fa-pagelines:before{content:""} + +.fa-stack-exchange:before{content:""} + +.fa-arrow-circle-o-right:before{content:""} + +.fa-arrow-circle-o-left:before{content:""} + +.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""} + +.fa-dot-circle-o:before{content:""} + +.fa-wheelchair:before{content:""} + +.fa-vimeo-square:before{content:""} + +.fa-turkish-lira:before,.fa-try:before{content:""} + +.fa-plus-square-o:before, +.wy-menu-vertical li span.toctree-expand:before +{ content:""; } + +.fa-space-shuttle:before{content:""} + +.fa-slack:before{content:""} + +.fa-envelope-square:before{content:""} + +.fa-wordpress:before{content:""} + +.fa-openid:before{content:""} + +.fa-institution:before,.fa-bank:before,.fa-university:before{content:""} + +.fa-mortar-board:before,.fa-graduation-cap:before{content:""} + +.fa-yahoo:before{content:""} + +.fa-google:before{content:""} + +.fa-reddit:before{content:""} + +.fa-reddit-square:before{content:""} + +.fa-stumbleupon-circle:before{content:""} + +.fa-stumbleupon:before{content:""} + +.fa-delicious:before{content:""} + +.fa-digg:before{content:""} + +.fa-pied-piper:before{content:""} + +.fa-pied-piper-alt:before{content:""} + +.fa-drupal:before{content:""} + +.fa-joomla:before{content:""} + +.fa-language:before{content:""} + +.fa-fax:before{content:""} + +.fa-building:before{content:""} + +.fa-child:before{content:""} + +.fa-paw:before{content:""} + +.fa-spoon:before{content:""} + +.fa-cube:before{content:""} + +.fa-cubes:before{content:""} + +.fa-behance:before{content:""} + +.fa-behance-square:before{content:""} + +.fa-steam:before{content:""} + +.fa-steam-square:before{content:""} + +.fa-recycle:before{content:""} + +.fa-automobile:before,.fa-car:before{content:""} + +.fa-cab:before,.fa-taxi:before{content:""} + +.fa-tree:before{content:""} + +.fa-spotify:before{content:""} + +.fa-deviantart:before{content:""} + +.fa-soundcloud:before{content:""} + +.fa-database:before{content:""} + +.fa-file-pdf-o:before{content:""} + +.fa-file-word-o:before{content:""} + +.fa-file-excel-o:before{content:""} + +.fa-file-powerpoint-o:before{content:""} + +.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""} + +.fa-file-zip-o:before,.fa-file-archive-o:before{content:""} + +.fa-file-sound-o:before,.fa-file-audio-o:before{content:""} + +.fa-file-movie-o:before,.fa-file-video-o:before{content:""} + +.fa-file-code-o:before{content:""} + +.fa-vine:before{content:""} + +.fa-codepen:before{content:""} + +.fa-jsfiddle:before{content:""} + +.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""} + +.fa-circle-o-notch:before{content:""} + +.fa-ra:before,.fa-rebel:before{content:""} + +.fa-ge:before,.fa-empire:before{content:""} + +.fa-git-square:before{content:""} + +.fa-git:before{content:""} + +.fa-hacker-news:before{content:""} + +.fa-tencent-weibo:before{content:""} + +.fa-qq:before{content:""} + +.fa-wechat:before,.fa-weixin:before{content:""} + +.fa-send:before,.fa-paper-plane:before{content:""} + +.fa-send-o:before,.fa-paper-plane-o:before{content:""} + +.fa-history:before{content:""} + +.fa-circle-thin:before{content:""} + +.fa-header:before{content:""} + +.fa-paragraph:before{content:""} + +.fa-sliders:before{content:""} + +.fa-share-alt:before{content:""} + +.fa-share-alt-square:before{content:""} + +.fa-bomb:before{content:""} + +.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""} + +.fa-tty:before{content:""} + +.fa-binoculars:before{content:""} + +.fa-plug:before{content:""} + +.fa-slideshare:before{content:""} + +.fa-twitch:before{content:""} + +.fa-yelp:before{content:""} + +.fa-newspaper-o:before{content:""} + +.fa-wifi:before{content:""} + +.fa-calculator:before{content:""} + +.fa-paypal:before{content:""} + +.fa-google-wallet:before{content:""} + +.fa-cc-visa:before{content:""} + +.fa-cc-mastercard:before{content:""} + +.fa-cc-discover:before{content:""} + +.fa-cc-amex:before{content:""} + +.fa-cc-paypal:before{content:""} + +.fa-cc-stripe:before{content:""} + +.fa-bell-slash:before{content:""} + +.fa-bell-slash-o:before{content:""} + +.fa-trash:before{content:""} + +.fa-copyright:before{content:""} + +.fa-at:before{content:""} + +.fa-eyedropper:before{content:""} + +.fa-paint-brush:before{content:""} + +.fa-birthday-cake:before{content:""} + +.fa-area-chart:before{content:""} + +.fa-pie-chart:before{content:""} + +.fa-line-chart:before{content:""} + +.fa-lastfm:before{content:""} + +.fa-lastfm-square:before{content:""} + +.fa-toggle-off:before{content:""} + +.fa-toggle-on:before{content:""} + +.fa-bicycle:before{content:""} + +.fa-bus:before{content:""} + +.fa-ioxhost:before{content:""} + +.fa-angellist:before{content:""} + +.fa-cc:before{content:""} + +.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""} + +.fa-meanpath:before{content:""} + +/* +.rst-content h1 .headerlink, +.rst-content h2 .headerlink, +.rst-content p.caption .headerlink, +.rst-content h3 .headerlink, +.rst-content h4 .headerlink, +.rst-content h5 .headerlink, +.rst-content h6 .headerlink, +.rst-content dl dt .headerlink, +.rst-content tt.download span:first-child, +.rst-content code.download span:first-child, +*/ +.fa, +.wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +.icon, +.wy-dropdown .caret, +.wy-inline-validate.wy-inline-validate-success .wy-input-context, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context, +.wy-inline-validate.wy-inline-validate-info .wy-input-context +{ font-family: inherit; } + +/* +.rst-content h1 .headerlink:before, +.rst-content h2 .headerlink:before, +.rst-content p.caption .headerlink:before, +.rst-content h3 .headerlink:before, +.rst-content h4 .headerlink:before, +.rst-content h5 .headerlink:before, +.rst-content h6 .headerlink:before, +.rst-content dl dt .headerlink:before, +.rst-content tt.download span:first-child:before, +.rst-content code.download span:first-child:before, +*/ +.fa:before, +.wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before, +.icon:before, +.wy-dropdown .caret:before, +.wy-inline-validate.wy-inline-validate-success .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before +{ + font-family: "FontAwesome"; + display: inline-block; + font-style: normal; + font-weight: normal; + line-height: 1; + text-decoration: inherit +} + +/* +a .rst-content h1 .headerlink, +.rst-content h1 a .headerlink, +a .rst-content h2 .headerlink, +.rst-content h2 a .headerlink, +a .rst-content p.caption .headerlink, +.rst-content p.caption a .headerlink, +a .rst-content h3 .headerlink, +.rst-content h3 a .headerlink, +a .rst-content h4 .headerlink, +.rst-content h4 a .headerlink, +a .rst-content h5 .headerlink, +.rst-content h5 a .headerlink, +a .rst-content h6 .headerlink, +.rst-content h6 a .headerlink, +a .rst-content dl dt .headerlink, +.rst-content dl dt a .headerlink, +a .rst-content tt.download span:first-child, +.rst-content tt.download a span:first-child, +a .rst-content code.download span:first-child, +.rst-content code.download a span:first-child, +*/ +a .fa, +a .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li a span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +a .icon +{ + display: inline-block; + text-decoration: inherit; +} + +.btn .fa, +.btn .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .btn span.toctree-expand, +.btn .wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.on a .btn span.toctree-expand, +.btn .wy-menu-vertical li.current>a span.toctree-expand, +.wy-menu-vertical li.current>a .btn span.toctree-expand, +.btn .rst-content .admonition-title, +.rst-content .btn .admonition-title, +.btn .rst-content h1 .headerlink, +.rst-content h1 .btn .headerlink, +.btn .rst-content h2 .headerlink, +.rst-content h2 .btn .headerlink, +.btn .rst-content p.caption .headerlink, +.rst-content p.caption .btn .headerlink, +.btn .rst-content h3 .headerlink, +.rst-content h3 .btn .headerlink, +.btn .rst-content h4 .headerlink, +.rst-content h4 .btn .headerlink, +.btn .rst-content h5 .headerlink, +.rst-content h5 .btn .headerlink, +.btn .rst-content h6 .headerlink, +.rst-content h6 .btn .headerlink, +.btn .rst-content dl dt .headerlink, +.rst-content dl dt .btn .headerlink, +.btn .rst-content tt.download span:first-child, +.rst-content tt.download .btn span:first-child, +.btn .rst-content code.download span:first-child, +.rst-content code.download .btn span:first-child, +.btn .icon, +.nav .fa, +.nav .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .nav span.toctree-expand, +.nav .wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.on a .nav span.toctree-expand, +.nav .wy-menu-vertical li.current>a span.toctree-expand, +.wy-menu-vertical li.current>a .nav span.toctree-expand, +.nav .rst-content .admonition-title, +.rst-content .nav .admonition-title, +.nav .rst-content h1 .headerlink, +.rst-content h1 .nav .headerlink, +.nav .rst-content h2 .headerlink, +.rst-content h2 .nav .headerlink, +.nav .rst-content p.caption .headerlink, +.rst-content p.caption .nav .headerlink, +.nav .rst-content h3 .headerlink, +.rst-content h3 .nav .headerlink, +.nav .rst-content h4 .headerlink, +.rst-content h4 .nav .headerlink, +.nav .rst-content h5 .headerlink, +.rst-content h5 .nav .headerlink, +.nav .rst-content h6 .headerlink, +.rst-content h6 .nav .headerlink, +.nav .rst-content dl dt .headerlink, +.rst-content dl dt .nav .headerlink, +.nav .rst-content tt.download span:first-child, +.rst-content tt.download .nav span:first-child, +.nav .rst-content code.download span:first-child, +.rst-content code.download .nav span:first-child, +.nav .icon +{ display: inline; } + +.btn .fa.fa-large, +.btn .wy-menu-vertical li span.fa-large.toctree-expand, +.wy-menu-vertical li .btn span.fa-large.toctree-expand, +.btn .rst-content .fa-large.admonition-title, +.rst-content .btn .fa-large.admonition-title, +.btn .rst-content h1 .fa-large.headerlink, +.rst-content h1 .btn .fa-large.headerlink, +.btn .rst-content h2 .fa-large.headerlink, +.rst-content h2 .btn .fa-large.headerlink, +.btn .rst-content p.caption .fa-large.headerlink, +.rst-content p.caption .btn .fa-large.headerlink, +.btn .rst-content h3 .fa-large.headerlink, +.rst-content h3 .btn .fa-large.headerlink, +.btn .rst-content h4 .fa-large.headerlink, +.rst-content h4 .btn .fa-large.headerlink, +.btn .rst-content h5 .fa-large.headerlink, +.rst-content h5 .btn .fa-large.headerlink, +.btn .rst-content h6 .fa-large.headerlink, +.rst-content h6 .btn .fa-large.headerlink, +.btn .rst-content dl dt .fa-large.headerlink, +.rst-content dl dt .btn .fa-large.headerlink, +.btn .rst-content tt.download span.fa-large:first-child, +.rst-content tt.download .btn span.fa-large:first-child, +.btn .rst-content code.download span.fa-large:first-child, +.rst-content code.download .btn span.fa-large:first-child, +.btn .fa-large.icon, +.nav .fa.fa-large, +.nav .wy-menu-vertical li span.fa-large.toctree-expand, +.wy-menu-vertical li .nav span.fa-large.toctree-expand, +.nav .rst-content .fa-large.admonition-title, +.rst-content .nav .fa-large.admonition-title, +.nav .rst-content h1 .fa-large.headerlink, +.rst-content h1 .nav .fa-large.headerlink, +.nav .rst-content h2 .fa-large.headerlink, +.rst-content h2 .nav .fa-large.headerlink, +.nav .rst-content p.caption .fa-large.headerlink, +.rst-content p.caption .nav .fa-large.headerlink, +.nav .rst-content h3 .fa-large.headerlink, +.rst-content h3 .nav .fa-large.headerlink, +.nav .rst-content h4 .fa-large.headerlink, +.rst-content h4 .nav .fa-large.headerlink, +.nav .rst-content h5 .fa-large.headerlink, +.rst-content h5 .nav .fa-large.headerlink, +.nav .rst-content h6 .fa-large.headerlink, +.rst-content h6 .nav .fa-large.headerlink, +.nav .rst-content dl dt .fa-large.headerlink, +.rst-content dl dt .nav .fa-large.headerlink, +.nav .rst-content tt.download span.fa-large:first-child, +.rst-content tt.download .nav span.fa-large:first-child, +.nav .rst-content code.download span.fa-large:first-child, +.rst-content code.download .nav span.fa-large:first-child, +.nav .fa-large.icon +{ line-height: 0.9em; } + +.btn .fa.fa-spin, +.btn .wy-menu-vertical li span.fa-spin.toctree-expand, +.wy-menu-vertical li .btn span.fa-spin.toctree-expand, +.btn .rst-content .fa-spin.admonition-title, +.rst-content .btn .fa-spin.admonition-title, +.btn .rst-content h1 .fa-spin.headerlink, +.rst-content h1 .btn .fa-spin.headerlink, +.btn .rst-content h2 .fa-spin.headerlink, +.rst-content h2 .btn .fa-spin.headerlink, +.btn .rst-content p.caption .fa-spin.headerlink, +.rst-content p.caption .btn .fa-spin.headerlink, +.btn .rst-content h3 .fa-spin.headerlink, +.rst-content h3 .btn .fa-spin.headerlink, +.btn .rst-content h4 .fa-spin.headerlink, +.rst-content h4 .btn .fa-spin.headerlink, +.btn .rst-content h5 .fa-spin.headerlink, +.rst-content h5 .btn .fa-spin.headerlink, +.btn .rst-content h6 .fa-spin.headerlink, +.rst-content h6 .btn .fa-spin.headerlink, +.btn .rst-content dl dt .fa-spin.headerlink, +.rst-content dl dt .btn .fa-spin.headerlink, +.btn .rst-content tt.download span.fa-spin:first-child, +.rst-content tt.download .btn span.fa-spin:first-child, +.btn .rst-content code.download span.fa-spin:first-child, +.rst-content code.download .btn span.fa-spin:first-child, +.btn .fa-spin.icon, +.nav .fa.fa-spin, +.nav .wy-menu-vertical li span.fa-spin.toctree-expand, +.wy-menu-vertical li .nav span.fa-spin.toctree-expand, +.nav .rst-content .fa-spin.admonition-title, +.rst-content .nav .fa-spin.admonition-title, +.nav .rst-content h1 .fa-spin.headerlink, +.rst-content h1 .nav .fa-spin.headerlink, +.nav .rst-content h2 .fa-spin.headerlink, +.rst-content h2 .nav .fa-spin.headerlink, +.nav .rst-content p.caption .fa-spin.headerlink, +.rst-content p.caption .nav .fa-spin.headerlink, +.nav .rst-content h3 .fa-spin.headerlink, +.rst-content h3 .nav .fa-spin.headerlink, +.nav .rst-content h4 .fa-spin.headerlink, +.rst-content h4 .nav .fa-spin.headerlink, +.nav .rst-content h5 .fa-spin.headerlink, +.rst-content h5 .nav .fa-spin.headerlink, +.nav .rst-content h6 .fa-spin.headerlink, +.rst-content h6 .nav .fa-spin.headerlink, +.nav .rst-content dl dt .fa-spin.headerlink, +.rst-content dl dt .nav .fa-spin.headerlink, +.nav .rst-content tt.download span.fa-spin:first-child, +.rst-content tt.download .nav span.fa-spin:first-child, +.nav .rst-content code.download span.fa-spin:first-child, +.rst-content code.download .nav span.fa-spin:first-child, +.nav .fa-spin.icon +{ display: inline-block; } + +.btn.fa:before, +.wy-menu-vertical li span.btn.toctree-expand:before, +.rst-content .btn.admonition-title:before, +.rst-content h1 .btn.headerlink:before, +.rst-content h2 .btn.headerlink:before, +.rst-content p.caption .btn.headerlink:before, +.rst-content h3 .btn.headerlink:before, +.rst-content h4 .btn.headerlink:before, +.rst-content h5 .btn.headerlink:before, +.rst-content h6 .btn.headerlink:before, +.rst-content dl dt .btn.headerlink:before, +.rst-content tt.download span.btn:first-child:before, +.rst-content code.download span.btn:first-child:before, +.btn.icon:before +{ + opacity: 0.5; + -webkit-transition: opacity 0.05s ease-in; + -moz-transition: opacity 0.05s ease-in; + transition: opacity 0.05s ease-in; +} + +.btn.fa:hover:before, +.wy-menu-vertical li span.btn.toctree-expand:hover:before, +.rst-content .btn.admonition-title:hover:before, +.rst-content h1 .btn.headerlink:hover:before, +.rst-content h2 .btn.headerlink:hover:before, +.rst-content p.caption .btn.headerlink:hover:before, +.rst-content h3 .btn.headerlink:hover:before, +.rst-content h4 .btn.headerlink:hover:before, +.rst-content h5 .btn.headerlink:hover:before, +.rst-content h6 .btn.headerlink:hover:before, +.rst-content dl dt .btn.headerlink:hover:before, +.rst-content tt.download span.btn:first-child:hover:before, +.rst-content code.download span.btn:first-child:hover:before, +.btn.icon:hover:before +{ opacity: 1; } + +.btn-mini .fa:before, +.btn-mini .wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li .btn-mini span.toctree-expand:before, +.btn-mini .rst-content .admonition-title:before, +.rst-content .btn-mini .admonition-title:before, +.btn-mini .rst-content h1 .headerlink:before, +.rst-content h1 .btn-mini .headerlink:before, +.btn-mini .rst-content h2 .headerlink:before, +.rst-content h2 .btn-mini .headerlink:before, +.btn-mini .rst-content p.caption .headerlink:before, +.rst-content p.caption .btn-mini .headerlink:before, +.btn-mini .rst-content h3 .headerlink:before, +.rst-content h3 .btn-mini .headerlink:before, +.btn-mini .rst-content h4 .headerlink:before, +.rst-content h4 .btn-mini .headerlink:before, +.btn-mini .rst-content h5 .headerlink:before, +.rst-content h5 .btn-mini .headerlink:before, +.btn-mini .rst-content h6 .headerlink:before, +.rst-content h6 .btn-mini .headerlink:before, +.btn-mini .rst-content dl dt .headerlink:before, +.rst-content dl dt .btn-mini .headerlink:before, +.btn-mini .rst-content tt.download span:first-child:before, +.rst-content tt.download .btn-mini span:first-child:before, +.btn-mini .rst-content code.download span:first-child:before, +.rst-content code.download .btn-mini span:first-child:before, +.btn-mini .icon:before +{ + font-size: 14px; + vertical-align: -15%; +} + +/* +.wy-alert{padding:12px; + line-height:24px; + margin-bottom:24px; + background:#e7f2fa} + +.wy-alert-title{color:#fff; + font-weight:bold; + display:block; + color:#fff; + background:#6ab0de; + margin:-12px; + padding:6px 12px; + margin-bottom:12px} + +.wy-alert.wy-alert-danger, +.rst-content .wy-alert-danger.note, +.rst-content .wy-alert-danger.attention, +.rst-content .wy-alert-danger.caution, +.rst-content .wy-alert-danger.hint, +.rst-content .wy-alert-danger.important, +.rst-content .wy-alert-danger.tip, +.rst-content .wy-alert-danger.warning, +.rst-content .wy-alert-danger.seealso, +.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2} + +.wy-alert.wy-alert-danger .wy-alert-title, +.rst-content .wy-alert-danger.note .wy-alert-title, +.rst-content .wy-alert-danger.attention .wy-alert-title, +.rst-content .wy-alert-danger.caution .wy-alert-title, +.rst-content .danger .wy-alert-title, +.rst-content .error .wy-alert-title, +.rst-content .wy-alert-danger.hint .wy-alert-title, +.rst-content .wy-alert-danger.important .wy-alert-title, +.rst-content .wy-alert-danger.tip .wy-alert-title, +.rst-content .wy-alert-danger.warning .wy-alert-title, +.rst-content .wy-alert-danger.seealso .wy-alert-title, +.rst-content .wy-alert-danger.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-danger .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-danger .admonition-title, +.rst-content .wy-alert-danger.note .admonition-title, +.rst-content .wy-alert-danger.attention .admonition-title, +.rst-content .wy-alert-danger.caution .admonition-title, +.rst-content .wy-alert-danger.hint .admonition-title, +.rst-content .wy-alert-danger.important .admonition-title, +.rst-content .wy-alert-danger.tip .admonition-title, +.rst-content .wy-alert-danger.warning .admonition-title, +.rst-content .wy-alert-danger.seealso .admonition-title, +.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97} + +.wy-alert.wy-alert-warning, +.rst-content .wy-alert-warning.note, +.rst-content .wy-alert-warning.danger, +.rst-content .wy-alert-warning.error, +.rst-content .wy-alert-warning.hint, +.rst-content .wy-alert-warning.important, +.rst-content .wy-alert-warning.tip, +.rst-content .wy-alert-warning.seealso +{background:#ffedcc} + +.wy-alert.wy-alert-warning .wy-alert-title, +.rst-content .wy-alert-warning.note .wy-alert-title, +.rst-content .attention .wy-alert-title, +.rst-content .caution .wy-alert-title, +.rst-content .wy-alert-warning.danger .wy-alert-title, +.rst-content .wy-alert-warning.error .wy-alert-title, +.rst-content .wy-alert-warning.hint .wy-alert-title, +.rst-content .wy-alert-warning.important .wy-alert-title, +.rst-content .wy-alert-warning.tip .wy-alert-title, +.rst-content .warning .wy-alert-title, +.rst-content .wy-alert-warning.seealso .wy-alert-title, +.rst-content .admonition-todo .wy-alert-title, +.wy-alert.wy-alert-warning .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-warning .admonition-title, +.rst-content .wy-alert-warning.note .admonition-title, +.rst-content .wy-alert-warning.danger .admonition-title, +.rst-content .wy-alert-warning.error .admonition-title, +.rst-content .wy-alert-warning.hint .admonition-title, +.rst-content .wy-alert-warning.important .admonition-title, +.rst-content .wy-alert-warning.tip .admonition-title, +.rst-content .wy-alert-warning.seealso .admonition-title +{background:#f0b37e} + +.wy-alert.wy-alert-info, +.rst-content .wy-alert-info.attention, +.rst-content .wy-alert-info.caution, +.rst-content .wy-alert-info.danger, +.rst-content .wy-alert-info.error, +.rst-content .wy-alert-info.hint, +.rst-content .wy-alert-info.important, +.rst-content .wy-alert-info.tip, +.rst-content .wy-alert-info.warning, +.rst-content .wy-alert-info.admonition-todo{background:#e7f2fa} + +.wy-alert.wy-alert-info .wy-alert-title, +.rst-content .note .wy-alert-title, +.rst-content .wy-alert-info.attention .wy-alert-title, +.rst-content .wy-alert-info.caution .wy-alert-title, +.rst-content .wy-alert-info.danger .wy-alert-title, +.rst-content .wy-alert-info.error .wy-alert-title, +.rst-content .wy-alert-info.hint .wy-alert-title, +.rst-content .wy-alert-info.important .wy-alert-title, +.rst-content .wy-alert-info.tip .wy-alert-title, +.rst-content .wy-alert-info.warning .wy-alert-title, +.rst-content .seealso .wy-alert-title, +.rst-content .wy-alert-info.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-info .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-info .admonition-title, +.rst-content .wy-alert-info.attention .admonition-title, +.rst-content .wy-alert-info.caution .admonition-title, +.rst-content .wy-alert-info.danger .admonition-title, +.rst-content .wy-alert-info.error .admonition-title, +.rst-content .wy-alert-info.hint .admonition-title, +.rst-content .wy-alert-info.important .admonition-title, +.rst-content .wy-alert-info.tip .admonition-title, +.rst-content .wy-alert-info.warning .admonition-title, +.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#6ab0de} + +.wy-alert.wy-alert-success, +.rst-content .wy-alert-success.note, +.rst-content .wy-alert-success.attention, +.rst-content .wy-alert-success.caution, +.rst-content .wy-alert-success.danger, +.rst-content .wy-alert-success.error, +.rst-content .wy-alert-success.warning, +.rst-content .wy-alert-success.seealso, +.rst-content .wy-alert-success.admonition-todo{background:#dbfaf4} + +.wy-alert.wy-alert-success .wy-alert-title, +.rst-content .wy-alert-success.note .wy-alert-title, +.rst-content .wy-alert-success.attention .wy-alert-title, +.rst-content .wy-alert-success.caution .wy-alert-title, +.rst-content .wy-alert-success.danger .wy-alert-title, +.rst-content .wy-alert-success.error .wy-alert-title, +.rst-content .hint .wy-alert-title, +.rst-content .important .wy-alert-title, +.rst-content .tip .wy-alert-title, +.rst-content .wy-alert-success.warning .wy-alert-title, +.rst-content .wy-alert-success.seealso .wy-alert-title, +.rst-content .wy-alert-success.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-success .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-success .admonition-title, +.rst-content .wy-alert-success.note .admonition-title, +.rst-content .wy-alert-success.attention .admonition-title, +.rst-content .wy-alert-success.caution .admonition-title, +.rst-content .wy-alert-success.danger .admonition-title, +.rst-content .wy-alert-success.error .admonition-title, +.rst-content .wy-alert-success.warning .admonition-title, +.rst-content .wy-alert-success.seealso .admonition-title, +.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#1abc9c} + +.wy-alert.wy-alert-neutral, +.rst-content .wy-alert-neutral.note, +.rst-content .wy-alert-neutral.attention, +.rst-content .wy-alert-neutral.caution, +.rst-content .wy-alert-neutral.danger, +.rst-content .wy-alert-neutral.error, +.rst-content .wy-alert-neutral.hint, +.rst-content .wy-alert-neutral.important, +.rst-content .wy-alert-neutral.tip, +.rst-content .wy-alert-neutral.warning, +.rst-content .wy-alert-neutral.seealso, +.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6} + +.wy-alert.wy-alert-neutral .wy-alert-title, +.rst-content .wy-alert-neutral.note .wy-alert-title, +.rst-content .wy-alert-neutral.attention .wy-alert-title, +.rst-content .wy-alert-neutral.caution .wy-alert-title, +.rst-content .wy-alert-neutral.danger .wy-alert-title, +.rst-content .wy-alert-neutral.error .wy-alert-title, +.rst-content .wy-alert-neutral.hint .wy-alert-title, +.rst-content .wy-alert-neutral.important .wy-alert-title, +.rst-content .wy-alert-neutral.tip .wy-alert-title, +.rst-content .wy-alert-neutral.warning .wy-alert-title, +.rst-content .wy-alert-neutral.seealso .wy-alert-title, +.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-neutral .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-neutral .admonition-title, +.rst-content .wy-alert-neutral.note .admonition-title, +.rst-content .wy-alert-neutral.attention .admonition-title, +.rst-content .wy-alert-neutral.caution .admonition-title, +.rst-content .wy-alert-neutral.danger .admonition-title, +.rst-content .wy-alert-neutral.error .admonition-title, +.rst-content .wy-alert-neutral.hint .admonition-title, +.rst-content .wy-alert-neutral.important .admonition-title, +.rst-content .wy-alert-neutral.tip .admonition-title, +.rst-content .wy-alert-neutral.warning .admonition-title, +.rst-content .wy-alert-neutral.seealso .admonition-title, +.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040; + background:#e1e4e5} + +.wy-alert.wy-alert-neutral a, +.rst-content .wy-alert-neutral.note a, +.rst-content .wy-alert-neutral.attention a, +.rst-content .wy-alert-neutral.caution a, +.rst-content .wy-alert-neutral.danger a, +.rst-content .wy-alert-neutral.error a, +.rst-content .wy-alert-neutral.hint a, +.rst-content .wy-alert-neutral.important a, +.rst-content .wy-alert-neutral.tip a, +.rst-content .wy-alert-neutral.warning a, +.rst-content .wy-alert-neutral.seealso a, +.rst-content .wy-alert-neutral.admonition-todo a{color:#2980B9} + +.wy-alert p:last-child{margin-bottom:0} + +.wy-tray-container{position:fixed; + bottom:0px; + left:0; + z-index:600} + +.wy-tray-container li{display:block; + width:300px; + background:transparent; + color:#fff; + text-align:center; + box-shadow:0 5px 5px 0 rgba(0,0,0,0.1); + padding:0 24px; + min-width:20%; + opacity:0; + height:0; + line-height:56px; + overflow:hidden; + -webkit-transition:all 0.3s ease-in; + -moz-transition:all 0.3s ease-in; + transition:all 0.3s ease-in} + +.wy-tray-container li.wy-tray-item-success{background:#27AE60} + +.wy-tray-container li.wy-tray-item-info{background:#2980B9} + +.wy-tray-container li.wy-tray-item-warning{background:#E67E22} + +.wy-tray-container li.wy-tray-item-danger{background:#E74C3C} + +.wy-tray-container li.on{opacity:1; + height:56px} + +@media screen and (max-width: 768px){.wy-tray-container{bottom:auto; + top:0; + width:100%} + +.wy-tray-container li{width:100%} + +} + +button{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle; + cursor:pointer; + line-height:normal; + -webkit-appearance:button; + *overflow:visible} + +button::-moz-focus-inner,input::-moz-focus-inner{border:0; + padding:0} + +button[disabled]{cursor:default} +*/ + +a.btn, a.btn:link { + display: inline-block; + text-align: center; + cursor: pointer; + font-size: 110%; + font-weight: bold; + padding: 4pt; + margin-top: 10pt; + border: 2px solid black; + border-bottom: 2px solid black; +} + +a.btn:hover { + color: white; + background: black; +} + +/* +.btn { + display: inline-block; + border-radius: 2px; + line-height: normal; + white-space: nowrap; + text-align: center; + cursor: pointer; + font-size: 100%; + padding: 6px 12px 8px 12px; + color: #fff; + border: 1px solid rgba(0,0,0,0.1); + background-color: #27AE60; + text-decoration: none; + font-weight: normal; + font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + box-shadow: 0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset; + outline-none: false; + vertical-align: middle; + *display: inline; + zoom: 1; + -webkit-user-drag: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + -webkit-transition: all 0.1s linear; + -moz-transition: all 0.1s linear; + transition: all 0.1s linear; +} + +.btn-hover { background: #2e8ece; color: #fff; } +.btn:hover { background: #2cc36b; color: #fff; } +.btn:focus { background: #2cc36b; outline: 0; } + +.btn:active { + box-shadow: 0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset; + padding: 8px 12px 6px 12px; +} + +.btn:visited { color: #fff; } + +.btn:disabled { + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn-disabled { + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn-disabled:hover, +.btn-disabled:focus, +.btn-disabled:active +{ + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn::-moz-focus-inner { + padding: 0; + border: 0; +} + +.btn-small { font-size: 80%; } +.btn-info { background-color: #2980B9 !important; } +.btn-info:hover { background-color: #2e8ece !important; } +.btn-neutral { background-color: #f3f6f6 !important; color:#404040 !important; } +.btn-neutral:hover { background-color: #e5ebeb !important; color:#404040; } +.btn-neutral:visited { color: #404040 !important; } +.btn-success { background-color: #27AE60 !important; } +.btn-success:hover { background-color: #295 !important; } +.btn-danger { background-color: #E74C3C !important; } +.btn-danger:hover { background-color: #ea6153 !important; } +.btn-warning { background-color: #E67E22 !important; } +.btn-warning:hover { background-color: #e98b39 !important; } +.btn-invert { background-color: #222} +.btn-invert:hover { background-color: #2f2f2f !important; } + +.btn-link { + background-color: transparent !important; + color: #2980B9; + box-shadow: none; + border-color: transparent !important; +} + +.btn-link:hover { + background-color: transparent !important; + color: #409ad5 !important; + box-shadow: none; +} + +.btn-link:active { + background-color: transparent !important; + color: #409ad5 !important; + box-shadow: none; +} + +.btn-link:visited { color:#9B59B6; } + +.wy-btn-group .btn, +.wy-control .btn +{ vertical-align: middle; } + +.wy-btn-group { margin-bottom: 24px; *zoom:1; } + +.wy-btn-group:before, +.wy-btn-group:after +{ display:table; content: ""; } + +.wy-btn-group:after { clear: both; } + +.wy-dropdown{position:relative; + display:inline-block} + +.wy-dropdown-active .wy-dropdown-menu{display:block} + +.wy-dropdown-menu{position:absolute; + left:0; + display:none; + float:left; + top:100%; + min-width:100%; + background:#fcfcfc; + z-index:100; + border:solid 1px #cfd7dd; + box-shadow:0 2px 2px 0 rgba(0,0,0,0.1); + padding:12px} + +.wy-dropdown-menu>dd>a{display:block; + clear:both; + color:#404040; + white-space:nowrap; + font-size:90%; + padding:0 12px; + cursor:pointer} + +.wy-dropdown-menu>dd>a:hover{background:#2980B9; + color:#fff} + +.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd; + margin:6px 0} + +.wy-dropdown-menu>dd.search{padding-bottom:12px} + +.wy-dropdown-menu>dd.search input[type="search"]{width:100%} + +.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3; + text-transform:uppercase; + font-weight:500; + font-size:80%} + +.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3} + +.wy-dropdown-menu>dd.call-to-action .btn{color:#fff} + +.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%; + top:auto; + left:auto; + right:0} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc; + margin-top:2px} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9; + color:#fff} + +.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0; + left:auto; + text-align:right} + +.wy-dropdown-arrow:before{content:" "; + border-bottom:5px solid #f5f5f5; + border-left:5px solid transparent; + border-right:5px solid transparent; + position:absolute; + display:block; + top:-4px; + left:50%; + margin-left:-3px} + +.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px} + +.wy-form-stacked select{display:block} + +.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block; + *display:inline; + *zoom:1; + vertical-align:middle} + +.wy-form-aligned .wy-control-group>label{display:inline-block; + vertical-align:middle; + width:10em; + margin:6px 12px 0 0; + float:left} + +.wy-form-aligned .wy-control{float:left} + +.wy-form-aligned .wy-control label{display:block} + +.wy-form-aligned .wy-control select{margin-top:6px} + +fieldset{border:0; + margin:0; + padding:0} + +legend{display:block; + width:100%; + border:0; + padding:0; + white-space:normal; + margin-bottom:24px; + font-size:150%; + *margin-left:-7px} + +label{display:block; + margin:0 0 0.3125em 0; + color:#333; + font-size:90%} + +input,select,textarea{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle} + +.wy-control-group{margin-bottom:24px; + *zoom:1; + max-width:68em; + margin-left:auto; + margin-right:auto; + *zoom:1} + +.wy-control-group:before,.wy-control-group:after{display:table; + content:""} + +.wy-control-group:after{clear:both} + +.wy-control-group:before,.wy-control-group:after{display:table; + content:""} + +.wy-control-group:after{clear:both} + +.wy-control-group.wy-control-group-required>label:after{content:" *"; + color:#E74C3C} + +.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px} + +.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%} + +.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%} + +.wy-control-group .wy-form-full{float:left; + display:block; + margin-right:2.35765%; + width:100%; + margin-right:0} + +.wy-control-group .wy-form-full:last-child{margin-right:0} + +.wy-control-group .wy-form-halves{float:left; + display:block; + margin-right:2.35765%; + width:48.82117%} + +.wy-control-group .wy-form-halves:last-child{margin-right:0} + +.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0} + +.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left} + +.wy-control-group .wy-form-thirds{float:left; + display:block; + margin-right:2.35765%; + width:31.76157%} + +.wy-control-group .wy-form-thirds:last-child{margin-right:0} + +.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0} + +.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left} + +.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0; + font-size:90%} + +.wy-control-no-input{display:inline-block; + margin:6px 0 0 0; + font-size:90%} + +.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%} + +.wy-form-message-inline{display:inline-block; + padding-left:0.3em; + color:#666; + vertical-align:middle; + font-size:90%} + +.wy-form-message{display:block; + color:#999; + font-size:70%; + margin-top:0.3125em; + font-style:italic} + +.wy-form-message p{font-size:inherit; + font-style:italic; + margin-bottom:6px} + +.wy-form-message p:last-child{margin-bottom:0} + +input{line-height:normal} + +input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button; + cursor:pointer; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + *overflow:visible} + +input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none; + padding:6px; + display:inline-block; + border:1px solid #ccc; + font-size:80%; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + box-shadow:inset 0 1px 3px #ddd; + border-radius:0; + -webkit-transition:border 0.3s linear; + -moz-transition:border 0.3s linear; + transition:border 0.3s linear} + +input[type="datetime-local"]{padding:0.34375em 0.625em} + +input[disabled]{cursor:default} + +input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box; + padding:0; + margin-right:0.3125em; + *height:13px; + *width:13px} +*/ + +input[type="search"] { + -webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box +} + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none +} + +input[type="text"]:focus, +input[type="password"]:focus, +input[type="email"]:focus, +input[type="url"]:focus, +input[type="date"]:focus, +input[type="month"]:focus, +input[type="time"]:focus, +input[type="datetime"]:focus, +input[type="datetime-local"]:focus, +input[type="week"]:focus, +input[type="number"]:focus, +input[type="search"]:focus, +input[type="tel"]:focus, +input[type="color"]:focus$ +{ + outline: 0; + outline: thin dotted \9; + border-color: #333 +} + +/* +input.no-focus:focus{border-color:#ccc !important} + +input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333; + outline:1px auto #129FEA} + +input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed; + background-color:#fafafa} + +input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C; + border:1px solid #E74C3C} + +input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C} + +input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C} + +input.wy-input-large{padding:12px; + font-size:100%} + +textarea{overflow:auto; + vertical-align:top; + width:100%; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif} + +select,textarea{padding:0.5em 0.625em; + display:inline-block; + border:1px solid #ccc; + font-size:80%; + box-shadow:inset 0 1px 3px #ddd; + -webkit-transition:border 0.3s linear; + -moz-transition:border 0.3s linear; + transition:border 0.3s linear} + +select{border:1px solid #ccc; + background-color:#fff} + +select[multiple]{height:auto} + +select:focus,textarea:focus{outline:0} + +select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed; + background-color:#fafafa} + +input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed} + +.wy-checkbox,.wy-radio{margin:6px 0; + color:#404040; + display:block} + +.wy-checkbox input,.wy-radio input{vertical-align:baseline} + +.wy-form-message-inline{display:inline-block; + *display:inline; + *zoom:1; + vertical-align:middle} + +.wy-input-prefix,.wy-input-suffix{white-space:nowrap; + padding:6px} + +.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px; + padding:0 8px; + display:inline-block; + font-size:80%; + background-color:#f3f6f6; + border:solid 1px #ccc; + color:#999} + +.wy-input-suffix .wy-input-context{border-left:0} + +.wy-input-prefix .wy-input-context{border-right:0} + +.wy-switch{width:36px; + height:12px; + margin:12px 0; + position:relative; + border-radius:4px; + background:#ccc; + cursor:pointer; + -webkit-transition:all 0.2s ease-in-out; + -moz-transition:all 0.2s ease-in-out; + transition:all 0.2s ease-in-out} + +.wy-switch:before{position:absolute; + content:""; + display:block; + width:18px; + height:18px; + border-radius:4px; + background:#999; + left:-3px; + top:-3px; + -webkit-transition:all 0.2s ease-in-out; + -moz-transition:all 0.2s ease-in-out; + transition:all 0.2s ease-in-out} + +.wy-switch:after{content:"false"; + position:absolute; + left:48px; + display:block; + font-size:12px; + color:#ccc} + +.wy-switch.active{background:#1e8449} + +.wy-switch.active:before{left:24px; + background:#27AE60} + +.wy-switch.active:after{content:"true"} + +.wy-switch.disabled,.wy-switch.active.disabled{cursor:not-allowed} + +.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C} + +.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C} + +.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C} + +.wy-inline-validate{white-space:nowrap} + +.wy-inline-validate .wy-input-context{padding:0.5em 0.625em; + display:inline-block; + font-size:80%} + +.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60} + +.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C} + +.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22} + +.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9} + +.rotate-90{-webkit-transform:rotate(90deg); + -moz-transform:rotate(90deg); + -ms-transform:rotate(90deg); + -o-transform:rotate(90deg); + transform:rotate(90deg)} + +.rotate-180{-webkit-transform:rotate(180deg); + -moz-transform:rotate(180deg); + -ms-transform:rotate(180deg); + -o-transform:rotate(180deg); + transform:rotate(180deg)} + +.rotate-270{-webkit-transform:rotate(270deg); + -moz-transform:rotate(270deg); + -ms-transform:rotate(270deg); + -o-transform:rotate(270deg); + transform:rotate(270deg)} + +.mirror{-webkit-transform:scaleX(-1); + -moz-transform:scaleX(-1); + -ms-transform:scaleX(-1); + -o-transform:scaleX(-1); + transform:scaleX(-1)} + +.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg); + -moz-transform:scaleX(-1) rotate(90deg); + -ms-transform:scaleX(-1) rotate(90deg); + -o-transform:scaleX(-1) rotate(90deg); + transform:scaleX(-1) rotate(90deg)} + +.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg); + -moz-transform:scaleX(-1) rotate(180deg); + -ms-transform:scaleX(-1) rotate(180deg); + -o-transform:scaleX(-1) rotate(180deg); + transform:scaleX(-1) rotate(180deg)} + +.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg); + -moz-transform:scaleX(-1) rotate(270deg); + -ms-transform:scaleX(-1) rotate(270deg); + -o-transform:scaleX(-1) rotate(270deg); + transform:scaleX(-1) rotate(270deg)} + +@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0} + +.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em; + display:block} + +.wy-form label{margin-bottom:0.3em; + display:block} + +.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0} + +.wy-form-aligned .wy-control-group label{margin-bottom:0.3em; + text-align:left; + display:block; + width:100%} + +.wy-form-aligned .wy-control{margin:1.5em 0 0 0} + +.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block; + font-size:80%; + padding:6px 0} + +} + +@media screen and (max-width: 768px){.tablet-hide{display:none} + +} + +@media screen and (max-width: 480px){.mobile-hide{display:none} + +} +*/ + +.float-left { float: left; } +.float-right { float: right; } +.full-width { width: 100%; } + +/* +.wy-table{border-collapse:collapse; + border-spacing:0; + empty-cells:show; + margin-bottom:24px} + +.wy-table caption{color:#000; + font:italic 85%/1 arial,sans-serif; + padding:1em 0; + text-align:center} + +.wy-table td,.wy-table th{font-size:90%; + margin:0; + overflow:visible; + padding:8px 16px} + +.wy-table td:first-child,.wy-table th:first-child{border-left-width:0} + +.wy-table thead{color:#000; + text-align:left; + vertical-align:bottom; + white-space:nowrap} + +.wy-table thead th{font-weight:bold; + border-bottom:solid 2px #e1e4e5} + +.wy-table td{background-color:transparent; + vertical-align:middle} + +.wy-table td p{line-height:18px} + +.wy-table td p:last-child{margin-bottom:0} + +.wy-table .wy-table-cell-min{width:1%; + padding-right:0} + +.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0} + +.wy-table-secondary{color:gray; + font-size:90%} + +.wy-table-tertiary{color:gray; + font-size:80%} + +.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6} + +.wy-table-backed{background-color:#f3f6f6} + +.wy-table-bordered-all{border:1px solid #e1e4e5} + +.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5; + border-left:1px solid #e1e4e5} + +.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-bordered{border:1px solid #e1e4e5} + +.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5} + +.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0; + border-bottom:1px solid #e1e4e5} + +.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-responsive{margin-bottom:24px; + max-width:100%; + overflow:auto} + +.wy-table-responsive table{margin-bottom:0 !important} + +.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap} +*/ + +a { + color: #2980B9; + text-decoration: none; + cursor: pointer; +} + +a:hover { color: #3091d1; } +a:visited { color: #9B59B6; } + +a.headerlink, +a.headerlink:link, +a.headerlink:active, +a.headerlink:focus, +a.headerlink:visited +{ + padding-left: 4pt; + border-bottom: none; +} + +html { + height: 100%; + overflow-x: hidden; +} + +body { + font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + font-weight: normal; + color: #404040; + min-height: 100%; + overflow-x: hidden; + background: #edf0f2; +} + +/* +.wy-text-left{text-align:left} + +.wy-text-center{text-align:center} + +.wy-text-right{text-align:right} + +.wy-text-large{font-size:120%} + +.wy-text-normal{font-size:100%} + +.wy-text-small,small{font-size:80%} + +.wy-text-strike{text-decoration:line-through} + +.wy-text-warning{color:#E67E22 !important} + +a.wy-text-warning:hover{color:#eb9950 !important} + +.wy-text-info{color:#2980B9 !important} + +a.wy-text-info:hover{color:#409ad5 !important} + +.wy-text-success{color:#27AE60 !important} + +a.wy-text-success:hover{color:#36d278 !important} + +.wy-text-danger{color:#E74C3C !important} + +a.wy-text-danger:hover{color:#ed7669 !important} + +.wy-text-neutral{color:#404040 !important} + +a.wy-text-neutral:hover{color:#595959 !important} + +h1,h2,.rst-content p.caption,h3,h4,h5,h6,legend{margin-top:0; + font-weight:700; + font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif} + +p{line-height:24px; + margin:0; + font-size:16px; + margin-bottom:24px} + +h1{font-size:175%} + +h2,.rst-content p.caption{font-size:150%} + +h3{font-size:125%} + +h4{font-size:115%} + +h5{font-size:110%} + +h6{font-size:100%} + +hr{display:block; + height:1px; + border:0; + border-top:1px solid #e1e4e5; + margin:24px 0; + padding:0} + +code,.rst-content tt,.rst-content code{white-space:nowrap; + max-width:100%; + background:#fff; + border:solid 1px #e1e4e5; + font-size:75%; + padding:0 5px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + color:#E74C3C; + overflow-x:auto} + +code.code-large,.rst-content tt.code-large{font-size:90%} + +.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc; + line-height:24px; + margin-bottom:24px} + +.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc; + margin-left:24px} + +.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0} + +.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0} + +.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle} + +.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square} + +.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal} + +.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal; + line-height:24px; + margin-bottom:24px} + +.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal; + margin-left:24px} + +.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0} + +.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0} + +.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc} + +.codeblock-example{border:1px solid #e1e4e5; + border-bottom:none; + padding:24px; + padding-top:48px; + font-weight:500; + background:#fff; + position:relative} + +.codeblock-example:after{content:"Example"; + position:absolute; + top:0px; + left:0px; + background:#9B59B6; + color:#fff; + padding:6px 12px} + +.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5; + margin-bottom:24px} + +.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5; + padding:0px; + overflow-x:auto; + background:#fff; + margin:1px 0 24px 0} + +.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none; + background:none; + margin:0} + +div[class^='highlight'] td.code{width:100%} + +.linenodiv pre{border-right:solid 1px #e6e9ea; + margin:0; + padding:12px 12px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + font-size:12px; + line-height:1.5; + color:#d9d9d9} + +div[class^='highlight'] pre{white-space:pre; + margin:0; + padding:12px 12px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + font-size:12px; + line-height:1.5; + display:block; + overflow:auto; + color:#404040} + +@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap} + +} + +.hll{background-color:#ffc; + margin:0 -12px; + padding:0 12px; + display:block} + +.c{color:#998; + font-style:italic} + +.err{color:#a61717; + background-color:#e3d2d2} + +.k{font-weight:bold} + +.o{font-weight:bold} + +.cm{color:#998; + font-style:italic} + +.cp{color:#999; + font-weight:bold} + +.c1{color:#998; + font-style:italic} + +.cs{color:#999; + font-weight:bold; + font-style:italic} + +.gd{color:#000; + background-color:#fdd} + +.gd .x{color:#000; + background-color:#faa} + +.ge{font-style:italic} + +.gr{color:#a00} + +.gh{color:#999} + +.gi{color:#000; + background-color:#dfd} + +.gi .x{color:#000; + background-color:#afa} + +.go{color:#888} + +.gp{color:#555} + +.gs{font-weight:bold} + +.gu{color:purple; + font-weight:bold} + +.gt{color:#a00} + +.kc{font-weight:bold} + +.kd{font-weight:bold} + +.kn{font-weight:bold} + +.kp{font-weight:bold} + +.kr{font-weight:bold} + +.kt{color:#458; + font-weight:bold} + +.m{color:#099} + +.s{color:#d14} + +.n{color:#333} + +.na{color:teal} + +.nb{color:#0086b3} + +.nc{color:#458; + font-weight:bold} + +.no{color:teal} + +.ni{color:purple} + +.ne{color:#900; + font-weight:bold} + +.nf{color:#900; + font-weight:bold} + +.nn{color:#555} + +.nt{color:navy} + +.nv{color:teal} + +.ow{font-weight:bold} + +.w{color:#bbb} + +.mf{color:#099} + +.mh{color:#099} + +.mi{color:#099} + +.mo{color:#099} + +.sb{color:#d14} +*/ + +/*.sc{color:#d14}*/ + +/* +.sd{color:#d14} + +.s2{color:#d14} + +.se{color:#d14} + +.sh{color:#d14} + +.si{color:#d14} + +.sx{color:#d14} + +.sr{color:#009926} + +.s1{color:#d14} + +.ss{color:#990073} + +.bp{color:#999} + +.vc{color:teal} + +.vg{color:teal} + +.vi{color:teal} + +.il{color:#099} + +.gc{color:#999; + background-color:#EAF2F5} +*/ + +ul.wy-breadcrumbs { + padding: 0pt; + margin: 0pt; + font-size: 90%; +} + +.wy-breadcrumbs li { display: inline-block; } +.wy-breadcrumbs li.wy-breadcrumbs-aside { float: right; } + +.wy-breadcrumbs li a { + display: inline-block; + padding: 5px; + border-bottom: none; +} + +.wy-breadcrumbs li a:first-child { padding-left: 0; } + +.wy-breadcrumbs-extra { + margin-bottom: 0; + color: #b3b3b3; + font-size: 80%; + display: inline-block; +} + +@media screen and (max-width: 480px) { + .wy-breadcrumbs-extra { display: none; } + .wy-breadcrumbs li.wy-breadcrumbs-aside { display: none; } +} + +@media print { + .wy-breadcrumbs li.wy-breadcrumbs-aside { display: none; } +} + +/* +.wy-affix{position:fixed; + top:1.618em} +*/ + +.wy-menu a:hover { text-decoration: none; } + +/* +.wy-menu-horiz{*zoom:1} + +.wy-menu-horiz:before,.wy-menu-horiz:after{display:table; + content:""} + +.wy-menu-horiz:after{clear:both} + +.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block} + +.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)} + +.wy-menu-horiz li.divide-left{border-left:solid 1px #404040} + +.wy-menu-horiz li.divide-right{border-right:solid 1px #404040} + +.wy-menu-horiz a{height:32px; + display:inline-block; + line-height:32px; + padding:0 16px} +*/ + +.wy-menu-vertical header, +.wy-menu-vertical p.caption +{ + height: 32px; + display: inline-block; + line-height: 32px; + padding: 0 1.618em; + margin-bottom: 0; + display: block; + font-weight: bold; + text-transform: uppercase; + font-size: 80%; + color: #555; + white-space: nowrap; +} + +div.wy-menu-vertical ul { margin-bottom: 0; } +div.wy-menu-vertical li.divide-top { border-top: solid 1px #404040; } +div.wy-menu-vertical li.divide-bottom { border-bottom: solid 1px #404040; } +div.wy-menu-vertical li.current { background: #e3e3e3; } + +div.wy-menu-vertical li.current a { + color: black; + border-right: solid 1px #c9c9c9; + padding: 0.4045em 2.427em; +} + +div.wy-menu-vertical li.current a:hover { background:#d6d6d6; } + +div.wy-menu-vertical li code, +div.wy-menu-vertical li .rst-content tt, +.rst-content div.wy-menu-vertical li tt +{ + border: none; + background: inherit; + color: inherit; + padding-left: 0; + padding-right: 0 +} + +div.wy-menu-vertical li span.toctree-expand { + display: block; + float: left; + margin-left: -1.2em; + font-size: 0.8em; + line-height: 1.6em; + color: #4d4d4d; +} + +div.wy-menu-vertical li.on a, +div.wy-menu-vertical li.current>a +{ +/* + color: #404040; + */ + color: black; + background: #fcfcfc; + padding: 0.4045em 1.618em; + font-weight: bold; + position: relative; + border: none; + border-bottom: solid 1px #c9c9c9; + border-top: solid 1px #c9c9c9; + padding-left: 1.618em -4px; +} + +div.wy-menu-vertical li.on a:hover, +div.wy-menu-vertical li.current>a:hover +{ background: #fcfcfc; } + +div.wy-menu-vertical li.on a:hover span.toctree-expand, +div.wy-menu-vertical li.current>a:hover span.toctree-expand +{ color: gray; } + +div.wy-menu-vertical li.on a span.toctree-expand, +div.wy-menu-vertical li.current>a span.toctree-expand +{ + display: block; + font-size: 0.8em; + line-height: 1.6em; + color: #333; +} + +div.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul, +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul +{ display:none; } + +div.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul, +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul +{ display:block; } + +div.wy-menu-vertical li.toctree-l2.current>a { + background: #c9c9c9; + padding: 0.4045em 2.427em; +} + +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a { + display: block; + background: #c9c9c9; + padding: 0.4045em 4.045em +} + +div.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand { color: gray; } +div.wy-menu-vertical li.toctree-l2 span.toctree-expand { color: #a3a3a3; } + +div.wy-menu-vertical li.toctree-l3 {font-size: 0.9em; } + +div.wy-menu-vertical li.toctree-l3.current>a { + background: #bdbdbd; + padding: 0.4045em 4.045em; +} + +div.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a { + display: block; + background: #bdbdbd; + padding: 0.4045em 5.663em; + border-top: none; + border-bottom: none; +} + +div.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand { color: gray; } +div.wy-menu-vertical li.toctree-l3 span.toctree-expand { color: #969696; } +div.wy-menu-vertical li.toctree-l4 { font-size: 0.9em; } +div.wy-menu-vertical li.current ul { display: block; } + +div.wy-menu-vertical li ul { + margin-bottom: 0; + display: none; +} + +div.wy-menu-vertical .local-toc li ul { display: block; } + +div.wy-menu-vertical li ul li a { + margin-bottom: 0; + color: #b3b3b3; + font-weight: normal; +} + +div.wy-menu-vertical a { + display: inline-block; + line-height: 18px; + padding: 0.4045em 1.618em; + border-bottom: none; + display: block; + position: relative; + font-size: 90%; + color: #b3b3b3; +} + +div.wy-menu-vertical a:hover { + background-color: #4e4a4a; + cursor: pointer; + border-bottom: none; +} + +div.wy-menu-vertical a:hover span.toctree-expand { color: #b3b3b3; } + +div.wy-menu-vertical a:active { + background-color: #2980B9; + cursor: pointer; + color: #fff; +} + +div.wy-menu-vertical a:active span.toctree-expand { color: #fff; } + +.wy-side-nav-search { + z-index: 200; +/*background-color: #2980B9;*/ + background-color: #7aa2f3; + text-align: center; + padding: 0.809em; + display: block; + color: #fcfcfc; + margin-bottom: 0.809em; +} + +.wy-side-nav-search input[type=text] { + width: 80%; + border-radius: 50px; + padding: 6px 12px; + border-color: #2472a4; + font-size: 90%; +} + +.wy-side-nav-search img { + display: block; + margin: auto auto 0.809em auto; + height: 45px; + width: 45px; + background-color: #2980B9; + padding: 5px; + border-radius: 100%; +} + +div.wy-side-nav-search>a, +div.wy-side-nav-search .wy-dropdown>a +{ + color: #fcfcfc; + font-size: 120%; + font-weight: bold; + display: inline-block; + padding: 4px 6px; + margin-bottom: 0.809em; + border-bottom: none; + outline: 0; +} + +/* +.wy-side-nav-search>a:hover, +.wy-side-nav-search .wy-dropdown>a:hover { + background: rgba(255,255,255,0.1); +} +*/ + +.wy-side-nav-search>a img.logo, +.wy-side-nav-search .wy-dropdown>a img.logo +{ + display: block; + margin: 0 auto; + height: auto; + width: auto; + border-radius: 0; + max-width: 100%; + background: transparent; +} + +.wy-side-nav-search>a.icon img.logo, +.wy-side-nav-search .wy-dropdown>a.icon img.logo +{ + margin-top: 0.85em; +} + +.wy-nav .wy-menu-vertical header { color: #2980B9; } +.wy-nav .wy-menu-vertical a { color: #b3b3b3; } + +.wy-nav .wy-menu-vertical a:hover { + background-color: #2980B9; + color: #fff; +} + +/* +[data-menu-wrap]{-webkit-transition:all 0.2s ease-in; + -moz-transition:all 0.2s ease-in; + transition:all 0.2s ease-in; + position:absolute; + opacity:1; + width:100%; + opacity:0} + +[data-menu-wrap].move-center{left:0; + right:auto; + opacity:1} + +[data-menu-wrap].move-left{right:auto; + left:-100%; + opacity:0} + +[data-menu-wrap].move-right{right:-100%; + left:auto; + opacity:0} +*/ + +.wy-body-for-nav { + background: left repeat-y #dddddd; +/* + background: left repeat-y #fcfcfc; + background-image: url(data:image/png; + base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC); + background-size: 300px 1px; + */ +} + +.wy-grid-for-nav { + position: absolute; + width: 80%; + height: 100%; +} + +.wy-nav-side { + position: fixed; + top: 0; + bottom: 0; + left: 0; + padding-bottom: 2em; + width: 300px; + overflow-x: hidden; + overflow-y: auto; + min-height: 100%; + background: #343131; + z-index: 200; +} + +.wy-nav-top{display:none; + background:#2980B9; + color:#fff; + padding:0.4045em 0.809em; + position:relative; + line-height:50px; + text-align:center; + font-size:100%; + *zoom:1} + +/* +.wy-nav-top:before,.wy-nav-top:after{display:table; + content:""} + +.wy-nav-top:after{clear:both} +*/ + +.wy-nav-top a { + color: #fff; + font-weight: bold; +} + +/* +.wy-nav-top img{margin-right:12px; + height:45px; + width:45px; + background-color:#2980B9; + padding:5px; + border-radius:100%} + +.wy-nav-top i{font-size:30px; + float:left; + cursor:pointer} + +.wy-nav-content-wrap { + margin-left: 300px; + background: #fcfcfc; + min-height: 100%; +} +*/ + +.wy-nav-content { + padding: 1.618em 3.236em; + height: 100%; + max-width: 900px; +/*margin: auto;*/ +} + +/* +.wy-body-mask{position:fixed; + width:100%; + height:100%; + background:rgba(0,0,0,0.2); + display:none; + z-index:499} + +.wy-body-mask.on{display:block} + +footer{color:#999} +*/ + +footer { font-size: 90%; } + +/* + +footer p{margin-bottom:12px} + +.rst-footer-buttons{*zoom:1} + +.rst-footer-buttons:before,.rst-footer-buttons:after{display:table; + content:""} + +.rst-footer-buttons:after{clear:both} + +#search-results .search li{margin-bottom:24px; + border-bottom:solid 1px #e1e4e5; + padding-bottom:24px} + +#search-results .search li:first-child{border-top:solid 1px #e1e4e5; + padding-top:24px} + +#search-results .search li a{font-size:120%; + margin-bottom:12px; + display:inline-block} + +#search-results .context{color:gray; + font-size:90%} + +@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc} + +.wy-nav-top{display:block} + +.wy-nav-side{left:-300px} + +.wy-nav-side.shift{width:85%; + left:0} + +.wy-nav-content-wrap { + margin-left: 0pt; + margin-bottom: 0pt; +} + +.wy-nav-content-wrap .wy-nav-content{padding:1.618em} + +.wy-nav-content-wrap.shift{position:fixed; + min-width:100%; + left:85%; + top:0; + height:100%; + overflow:hidden} + +} + +@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)} + +*/ +.wy-nav-content { + margin: 0px 0px 0px 300px; + background: white; +} + +.wy-nav-content-wrap { + font-size: 95%; + margin: 0px; + padding: 0px; +} +/* + +} + +@media print{.rst-versions,footer,.wy-nav-side{display:none} + +.wy-nav-content-wrap{margin-left:0} + +} + +.rst-versions{position:fixed; + bottom:0; + left:0; + width:300px; + color:#fcfcfc; + background:#1f1d1d; + border-top:solid 10px #343131; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + z-index:400} + +.rst-versions a{color:#2980B9; + text-decoration:none} + +.rst-versions .rst-badge-small{display:none} + +.rst-versions .rst-current-version{padding:12px; + background-color:#272525; + display:block; + text-align:right; + font-size:90%; + cursor:pointer; + color:#27AE60; + *zoom:1} + +.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table; + content:""} + +.rst-versions .rst-current-version:after{clear:both} +*/ + +.rst-versions .rst-current-version .fa, +.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand, +.rst-versions .rst-current-version .rst-content .admonition-title, +.rst-content .rst-versions .rst-current-version .admonition-title, +.rst-versions .rst-current-version .rst-content h1 .headerlink, +.rst-content h1 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h2 .headerlink, +.rst-content h2 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content p.caption .headerlink, +.rst-content p.caption .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h3 .headerlink, +.rst-content h3 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h4 .headerlink, +.rst-content h4 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h5 .headerlink, +.rst-content h5 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h6 .headerlink, +.rst-content h6 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content dl dt .headerlink, +.rst-content dl dt .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content tt.download span:first-child, +.rst-content tt.download .rst-versions .rst-current-version span:first-child, +.rst-versions .rst-current-version .rst-content code.download span:first-child, +.rst-content code.download .rst-versions .rst-current-version span:first-child, +.rst-versions .rst-current-version .icon +{ + color: #fcfcfc +} + +/* +.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left} + +.rst-versions .rst-current-version .icon-book{float:left} + +.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C; + color:#fff} + +.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F; + color:#000} + +.rst-versions.shift-up .rst-other-versions{display:block} + +.rst-versions .rst-other-versions{font-size:90%; + padding:12px; + color:gray; + display:none} + +.rst-versions .rst-other-versions hr{display:block; + height:1px; + border:0; + margin:20px 0; + padding:0; + border-top:solid 1px #413d3d} + +.rst-versions .rst-other-versions dd{display:inline-block; + margin:0} + +.rst-versions .rst-other-versions dd a{display:inline-block; + padding:6px; + color:#fcfcfc} + +.rst-versions.rst-badge{width:auto; + bottom:20px; + right:20px; + left:auto; + border:none; + max-width:300px} + +.rst-versions.rst-badge .icon-book{float:none} + +.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none} + +.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right} + +.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left} + +.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left} + +.rst-versions.rst-badge .rst-current-version{width:auto; + height:30px; + line-height:30px; + padding:0 6px; + display:block; + text-align:center} + +@media screen and (max-width: 768px){.rst-versions{width:85%; + display:none} + +.rst-versions.shift{display:block} + +img{width:100%; + height:auto} + +} +*/ + +/* +.rst-content img{max-width:100%; + height:auto !important} + +.rst-content div.figure{margin-bottom:24px} + +.rst-content div.figure.align-center{text-align:center} + +.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px} + +.rst-content blockquote{margin-left:24px; + line-height:24px; + margin-bottom:24px} + +.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0} + +.rst-content .admonition-title:before{margin-right:4px} + +.rst-content .admonition table{border-color:rgba(0,0,0,0.1)} + +.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important; + border-color:rgba(0,0,0,0.1) !important} + +.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha} + +.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha} + +.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px} + +.rst-content .line-block{margin-left:24px} + +.rst-content .topic-title{font-weight:bold; + margin-bottom:12px} + +.rst-content .toc-backref{color:#404040} + +.rst-content .align-right{float:right; + margin:0px 0px 24px 24px} + +.rst-content .align-left{float:left; + margin:0px 24px 24px 0px} + +.rst-content .align-center{margin:auto; + display:block} + +.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink{display:none; + visibility:hidden; + font-size:14px} + +.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after{visibility:visible; + content:""; + font-family:FontAwesome; + display:inline-block} + +.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content p.caption:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink,.rst-content p.caption:hover .headerlink{display:inline-block} + +.rst-content .sidebar{float:right; + width:40%; + display:block; + margin:0 0 24px 24px; + padding:24px; + background:#f3f6f6; + border:solid 1px #e1e4e5} + +.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%} + +.rst-content .sidebar .last{margin-bottom:0} + +.rst-content .sidebar .sidebar-title{display:block; + font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif; + font-weight:bold; + background:#e1e4e5; + padding:6px 12px; + margin:-24px; + margin-bottom:24px; + font-size:100%} + +.rst-content .highlighted{background:#F1C40F; + display:inline-block; + font-weight:bold; + padding:0 6px} + +.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super; + font-size:90%} + +.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none; + border:none; + color:#999} + +.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none; + background-color:transparent !important; + white-space:normal} + +.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0; + padding-right:0; + vertical-align:top} + +.rst-content table.field-list{border:none} + +.rst-content table.field-list td{border:none; + padding-top:5px} + +.rst-content table.field-list td>strong{display:inline-block; + margin-top:3px} + +.rst-content table.field-list .field-name{padding-right:10px; + text-align:left; + white-space:nowrap} + +.rst-content table.field-list .field-body{text-align:left; + padding-left:0} + +.rst-content tt,.rst-content tt,.rst-content code{color:#000} + +.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important; + line-height:normal} + +.rst-content tt .xref,a .rst-content tt,.rst-content tt .xref,.rst-content code .xref,a .rst-content tt,a .rst-content code{font-weight:bold} + +.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9} + +.rst-content dl{margin-bottom:24px} + +.rst-content dl dt{font-weight:bold} + +.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important} + +.rst-content dl dd{margin:0 0 12px 24px} + +.rst-content dl:not(.docutils){margin-bottom:24px} + +.rst-content dl:not(.docutils) dt{display:inline-block; + margin:6px 0; + font-size:90%; + line-height:normal; + background:#e7f2fa; + color:#2980B9; + border-top:solid 3px #6ab0de; + padding:6px; + position:relative} + +.rst-content dl:not(.docutils) dt:before{color:#6ab0de} + +.rst-content dl:not(.docutils) dt .headerlink{color:#404040; + font-size:100% !important} + +.rst-content dl:not(.docutils) dl dt{margin-bottom:6px; + border:none; + border-left:solid 3px #ccc; + background:#f0f0f0; + color:gray} + +.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040; + font-size:100% !important} + +.rst-content dl:not(.docutils) dt:first-child{margin-top:0} + +.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold} + +.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent; + border:none; + padding:0; + font-size:100% !important} + +.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold} + +.rst-content dl:not(.docutils) .optional{display:inline-block; + padding:0 4px; + color:#000; + font-weight:bold} + +.rst-content dl:not(.docutils) .property{display:inline-block; + padding-right:8px} + +.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block; + color:#27AE60; + font-size:80%; + padding-left:24px} + +.rst-content .viewcode-back{display:block; + float:right} + +.rst-content p.rubric{margin-bottom:12px; + font-weight:bold} + +.rst-content tt.download,.rst-content code.download{background:inherit; + padding:inherit; + font-family:inherit; + font-size:inherit; + color:inherit; + border:inherit; + white-space:inherit} + +.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px} + +@media screen and (max-width: 480px){.rst-content .sidebar{width:100%} +*/ + +} + +/* +span[id*='MathJax-Span']{color:#404040} + +.math{text-align:center} + +@font-face{font-family:"Inconsolata"; + font-style:normal; + font-weight:400; + src:local("Inconsolata"),url(../fonts/Inconsolata.ttf) format("truetype")} + +@font-face{font-family:"Inconsolata"; + font-style:normal; + font-weight:700; + src:local("Inconsolata Bold"),local("Inconsolata-Bold"),url(../fonts/Inconsolata-Bold.ttf) format("truetype")} + +@font-face{font-family:"Lato"; + font-style:normal; + font-weight:400; + src:local("Lato Regular"),local("Lato-Regular"),url(../fonts/Lato-Regular.ttf) format("truetype")} + +@font-face{font-family:"Lato"; + font-style:normal; + font-weight:700; + src:local("Lato Bold"),local("Lato-Bold"),url(../fonts/Lato-Bold.ttf) format("truetype")} + +@font-face{font-family:"Roboto Slab"; + font-style:normal; + font-weight:400; + src:local("Roboto Slab Regular"),local("RobotoSlab-Regular"),url(../fonts/RobotoSlab-Regular.ttf) format("truetype")} + +@font-face{font-family:"Roboto Slab"; + font-style:normal; + font-weight:700; + src:local("Roboto Slab Bold"),local("RobotoSlab-Bold"),url(../fonts/RobotoSlab-Bold.ttf) format("truetype")} +*/ + + +/*# sourceMappingURL=theme.css.map */ diff --git a/documentation/_build/html/_static/doctools.js b/documentation/_build/html/_static/doctools.js new file mode 100644 index 00000000..d4619fdf --- /dev/null +++ b/documentation/_build/html/_static/doctools.js @@ -0,0 +1,247 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/documentation/_build/html/_static/down-pressed.png b/documentation/_build/html/_static/down-pressed.png new file mode 100644 index 00000000..6f7ad782 Binary files /dev/null and b/documentation/_build/html/_static/down-pressed.png differ diff --git a/documentation/_build/html/_static/down.png b/documentation/_build/html/_static/down.png new file mode 100644 index 00000000..3003a887 Binary files /dev/null and b/documentation/_build/html/_static/down.png differ diff --git a/documentation/_build/html/_static/file.png b/documentation/_build/html/_static/file.png new file mode 100644 index 00000000..d18082e3 Binary files /dev/null and b/documentation/_build/html/_static/file.png differ diff --git a/documentation/_build/html/_static/fonts/Inconsolata-Bold.ttf b/documentation/_build/html/_static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..360a232d Binary files /dev/null and b/documentation/_build/html/_static/fonts/Inconsolata-Bold.ttf differ diff --git a/documentation/_build/html/_static/fonts/Inconsolata.ttf b/documentation/_build/html/_static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/documentation/_build/html/_static/fonts/Inconsolata.ttf differ diff --git a/documentation/_build/html/_static/fonts/Lato-Bold.ttf b/documentation/_build/html/_static/fonts/Lato-Bold.ttf new file mode 100644 index 00000000..59c48434 Binary files /dev/null and b/documentation/_build/html/_static/fonts/Lato-Bold.ttf differ diff --git a/documentation/_build/html/_static/fonts/Lato-Regular.ttf b/documentation/_build/html/_static/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..f01f5589 Binary files /dev/null and b/documentation/_build/html/_static/fonts/Lato-Regular.ttf differ diff --git a/documentation/_build/html/_static/fonts/RobotoSlab-Bold.ttf b/documentation/_build/html/_static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..e6ed0de5 Binary files /dev/null and b/documentation/_build/html/_static/fonts/RobotoSlab-Bold.ttf differ diff --git a/documentation/_build/html/_static/fonts/RobotoSlab-Regular.ttf b/documentation/_build/html/_static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..141d6c08 Binary files /dev/null and b/documentation/_build/html/_static/fonts/RobotoSlab-Regular.ttf differ diff --git a/documentation/_build/html/_static/fonts/fontawesome-webfont.eot b/documentation/_build/html/_static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..7c79c6a6 Binary files /dev/null and b/documentation/_build/html/_static/fonts/fontawesome-webfont.eot differ diff --git a/documentation/_build/html/_static/fonts/fontawesome-webfont.svg b/documentation/_build/html/_static/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..a9f84695 --- /dev/null +++ b/documentation/_build/html/_static/fonts/fontawesome-webfont.svg @@ -0,0 +1,504 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/_static/fonts/fontawesome-webfont.ttf b/documentation/_build/html/_static/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..5ec37c4f Binary files /dev/null and b/documentation/_build/html/_static/fonts/fontawesome-webfont.ttf differ diff --git a/documentation/_build/html/_static/fonts/fontawesome-webfont.woff b/documentation/_build/html/_static/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..9eaecb37 Binary files /dev/null and b/documentation/_build/html/_static/fonts/fontawesome-webfont.woff differ diff --git a/documentation/_build/html/_static/images/clipboard.bb b/documentation/_build/html/_static/images/clipboard.bb new file mode 100644 index 00000000..3bd31e10 --- /dev/null +++ b/documentation/_build/html/_static/images/clipboard.bb @@ -0,0 +1 @@ +%%BoundingBox: 0 0 48 48 diff --git a/documentation/RDS/images/clipboard.eps b/documentation/_build/html/_static/images/clipboard.eps similarity index 100% rename from documentation/RDS/images/clipboard.eps rename to documentation/_build/html/_static/images/clipboard.eps diff --git a/documentation/_build/html/_static/images/clipboard.pdf b/documentation/_build/html/_static/images/clipboard.pdf new file mode 100644 index 00000000..5424a7a2 Binary files /dev/null and b/documentation/_build/html/_static/images/clipboard.pdf differ diff --git a/documentation/RDS/images/clipboard.png b/documentation/_build/html/_static/images/clipboard.png similarity index 100% rename from documentation/RDS/images/clipboard.png rename to documentation/_build/html/_static/images/clipboard.png diff --git a/documentation/_build/html/_static/images/i-core.bb b/documentation/_build/html/_static/images/i-core.bb new file mode 100644 index 00000000..3bd31e10 --- /dev/null +++ b/documentation/_build/html/_static/images/i-core.bb @@ -0,0 +1 @@ +%%BoundingBox: 0 0 48 48 diff --git a/documentation/RDS/images/i-core.eps b/documentation/_build/html/_static/images/i-core.eps similarity index 100% rename from documentation/RDS/images/i-core.eps rename to documentation/_build/html/_static/images/i-core.eps diff --git a/documentation/_build/html/_static/images/i-core.pdf b/documentation/_build/html/_static/images/i-core.pdf new file mode 100644 index 00000000..2bb22c3b Binary files /dev/null and b/documentation/_build/html/_static/images/i-core.pdf differ diff --git a/documentation/RDS/images/i-core.png b/documentation/_build/html/_static/images/i-core.png similarity index 100% rename from documentation/RDS/images/i-core.png rename to documentation/_build/html/_static/images/i-core.png diff --git a/documentation/_build/html/_static/jquery.js b/documentation/_build/html/_static/jquery.js new file mode 100644 index 00000000..7c243080 --- /dev/null +++ b/documentation/_build/html/_static/jquery.js @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, +Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& +(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, +a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== +"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, +function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; +var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, +parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= +false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= +s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, +applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; +else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, +a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== +w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, +cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= +c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); +a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, +function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); +k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), +C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= +e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& +f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; +if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", +e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, +"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, +d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, +e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); +t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| +g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, +CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, +g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, +text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, +setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= +h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== +"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, +h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& +q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; +if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); +(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: +function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= +{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== +"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", +d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? +a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== +1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= +c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, +wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, +prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, +this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); +return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, +""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); +return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", +""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= +c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? +c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= +function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= +Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, +"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= +a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= +a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== +"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, +serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), +function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, +global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& +e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? +"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== +false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= +false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", +c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| +d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); +g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== +1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== +"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; +if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== +"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| +c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; +this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= +this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, +e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; +a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); +c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, +d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- +f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": +"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in +e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); diff --git a/documentation/_build/html/_static/js/modernizr.min.js b/documentation/_build/html/_static/js/modernizr.min.js new file mode 100644 index 00000000..f65d4797 --- /dev/null +++ b/documentation/_build/html/_static/js/modernizr.min.js @@ -0,0 +1,4 @@ +/* Modernizr 2.6.2 (Custom Build) | MIT & BSD + * Build: http://modernizr.com/download/#-fontface-backgroundsize-borderimage-borderradius-boxshadow-flexbox-hsla-multiplebgs-opacity-rgba-textshadow-cssanimations-csscolumns-generatedcontent-cssgradients-cssreflections-csstransforms-csstransforms3d-csstransitions-applicationcache-canvas-canvastext-draganddrop-hashchange-history-audio-video-indexeddb-input-inputtypes-localstorage-postmessage-sessionstorage-websockets-websqldatabase-webworkers-geolocation-inlinesvg-smil-svg-svgclippaths-touch-webgl-shiv-mq-cssclasses-addtest-prefixed-teststyles-testprop-testallprops-hasevent-prefixes-domprefixes-load + */ +;window.Modernizr=function(a,b,c){function D(a){j.cssText=a}function E(a,b){return D(n.join(a+";")+(b||""))}function F(a,b){return typeof a===b}function G(a,b){return!!~(""+a).indexOf(b)}function H(a,b){for(var d in a){var e=a[d];if(!G(e,"-")&&j[e]!==c)return b=="pfx"?e:!0}return!1}function I(a,b,d){for(var e in a){var f=b[a[e]];if(f!==c)return d===!1?a[e]:F(f,"function")?f.bind(d||b):f}return!1}function J(a,b,c){var d=a.charAt(0).toUpperCase()+a.slice(1),e=(a+" "+p.join(d+" ")+d).split(" ");return F(b,"string")||F(b,"undefined")?H(e,b):(e=(a+" "+q.join(d+" ")+d).split(" "),I(e,b,c))}function K(){e.input=function(c){for(var d=0,e=c.length;d',a,""].join(""),l.id=h,(m?l:n).innerHTML+=f,n.appendChild(l),m||(n.style.background="",n.style.overflow="hidden",k=g.style.overflow,g.style.overflow="hidden",g.appendChild(n)),i=c(l,a),m?l.parentNode.removeChild(l):(n.parentNode.removeChild(n),g.style.overflow=k),!!i},z=function(b){var c=a.matchMedia||a.msMatchMedia;if(c)return c(b).matches;var d;return y("@media "+b+" { #"+h+" { position: absolute; } }",function(b){d=(a.getComputedStyle?getComputedStyle(b,null):b.currentStyle)["position"]=="absolute"}),d},A=function(){function d(d,e){e=e||b.createElement(a[d]||"div"),d="on"+d;var f=d in e;return f||(e.setAttribute||(e=b.createElement("div")),e.setAttribute&&e.removeAttribute&&(e.setAttribute(d,""),f=F(e[d],"function"),F(e[d],"undefined")||(e[d]=c),e.removeAttribute(d))),e=null,f}var a={select:"input",change:"input",submit:"form",reset:"form",error:"img",load:"img",abort:"img"};return d}(),B={}.hasOwnProperty,C;!F(B,"undefined")&&!F(B.call,"undefined")?C=function(a,b){return B.call(a,b)}:C=function(a,b){return b in a&&F(a.constructor.prototype[b],"undefined")},Function.prototype.bind||(Function.prototype.bind=function(b){var c=this;if(typeof c!="function")throw new TypeError;var d=w.call(arguments,1),e=function(){if(this instanceof e){var a=function(){};a.prototype=c.prototype;var f=new a,g=c.apply(f,d.concat(w.call(arguments)));return Object(g)===g?g:f}return c.apply(b,d.concat(w.call(arguments)))};return e}),s.flexbox=function(){return J("flexWrap")},s.canvas=function(){var a=b.createElement("canvas");return!!a.getContext&&!!a.getContext("2d")},s.canvastext=function(){return!!e.canvas&&!!F(b.createElement("canvas").getContext("2d").fillText,"function")},s.webgl=function(){return!!a.WebGLRenderingContext},s.touch=function(){var c;return"ontouchstart"in a||a.DocumentTouch&&b instanceof DocumentTouch?c=!0:y(["@media (",n.join("touch-enabled),("),h,")","{#modernizr{top:9px;position:absolute}}"].join(""),function(a){c=a.offsetTop===9}),c},s.geolocation=function(){return"geolocation"in navigator},s.postmessage=function(){return!!a.postMessage},s.websqldatabase=function(){return!!a.openDatabase},s.indexedDB=function(){return!!J("indexedDB",a)},s.hashchange=function(){return A("hashchange",a)&&(b.documentMode===c||b.documentMode>7)},s.history=function(){return!!a.history&&!!history.pushState},s.draganddrop=function(){var a=b.createElement("div");return"draggable"in a||"ondragstart"in a&&"ondrop"in a},s.websockets=function(){return"WebSocket"in a||"MozWebSocket"in a},s.rgba=function(){return D("background-color:rgba(150,255,150,.5)"),G(j.backgroundColor,"rgba")},s.hsla=function(){return D("background-color:hsla(120,40%,100%,.5)"),G(j.backgroundColor,"rgba")||G(j.backgroundColor,"hsla")},s.multiplebgs=function(){return D("background:url(https://),url(https://),red url(https://)"),/(url\s*\(.*?){3}/.test(j.background)},s.backgroundsize=function(){return J("backgroundSize")},s.borderimage=function(){return J("borderImage")},s.borderradius=function(){return J("borderRadius")},s.boxshadow=function(){return J("boxShadow")},s.textshadow=function(){return b.createElement("div").style.textShadow===""},s.opacity=function(){return E("opacity:.55"),/^0.55$/.test(j.opacity)},s.cssanimations=function(){return J("animationName")},s.csscolumns=function(){return J("columnCount")},s.cssgradients=function(){var a="background-image:",b="gradient(linear,left top,right bottom,from(#9f9),to(white));",c="linear-gradient(left top,#9f9, white);";return D((a+"-webkit- ".split(" ").join(b+a)+n.join(c+a)).slice(0,-a.length)),G(j.backgroundImage,"gradient")},s.cssreflections=function(){return J("boxReflect")},s.csstransforms=function(){return!!J("transform")},s.csstransforms3d=function(){var a=!!J("perspective");return a&&"webkitPerspective"in g.style&&y("@media (transform-3d),(-webkit-transform-3d){#modernizr{left:9px;position:absolute;height:3px;}}",function(b,c){a=b.offsetLeft===9&&b.offsetHeight===3}),a},s.csstransitions=function(){return J("transition")},s.fontface=function(){var a;return y('@font-face {font-family:"font";src:url("https://")}',function(c,d){var e=b.getElementById("smodernizr"),f=e.sheet||e.styleSheet,g=f?f.cssRules&&f.cssRules[0]?f.cssRules[0].cssText:f.cssText||"":"";a=/src/i.test(g)&&g.indexOf(d.split(" ")[0])===0}),a},s.generatedcontent=function(){var a;return y(["#",h,"{font:0/0 a}#",h,':after{content:"',l,'";visibility:hidden;font:3px/1 a}'].join(""),function(b){a=b.offsetHeight>=3}),a},s.video=function(){var a=b.createElement("video"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('video/ogg; codecs="theora"').replace(/^no$/,""),c.h264=a.canPlayType('video/mp4; codecs="avc1.42E01E"').replace(/^no$/,""),c.webm=a.canPlayType('video/webm; codecs="vp8, vorbis"').replace(/^no$/,"")}catch(d){}return c},s.audio=function(){var a=b.createElement("audio"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('audio/ogg; codecs="vorbis"').replace(/^no$/,""),c.mp3=a.canPlayType("audio/mpeg;").replace(/^no$/,""),c.wav=a.canPlayType('audio/wav; codecs="1"').replace(/^no$/,""),c.m4a=(a.canPlayType("audio/x-m4a;")||a.canPlayType("audio/aac;")).replace(/^no$/,"")}catch(d){}return c},s.localstorage=function(){try{return localStorage.setItem(h,h),localStorage.removeItem(h),!0}catch(a){return!1}},s.sessionstorage=function(){try{return sessionStorage.setItem(h,h),sessionStorage.removeItem(h),!0}catch(a){return!1}},s.webworkers=function(){return!!a.Worker},s.applicationcache=function(){return!!a.applicationCache},s.svg=function(){return!!b.createElementNS&&!!b.createElementNS(r.svg,"svg").createSVGRect},s.inlinesvg=function(){var a=b.createElement("div");return a.innerHTML="",(a.firstChild&&a.firstChild.namespaceURI)==r.svg},s.smil=function(){return!!b.createElementNS&&/SVGAnimate/.test(m.call(b.createElementNS(r.svg,"animate")))},s.svgclippaths=function(){return!!b.createElementNS&&/SVGClipPath/.test(m.call(b.createElementNS(r.svg,"clipPath")))};for(var L in s)C(s,L)&&(x=L.toLowerCase(),e[x]=s[L](),v.push((e[x]?"":"no-")+x));return e.input||K(),e.addTest=function(a,b){if(typeof a=="object")for(var d in a)C(a,d)&&e.addTest(d,a[d]);else{a=a.toLowerCase();if(e[a]!==c)return e;b=typeof b=="function"?b():b,typeof f!="undefined"&&f&&(g.className+=" "+(b?"":"no-")+a),e[a]=b}return e},D(""),i=k=null,function(a,b){function k(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function l(){var a=r.elements;return typeof a=="string"?a.split(" "):a}function m(a){var b=i[a[g]];return b||(b={},h++,a[g]=h,i[h]=b),b}function n(a,c,f){c||(c=b);if(j)return c.createElement(a);f||(f=m(c));var g;return f.cache[a]?g=f.cache[a].cloneNode():e.test(a)?g=(f.cache[a]=f.createElem(a)).cloneNode():g=f.createElem(a),g.canHaveChildren&&!d.test(a)?f.frag.appendChild(g):g}function o(a,c){a||(a=b);if(j)return a.createDocumentFragment();c=c||m(a);var d=c.frag.cloneNode(),e=0,f=l(),g=f.length;for(;e",f="hidden"in a,j=a.childNodes.length==1||function(){b.createElement("a");var a=b.createDocumentFragment();return typeof a.cloneNode=="undefined"||typeof a.createDocumentFragment=="undefined"||typeof a.createElement=="undefined"}()}catch(c){f=!0,j=!0}})();var r={elements:c.elements||"abbr article aside audio bdi canvas data datalist details figcaption figure footer header hgroup mark meter nav output progress section summary time video",shivCSS:c.shivCSS!==!1,supportsUnknownElements:j,shivMethods:c.shivMethods!==!1,type:"default",shivDocument:q,createElement:n,createDocumentFragment:o};a.html5=r,q(b)}(this,b),e._version=d,e._prefixes=n,e._domPrefixes=q,e._cssomPrefixes=p,e.mq=z,e.hasEvent=A,e.testProp=function(a){return H([a])},e.testAllProps=J,e.testStyles=y,e.prefixed=function(a,b,c){return b?J(a,b,c):J(a,"pfx")},g.className=g.className.replace(/(^|\s)no-js(\s|$)/,"$1$2")+(f?" js "+v.join(" "):""),e}(this,this.document),function(a,b,c){function d(a){return"[object Function]"==o.call(a)}function e(a){return"string"==typeof a}function f(){}function g(a){return!a||"loaded"==a||"complete"==a||"uninitialized"==a}function h(){var a=p.shift();q=1,a?a.t?m(function(){("c"==a.t?B.injectCss:B.injectJs)(a.s,0,a.a,a.x,a.e,1)},0):(a(),h()):q=0}function i(a,c,d,e,f,i,j){function k(b){if(!o&&g(l.readyState)&&(u.r=o=1,!q&&h(),l.onload=l.onreadystatechange=null,b)){"img"!=a&&m(function(){t.removeChild(l)},50);for(var d in y[c])y[c].hasOwnProperty(d)&&y[c][d].onload()}}var j=j||B.errorTimeout,l=b.createElement(a),o=0,r=0,u={t:d,s:c,e:f,a:i,x:j};1===y[c]&&(r=1,y[c]=[]),"object"==a?l.data=c:(l.src=c,l.type=a),l.width=l.height="0",l.onerror=l.onload=l.onreadystatechange=function(){k.call(this,r)},p.splice(e,0,u),"img"!=a&&(r||2===y[c]?(t.insertBefore(l,s?null:n),m(k,j)):y[c].push(l))}function j(a,b,c,d,f){return q=0,b=b||"j",e(a)?i("c"==b?v:u,a,b,this.i++,c,d,f):(p.splice(this.i++,0,a),1==p.length&&h()),this}function k(){var a=B;return a.loader={load:j,i:0},a}var l=b.documentElement,m=a.setTimeout,n=b.getElementsByTagName("script")[0],o={}.toString,p=[],q=0,r="MozAppearance"in l.style,s=r&&!!b.createRange().compareNode,t=s?l:n.parentNode,l=a.opera&&"[object Opera]"==o.call(a.opera),l=!!b.attachEvent&&!l,u=r?"object":l?"script":"img",v=l?"script":u,w=Array.isArray||function(a){return"[object Array]"==o.call(a)},x=[],y={},z={timeout:function(a,b){return b.length&&(a.timeout=b[0]),a}},A,B;B=function(a){function b(a){var a=a.split("!"),b=x.length,c=a.pop(),d=a.length,c={url:c,origUrl:c,prefixes:a},e,f,g;for(f=0;f ul li.current').removeClass('current'); + parent_li.toggleClass('current'); +} + +$(document).ready(function() { + // Shift nav in mobile when clicking the menu. + $(document).on('click', "[data-toggle='wy-nav-top']", function() { + $("[data-toggle='wy-nav-shift']").toggleClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + }); + // Nav menu link click operations + $(document).on('click', ".wy-menu-vertical .current ul li a", function() { + var target = $(this); + // Close menu when you click a link. + $("[data-toggle='wy-nav-shift']").removeClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + // Handle dynamic display of l3 and l4 nav lists + toggleCurrent(target); + if (typeof(window.SphinxRtdTheme) != 'undefined') { + window.SphinxRtdTheme.StickyNav.hashChange(); + } + }); + $(document).on('click', "[data-toggle='rst-current-version']", function() { + $("[data-toggle='rst-versions']").toggleClass("shift-up"); + }); + // Make tables responsive + $("table.docutils:not(.field-list)").wrap("
"); + + // Add expand links to all parents of nested ul + $('.wy-menu-vertical ul').siblings('a').each(function () { + var link = $(this); + expand = $(''); + expand.on('click', function (ev) { + toggleCurrent(link); + ev.stopPropagation(); + return false; + }); + link.prepend(expand); + }); +}); + +// Sphinx theme state +window.SphinxRtdTheme = (function (jquery) { + var stickyNav = (function () { + var navBar, + win, + winScroll = false, + linkScroll = false, + winPosition = 0, + enable = function () { + init(); + reset(); + win.on('hashchange', reset); + + // Set scrolling + win.on('scroll', function () { + if (!linkScroll) { + winScroll = true; + } + }); + setInterval(function () { + if (winScroll) { + winScroll = false; + var newWinPosition = win.scrollTop(), + navPosition = navBar.scrollTop(), + newNavPosition = navPosition + (newWinPosition - winPosition); + navBar.scrollTop(newNavPosition); + winPosition = newWinPosition; + } + }, 25); + }, + init = function () { + navBar = jquery('nav.wy-nav-side:first'); + win = jquery(window); + }, + reset = function () { + // Get anchor from URL and open up nested nav + var anchor = encodeURI(window.location.hash); + if (anchor) { + try { + var link = $('.wy-menu-vertical') + .find('[href="' + anchor + '"]'); + $('.wy-menu-vertical li.toctree-l1 li.current') + .removeClass('current'); + link.closest('li.toctree-l2').addClass('current'); + link.closest('li.toctree-l3').addClass('current'); + link.closest('li.toctree-l4').addClass('current'); + } + catch (err) { + console.log("Error expanding nav for anchor", err); + } + } + }, + hashChange = function () { + linkScroll = true; + win.one('hashchange', function () { + linkScroll = false; + }); + }; + jquery(init); + return { + enable: enable, + hashChange: hashChange + }; + }()); + return { + StickyNav: stickyNav + }; +}($)); diff --git a/documentation/_build/html/_static/minus.png b/documentation/_build/html/_static/minus.png new file mode 100644 index 00000000..da1c5620 Binary files /dev/null and b/documentation/_build/html/_static/minus.png differ diff --git a/documentation/_build/html/_static/plus.png b/documentation/_build/html/_static/plus.png new file mode 100644 index 00000000..b3cb3742 Binary files /dev/null and b/documentation/_build/html/_static/plus.png differ diff --git a/documentation/_build/html/_static/pygments.css b/documentation/_build/html/_static/pygments.css new file mode 100644 index 00000000..68e7c8c8 --- /dev/null +++ b/documentation/_build/html/_static/pygments.css @@ -0,0 +1,46 @@ +div.codeblock, div[class^="highlight"] { + font-family: "courrier", "andale mono", monospace; + font-size: 90%; + white-space: pre; +/* + margin: 10pt; +*/ + padding: 1px 10pt 1px 10pt; + margin: 0pt; + border: none; + background-color: #fcfce1; + } +.codeblock * .hll, [class^="highlight"] * .hll { background-color: #fcfce1 } +.codeblock * .c , [class^="highlight"] * .c { color: black } /* Comment */ +.codeblock * .err, [class^="highlight"] * .err { border: 1px solid #FF0000 } /* Error */ +.codeblock * .k , [class^="highlight"] * .k { color: black; font-weight: bold } /* Keyword */ +.codeblock * .cm , [class^="highlight"] * .cm { color: black; font-style: italic } /* Comment.Multiline */ +.codeblock * .cp , [class^="highlight"] * .cp { color: black; font-style: italic } /* Comment.Preproc */ +.codeblock * .c1 , [class^="highlight"] * .c1 { color: black; font-style: italic } /* Comment.Single */ +.codeblock * .cs , [class^="highlight"] * .cs { color: black; font-style: italic } /* Comment.Special */ +.codeblock * .ge , [class^="highlight"] * .ge { font-style: italic } /* Generic.Emph */ +.codeblock * .gh , [class^="highlight"] * .gh { font-weight: bold } /* Generic.Heading */ +.codeblock * .gp , [class^="highlight"] * .gp { font-weight: bold } /* Generic.Prompt */ +.codeblock * .gs , [class^="highlight"] * .gs { font-weight: bold } /* Generic.Strong */ +.codeblock * .gu , [class^="highlight"] * .gu { font-weight: bold } /* Generic.Subheading */ +.codeblock * .kc , [class^="highlight"] * .kc { color: black } /* Keyword.Constant */ +.codeblock * .kd , [class^="highlight"] * .kd { color: black } /* Keyword.Declaration */ +.codeblock * .kn , [class^="highlight"] * .kn { color: black } /* Keyword.Namespace */ +.codeblock * .kp , [class^="highlight"] * .kp { color: black } /* Keyword.Pseudo */ +.codeblock * .kr , [class^="highlight"] * .kr { color: black } /* Keyword.Reserved */ +.codeblock * .kt , [class^="highlight"] * .kt { color: black } /* Keyword.Type */ +.codeblock * .s , [class^="highlight"] * .s { color: black } /* Literal.String */ +.codeblock * .n , [class^="highlight"] * .n { font-weight: bold; font-style: italic } /* Name.Class */ +.codeblock * .nc , [class^="highlight"] * .nc { color: black } /* Name.Class */ +.codeblock * .ow , [class^="highlight"] * .ow { color: black } /* Operator.Word */ +.codeblock * .sb , [class^="highlight"] * .sb { color: black } /* Literal.String.Backtick */ +.codeblock * .sc , [class^="highlight"] * .sc { color: black } /* Literal.String.Char */ +.codeblock * .sd , [class^="highlight"] * .sd { color: black } /* Literal.String.Doc */ +.codeblock * .s2 , [class^="highlight"] * .s2 { color: black } /* Literal.String.Double */ +.codeblock * .se , [class^="highlight"] * .se { color: black } /* Literal.String.Escape */ +.codeblock * .sh , [class^="highlight"] * .sh { color: black } /* Literal.String.Heredoc */ +.codeblock * .si , [class^="highlight"] * .si { color: black } /* Literal.String.Interpol */ +.codeblock * .sx , [class^="highlight"] * .sx { color: black } /* Literal.String.Other */ +.codeblock * .sr , [class^="highlight"] * .sr { color: black } /* Literal.String.Regex */ +.codeblock * .s1 , [class^="highlight"] * .s1 { color: black } /* Literal.String.Single */ +.codeblock * .ss , [class^="highlight"] * .ss { color: black } /* Literal.String.Symbol */ diff --git a/documentation/_build/html/_static/searchtools.js b/documentation/_build/html/_static/searchtools.js new file mode 100644 index 00000000..663be4c9 --- /dev/null +++ b/documentation/_build/html/_static/searchtools.js @@ -0,0 +1,560 @@ +/* + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; +} + + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, success: null, + dataType: "script", cache: true}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

').appendTo(this.out); + this.output = $('
    ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; + + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var objectterms = []; + for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || + tmp[i] == "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var fileMap = {}; + var files = null; + // different result priorities + var importantResults = []; + var objectResults = []; + var regularResults = []; + var unimportantResults = []; + $('#search-progress').empty(); + + // lookup as object + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); + } + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine all results + var results = unimportantResults.concat(regularResults) + .concat(objectResults).concat(importantResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
  • '); + if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + listItem.append($('').attr('href', + DOCUMENTATION_OPTIONS.URL_ROOT + dirname + + highlightstring + item[2]).html(item[1])); + } else { + // normal html builders + listItem.append($('').attr('href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + } + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + + item[0] + '.txt', function(data) { + if (data != '') { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + } + listItem.slideDown(5, function() { + displayNextItem(); + }); + }, "text"); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] + } +} + +$(document).ready(function() { + Search.init(); +}); \ No newline at end of file diff --git a/documentation/_build/html/_static/underscore.js b/documentation/_build/html/_static/underscore.js new file mode 100644 index 00000000..5d899143 --- /dev/null +++ b/documentation/_build/html/_static/underscore.js @@ -0,0 +1,23 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ +(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); +return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); +var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; +if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== +0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& +a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, +" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); +o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); diff --git a/documentation/_build/html/_static/up-pressed.png b/documentation/_build/html/_static/up-pressed.png new file mode 100644 index 00000000..8bd587af Binary files /dev/null and b/documentation/_build/html/_static/up-pressed.png differ diff --git a/documentation/_build/html/_static/up.png b/documentation/_build/html/_static/up.png new file mode 100644 index 00000000..b9462568 Binary files /dev/null and b/documentation/_build/html/_static/up.png differ diff --git a/documentation/_build/html/_static/websupport.js b/documentation/_build/html/_static/websupport.js new file mode 100644 index 00000000..e9bd1b85 --- /dev/null +++ b/documentation/_build/html/_static/websupport.js @@ -0,0 +1,808 @@ +/* + * websupport.js + * ~~~~~~~~~~~~~ + * + * sphinx.websupport utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +(function($) { + $.fn.autogrow = function() { + return this.each(function() { + var textarea = this; + + $.fn.autogrow.resize(textarea); + + $(textarea) + .focus(function() { + textarea.interval = setInterval(function() { + $.fn.autogrow.resize(textarea); + }, 500); + }) + .blur(function() { + clearInterval(textarea.interval); + }); + }); + }; + + $.fn.autogrow.resize = function(textarea) { + var lineHeight = parseInt($(textarea).css('line-height'), 10); + var lines = textarea.value.split('\n'); + var columns = textarea.cols; + var lineCount = 0; + $.each(lines, function() { + lineCount += Math.ceil(this.length / columns) || 1; + }); + var height = lineHeight * (lineCount + 1); + $(textarea).css('height', height); + }; +})(jQuery); + +(function($) { + var comp, by; + + function init() { + initEvents(); + initComparator(); + } + + function initEvents() { + $('a.comment-close').live("click", function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }); + $('a.vote').live("click", function(event) { + event.preventDefault(); + handleVote($(this)); + }); + $('a.reply').live("click", function(event) { + event.preventDefault(); + openReply($(this).attr('id').substring(2)); + }); + $('a.close-reply').live("click", function(event) { + event.preventDefault(); + closeReply($(this).attr('id').substring(2)); + }); + $('a.sort-option').live("click", function(event) { + event.preventDefault(); + handleReSort($(this)); + }); + $('a.show-proposal').live("click", function(event) { + event.preventDefault(); + showProposal($(this).attr('id').substring(2)); + }); + $('a.hide-proposal').live("click", function(event) { + event.preventDefault(); + hideProposal($(this).attr('id').substring(2)); + }); + $('a.show-propose-change').live("click", function(event) { + event.preventDefault(); + showProposeChange($(this).attr('id').substring(2)); + }); + $('a.hide-propose-change').live("click", function(event) { + event.preventDefault(); + hideProposeChange($(this).attr('id').substring(2)); + }); + $('a.accept-comment').live("click", function(event) { + event.preventDefault(); + acceptComment($(this).attr('id').substring(2)); + }); + $('a.delete-comment').live("click", function(event) { + event.preventDefault(); + deleteComment($(this).attr('id').substring(2)); + }); + $('a.comment-markup').live("click", function(event) { + event.preventDefault(); + toggleCommentMarkupBox($(this).attr('id').substring(2)); + }); + } + + /** + * Set comp, which is a comparator function used for sorting and + * inserting comments into the list. + */ + function setComparator() { + // If the first three letters are "asc", sort in ascending order + // and remove the prefix. + if (by.substring(0,3) == 'asc') { + var i = by.substring(3); + comp = function(a, b) { return a[i] - b[i]; }; + } else { + // Otherwise sort in descending order. + comp = function(a, b) { return b[by] - a[by]; }; + } + + // Reset link styles and format the selected sort option. + $('a.sel').attr('href', '#').removeClass('sel'); + $('a.by' + by).removeAttr('href').addClass('sel'); + } + + /** + * Create a comp function. If the user has preferences stored in + * the sortBy cookie, use those, otherwise use the default. + */ + function initComparator() { + by = 'rating'; // Default to sort by rating. + // If the sortBy cookie is set, use that instead. + if (document.cookie.length > 0) { + var start = document.cookie.indexOf('sortBy='); + if (start != -1) { + start = start + 7; + var end = document.cookie.indexOf(";", start); + if (end == -1) { + end = document.cookie.length; + by = unescape(document.cookie.substring(start, end)); + } + } + } + setComparator(); + } + + /** + * Show a comment div. + */ + function show(id) { + $('#ao' + id).hide(); + $('#ah' + id).show(); + var context = $.extend({id: id}, opts); + var popup = $(renderTemplate(popupTemplate, context)).hide(); + popup.find('textarea[name="proposal"]').hide(); + popup.find('a.by' + by).addClass('sel'); + var form = popup.find('#cf' + id); + form.submit(function(event) { + event.preventDefault(); + addComment(form); + }); + $('#s' + id).after(popup); + popup.slideDown('fast', function() { + getComments(id); + }); + } + + /** + * Hide a comment div. + */ + function hide(id) { + $('#ah' + id).hide(); + $('#ao' + id).show(); + var div = $('#sc' + id); + div.slideUp('fast', function() { + div.remove(); + }); + } + + /** + * Perform an ajax request to get comments for a node + * and insert the comments into the comments tree. + */ + function getComments(id) { + $.ajax({ + type: 'GET', + url: opts.getCommentsURL, + data: {node: id}, + success: function(data, textStatus, request) { + var ul = $('#cl' + id); + var speed = 100; + $('#cf' + id) + .find('textarea[name="proposal"]') + .data('source', data.source); + + if (data.comments.length === 0) { + ul.html('
  • No comments yet.
    • '); + ul.data('empty', true); + } else { + // If there are comments, sort them and put them in the list. + var comments = sortComments(data.comments); + speed = data.comments.length * 100; + appendComments(comments, ul); + ul.data('empty', false); + } + $('#cn' + id).slideUp(speed + 200); + ul.slideDown(speed); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem retrieving the comments.'); + }, + dataType: 'json' + }); + } + + /** + * Add a comment via ajax and insert the comment into the comment tree. + */ + function addComment(form) { + var node_id = form.find('input[name="node"]').val(); + var parent_id = form.find('input[name="parent"]').val(); + var text = form.find('textarea[name="comment"]').val(); + var proposal = form.find('textarea[name="proposal"]').val(); + + if (text == '') { + showError('Please enter a comment.'); + return; + } + + // Disable the form that is being submitted. + form.find('textarea,input').attr('disabled', 'disabled'); + + // Send the comment to the server. + $.ajax({ + type: "POST", + url: opts.addCommentURL, + dataType: 'json', + data: { + node: node_id, + parent: parent_id, + text: text, + proposal: proposal + }, + success: function(data, textStatus, error) { + // Reset the form. + if (node_id) { + hideProposeChange(node_id); + } + form.find('textarea') + .val('') + .add(form.find('input')) + .removeAttr('disabled'); + var ul = $('#cl' + (node_id || parent_id)); + if (ul.data('empty')) { + $(ul).empty(); + ul.data('empty', false); + } + insertComment(data.comment); + var ao = $('#ao' + node_id); + ao.find('img').attr({'src': opts.commentBrightImage}); + if (node_id) { + // if this was a "root" comment, remove the commenting box + // (the user can get it back by reopening the comment popup) + $('#ca' + node_id).slideUp(); + } + }, + error: function(request, textStatus, error) { + form.find('textarea,input').removeAttr('disabled'); + showError('Oops, there was a problem adding the comment.'); + } + }); + } + + /** + * Recursively append comments to the main comment list and children + * lists, creating the comment tree. + */ + function appendComments(comments, ul) { + $.each(comments, function() { + var div = createCommentDiv(this); + ul.append($(document.createElement('li')).html(div)); + appendComments(this.children, div.find('ul.comment-children')); + // To avoid stagnating data, don't store the comments children in data. + this.children = null; + div.data('comment', this); + }); + } + + /** + * After adding a new comment, it must be inserted in the correct + * location in the comment tree. + */ + function insertComment(comment) { + var div = createCommentDiv(comment); + + // To avoid stagnating data, don't store the comments children in data. + comment.children = null; + div.data('comment', comment); + + var ul = $('#cl' + (comment.node || comment.parent)); + var siblings = getChildren(ul); + + var li = $(document.createElement('li')); + li.hide(); + + // Determine where in the parents children list to insert this comment. + for(i=0; i < siblings.length; i++) { + if (comp(comment, siblings[i]) <= 0) { + $('#cd' + siblings[i].id) + .parent() + .before(li.html(div)); + li.slideDown('fast'); + return; + } + } + + // If we get here, this comment rates lower than all the others, + // or it is the only comment in the list. + ul.append(li.html(div)); + li.slideDown('fast'); + } + + function acceptComment(id) { + $.ajax({ + type: 'POST', + url: opts.acceptCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + $('#cm' + id).fadeOut('fast'); + $('#cd' + id).removeClass('moderate'); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem accepting the comment.'); + } + }); + } + + function deleteComment(id) { + $.ajax({ + type: 'POST', + url: opts.deleteCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + var div = $('#cd' + id); + if (data == 'delete') { + // Moderator mode: remove the comment and all children immediately + div.slideUp('fast', function() { + div.remove(); + }); + return; + } + // User mode: only mark the comment as deleted + div + .find('span.user-id:first') + .text('[deleted]').end() + .find('div.comment-text:first') + .text('[deleted]').end() + .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) + .remove(); + var comment = div.data('comment'); + comment.username = '[deleted]'; + comment.text = '[deleted]'; + div.data('comment', comment); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem deleting the comment.'); + } + }); + } + + function showProposal(id) { + $('#sp' + id).hide(); + $('#hp' + id).show(); + $('#pr' + id).slideDown('fast'); + } + + function hideProposal(id) { + $('#hp' + id).hide(); + $('#sp' + id).show(); + $('#pr' + id).slideUp('fast'); + } + + function showProposeChange(id) { + $('#pc' + id).hide(); + $('#hc' + id).show(); + var textarea = $('#pt' + id); + textarea.val(textarea.data('source')); + $.fn.autogrow.resize(textarea[0]); + textarea.slideDown('fast'); + } + + function hideProposeChange(id) { + $('#hc' + id).hide(); + $('#pc' + id).show(); + var textarea = $('#pt' + id); + textarea.val('').removeAttr('disabled'); + textarea.slideUp('fast'); + } + + function toggleCommentMarkupBox(id) { + $('#mb' + id).toggle(); + } + + /** Handle when the user clicks on a sort by link. */ + function handleReSort(link) { + var classes = link.attr('class').split(/\s+/); + for (var i=0; iThank you! Your comment will show up ' + + 'once it is has been approved by a moderator.'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
    \ +

    \ + Sort by:\ + best rated\ + newest\ + oldest\ +

    \ +
    Comments
    \ +
    \ + loading comments...
    \ +
      \ +
      \ +

      Add a comment\ + (markup):

      \ +
      \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
      \ +
      \ + \ +

      \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

      \ + \ + \ + \ + \ +
      \ +
      \ +
      '; + + var commentTemplate = '\ +
      \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ +
      \ +

      \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

      \ +
      <#text#>
      \ +

      \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

      \ + 
      \
+<#proposal_diff#>\
+
      \ +
        \ +
        \ +
        \ +
        \ + '; + + var replyTemplate = '\ +
      • \ +
        \ +
        \ + \ + \ + \ + \ + \ +
        \ +
        \ +
        • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/documentation/etc/SoC.css b/documentation/_build/html/_static/www-SoC.css similarity index 89% rename from documentation/etc/SoC.css rename to documentation/_build/html/_static/www-SoC.css index 345b5f44..c4c864bd 100644 --- a/documentation/etc/SoC.css +++ b/documentation/_build/html/_static/www-SoC.css @@ -1,8 +1,8 @@ -/* -*- Mode: css -*- */ +/* -*- Mode: css; explicit-buffer-name: "www-SoC.css" -*- */ /*@media (max-resolution: 150dpi) {*/ - body { font-size: 9pt; } +/*body { font-size: 9pt; }*/ p#lip6 { font-size: 14pt; } p#soc { font-size: 28pt; } /* @@ -16,6 +16,7 @@ */ +/* body { font-family: "Open Sans", verdana, sans-serif; margin-left: auto; @@ -23,18 +24,22 @@ body { margin-top: 20pt; margin-bottom: 20pt; padding-top: 0pt; - padding-bottom: 0pt; + padding-bottom: 30pt; padding-left: 30pt; padding-right: 30pt; width: 580pt; - background-color: #f5f5f5; + background-color: white; + */ +/*background-color: #f5f5f5;*/ /*background: #f5f5f5 url('../images/flowers-abstract-grey.png') repeat;*/ /*background: #f5f5f5 url('../images/layout-motif-faded-2.png') repeat;*/ +/* background-size: 20%; -moz-box-shadow: 0px 0px 5px 5px #ccc; -webkit-box-shadow: 0px 0px 5px 5px #ccc; box-shadow: 0px 0px 5px 5px #ccc; } +*/ ul { list-style-type: square; @@ -56,6 +61,11 @@ h1 { /*font-family: "adelle", Georgia, "Times New Roman", serif;*/ } +h2, h3, h4 { + font-family: "URW Bookman L", serif; + font-weight: bold; +} + h1.title { text-align: center; font-size: 140%; @@ -456,12 +466,12 @@ div#footer { table.footer1, table.footer2 { width: 100%; border: 0px; } -td.LFooter { text-align: left; border: 0px; } -td.RFooter { text-align: right; border: 0px; } +td.LFooter { text-align: left; border: 0px; padding-left: 0px; } +td.RFooter { text-align: right; border: 0px; padding-right: 0px; } td.CFooter { text-align: center;} table.footer2 td.RFooter { font-weight: bold; width: 35%; border: 0px; } -table.footer2 td.CFooter { width: 30%; border: 0px; } table.footer2 td.LFooter { font-weight: bold; width: 35%; border: 0px; } +table.footer2 td.CFooter { width: 30%; border: 0px; } div.tx-felogin-pi1 { border: 0px; @@ -530,7 +540,28 @@ div.tx-felogin-pi1 > form > fieldset > div > label { color: white; background-color: black; padding: 4pt 10pt; - font-family: "URW Bookman L", serif; - font-size: 120%; - font-weight: bold; + font-family: "URW Bookman L", serif; + font-size: 120%; + font-weight: bold; } + +body.gsummary h1 { + padding-top: 40pt; + padding-bottom: 30pt; + font-size: 200%; +} + +body.gsummary table { + border-collapse: collapse; + border-color: transparent; + border: 0px; + width: 80%; + margin-left: auto; + margin-right: auto; +} + +body.gsummary table td { + border: none; +} + +@import 'SoC-ReST.css'; diff --git a/documentation/_build/html/etc/definitions.html b/documentation/_build/html/etc/definitions.html new file mode 100644 index 00000000..62f31fd5 --- /dev/null +++ b/documentation/_build/html/etc/definitions.html @@ -0,0 +1,320 @@ + + + + + + + + + + + + <no title> — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + +
        + + + + + + +
        +
        +
        +
          +
        • Docs »
          • + +
        • <no title>
          • +
        • + + + +
          • +
        +
        +
        +
        + + + +
        +
        + + +
        + +
        + + + + + +
        + Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
        + + + + + +
        Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
        +
        + +
        + +
        +
        + +
        + +
        + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/genindex.html b/documentation/_build/html/genindex.html new file mode 100644 index 00000000..5716ae9a --- /dev/null +++ b/documentation/_build/html/genindex.html @@ -0,0 +1,328 @@ + + + + + + + + + + + + + + Index — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + +
        + + + + + + +
        +
        +
        +
          +
        • Docs »
          • + +
        • +
        • + + + +
          • +
        +
        +
        +
        + + +

        Index

        + +
        + +
        + + +
        +
        + + +
        + +
        + + + + + +
        + Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
        + + + + + +
        Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
        +
        + +
        + +
        +
        + +
        + +
        + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/index.html b/documentation/_build/html/index.html new file mode 100644 index 00000000..48fd40e4 --- /dev/null +++ b/documentation/_build/html/index.html @@ -0,0 +1,385 @@ + + + + + + + + + + + + Overview — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + +
        + + + + + + +
        +
        +
        +
          +
        • Docs »
          • + +
        • +
        • + + + +
          • +
        +
        +
        +
        + +

        Coriolis 2 documentation

        +

        + + Documentation generated on Jul 17, 2017. +

        + +

        Documentation Topics

        + + + + + + + + +
        +

        Coriolis User's Guide
        + Using the software

        +         		+

        Hurricane Reference
        + Hurricane Netlist & Physical data-structure C++ API

        +
        +

        Stratus Language
        + A Netlist Capture Language (on top of Python)

        +         		+

        Viewer Reference
        + Graphical Interface C++ API

        +
        +

        DpGen Extension (Stratus)
        + Netlist Capture extension for Datapathes

        +         		+

        CRL Core Reference
        + Parser/Drivers (I/O) C++ API

        +
        +

        Patterns Extension (Stratus)
        + Patterns generation extension

        +         		+

        Unicorn Reference
        + Main GUI C++ API

        +
        + +

        Katabatic Reference
        + Articulated Segments Data-Structure

        +
        + +

        Kite Reference
        + Digital Router

        +
        + +

        Coriolis Python/C API
        + Tutorial for C/C++ programmers

        +
        + +

        Indices and Tables

        + + +
        +

        General Index
        + All functions, classes, terms

        +         		+

        Search page
        + Search this documentation

        +

        Complete Table of Contents
        Lists all sections and subsections

        +
        + + +
        +
        + + +
        + +
        + + + + + +
        + Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
        + + + + + +
        Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
        +
        + +
        + +
        +
        + +
        + +
        + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/objects.inv b/documentation/_build/html/objects.inv new file mode 100644 index 00000000..b18ac5e1 Binary files /dev/null and b/documentation/_build/html/objects.inv differ diff --git a/documentation/_build/html/search.html b/documentation/_build/html/search.html new file mode 100644 index 00000000..59eb286a --- /dev/null +++ b/documentation/_build/html/search.html @@ -0,0 +1,337 @@ + + + + + + + + + + + Search — Coriolis 2 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + +
        + + + + + + +
        +
        +
        +
          +
        • Docs »
          • + +
        • +
        • + +
          • +
        +
        +
        +
        + + + + +
        + +
        + +
        +
        + + +
        + +
        + + + + + +
        + Generated by Sphinx + using a RTD theme on Jul 17, 2017. +
        + + + + + +
        Coriolis 2 Documentation + © Copyright 2000-2017, UPMC. +
        +
        + +
        + +
        +
        + +
        + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/_build/html/searchindex.js b/documentation/_build/html/searchindex.js new file mode 100644 index 00000000..a67d7651 --- /dev/null +++ b/documentation/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({objects:{},terms:{linebreak:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],represent:22,four:[2,6,22,18],addtyp:[6,27],py_library_h:6,dpgen:[9,5,28],whose:13,lgpl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],isobar:[23,16,17,6,27,8],phfig:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],concret:27,under:[9,6,14,3,22,28,17,18,13,20],spec:14,nwell:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],everi:[6,22,13],risk:18,"void":[6,27,8],rise:18,"r\u00e9my":3,placerengin:2,cmo:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],disturb:2,p_i3:2,fc_64:14,prefix:[2,22,18],correct:22,pyinclud:23,initialis:[9,13,14,22,12,6,28],pck_px:2,vhdl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],direct:[13,22,17,18,6,27,8],yacc:14,consequ:[27,20,18],second:[9,14,22,17,18,12,13,28],even:[2,20,18],asim:14,hide:22,asid:[2,13],pyentity_o:27,dbolinkcreatemethod:[6,27,8],blur:22,"new":[14,2,22,6,27,8],net:[27,2,13,22,17],topolog:22,liberti:22,behavior:[6,17,8],catal:13,spacemargin:[13,22],here:[0,13,10,17,14,1,22,25,4,5,11,18,7,6,26],undef:27,path:[13,22],interpret:2,p_q0:2,p_q3:2,anymor:18,precis:17,credit:[9,3,28,12],drc:18,crlcore:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],strap:22,pytypeobjectdefinit:[6,8],bashrc:14,total:22,unit:[22,17,16,18],clocktre:[2,13],pyarg_parsetupl:[17,6,16,8],would:[13,17,16],program:[6,17],call:[14,2,22,16,17,6,27,8],until:22,python27:14,type:[9,13,14,2,22,23,6,27,28],tell:[14,2,6,13,18],kgr:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],p_ck:2,successful:22,remark:[27,13,22],relat:[27,13,22,8],warn:17,mbk_to_rds_via:[9,15,28,18],hole:18,hold:[27,22,17],must:[13,14,2,22,23,17,18,6,27],globalripuplimit:22,pyentity_method:27,setup:[6,13],sxlib:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],wors:22,root:[14,6,13,17],give:[27,22,23,20,18],indic:9,pycontact_o:27,want:[13,14,22,17,6,27],pytypecontact:27,gigant:17,end:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],hoc:[22,20],eng:3,ispyvert:27,ordinari:[2,13],typepercentag:[13,22],how:[13,22,18],ent:27,isobar_py_point_h:8,gate:[22,18],updat:6,after:[14,2,6,22],befor:22,pytype_ready_sub:27,parallel:14,micromet:18,rhel6:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],rhel7:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],attempt:16,third:[14,18],bootstrap:14,alias:22,maintain:22,environ:[14,9,13,28,12],enter:22,lambda:[9,15,28,18],order:[14,2,13,22],origin:[22,17,18],over:[16,18],becaus:[14,27,22,20,18],pyerr_setstr:[17,6,27,16,8],directli:[2,22,17],fit:22,generic_method_head:[6,27,8],fix:[9,14,22,18,12,28],stratus2:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],stratus1:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],rsave:[9,2,28],py_incref:[6,27],persist:17,hidden:20,easier:18,"_clock":[2,13],them:[14,2,22,17,18,6],iowa:3,thei:[13,2,22,17,18,6,20],proce:14,rectangl:18,allianceconfig:13,interrupt:6,choic:[9,28,17,24],ispyent:27,cont_body_p:18,cont_body_n:18,arrow:22,each:[13,2,22,17,18,6,8],debug:[14,22],side:[2,22,18],mean:[14,13,22,17,18],monolith:17,vlsisapd:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],ommit:22,extract:6,p_vssick0:2,unbound:16,goe:17,content:[9,13,2,28,6,27,20],rewrit:[20,17],adapt:2,knik:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],linear:22,"_tr":2,free:22,standard:[13,22,8,17,6,20],techno:[13,18],"_tl":2,stratu:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],hand:18,standart:2,rds_poli:18,filter:[9,22,28],unabl:14,temporari:22,pytype_readi:[6,27],render:22,clariti:27,system:[14,13],restrict:22,hook:[14,9,6,28,12],instruct:[14,22],alreadi:[13,22,17],ptie:18,ditch:22,ram_clock:2,rewritten:20,top:[14,2,22],master:[14,22,17],too:[22,17,18],outad:14,namespac:[9,23,24,28,17,6,27,8],tool:[9,14,2,3,22,28,17,18,12,13,20],tee:22,ntie:18,p_b0:2,p_b3:2,p_b2:2,technic:[9,28,17,24],silli:18,target:18,provid:[13,14,2,22,16,17,6],tree:[9,14,2,17,12,27,28],pycel:[6,27],"final":[14,22,18],project:14,minut:22,htry:[17,6,27,16,8],pynet:[27,17],fashion:17,ram:2,hypernet:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],"__main__":2,seen:6,seem:[14,18],dozen:22,pypoint_seti:8,simplifi:14,though:17,trought:13,object:[13,22,16,17,18,6,27,8],pyobject_new:8,regular:[13,22],lybrari:6,insul:6,everyth:[6,22,13],don:[14,2,6],simplif:14,doc:[14,8],metal:[22,18],doe:6,dummi:[14,2],pylibrari:[6,23,17],dochip:2,dot:[22,20],routabl:22,has_kei:2,speedup:20,syntax:6,chaput:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],absolut:8,layout:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],menu:22,configur:[9,14,2,22,23,24,28,18,12,13,20],cougar:18,ocp:18,pynet_o:17,rds_nimp:18,stop:[2,22],scale_x:13,envenli:22,"public":20,cleanli:6,bad:27,gaug:[22,18],mandatori:[6,13],result:[6,22,13,17],respons:[6,22],fail:[6,27],charact:13,best:[22,8],subject:22,c2r:14,awar:[14,22,18],databas:[6,22,20,17],figur:[22,18],pyentity_new:27,pyentiti:27,finger:22,simplest:13,drawn:22,cellview:22,attribut:[27,8],accord:[2,13,22,18],hcatch:[17,6,27,16,8],extend:18,weak:22,extens:[1,5,22,20],extent:[2,13,22],dbodeletemethod:[6,27],cont_poli:18,howev:[13,22],against:[14,6,22,17],logic:[10,22,20],com:14,cyclop:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],trunk:13,height:[27,22,17,18],cont_via:18,bigvia:18,wider:22,guid:[9,28,12],assum:22,pycontact_getwidth:27,three:[6,22,23,18],been:[13,2,22,17,6,20],much:[13,22,17],katabat:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27],alux:18,hesit:2,life:[8,18],deeper:27,suppress:22,argument:[13,14,2,22,16,6,27],craft:2,pycomponent_link:27,"catch":6,ident:[27,13,22],gnu:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],properti:6,aim:20,commpos:22,seven:22,printabl:[12,15,24],have:[13,14,2,22,20,17,18,6,27,8],applic:22,tabl:[9,13,15,18,6,28],pharo:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],kwarg:8,conf:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],tediou:14,sever:[22,17],p_zero:2,perform:[14,2,6,22],make:[14,3,22,6,18],transpar:18,quadtre:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],split:[2,22,17],synch:22,complet:[13,14,2,22,15,23,17,6,20],rail:2,kit:10,fairli:22,unicorn:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],aspectratio:[13,22],"supp\u00e9rior":2,redefin:[13,27],kept:18,thu:[6,22,13],inherit:6,contact:[27,22,17,18],thi:[13,14,2,22,15,24,20,17,18,12,6,27,8],endif:[6,27,17,8],jean:3,paradigm:13,left:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],dl_export:[6,27],identifi:[2,13,22],just:[14,22,16,17,18,13],yet:[14,27,22],languag:[1,2,22,4,5,13,20],previous:[2,6,27],belloeil:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],yifei:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],expos:[6,17],expor:22,had:18,macport:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],cellstop:[14,13],els:[17,6,27,13,8],save:[9,2,22,28,6,27,20],explanatori:6,opt:14,lcw:18,latex2html:[14,5,1,4],background:22,typerul:13,blockag:[13,18],specif:[2,6,22,13],filenam:13,manual:[14,22,17],zoom:22,vdd:13,typetab:13,rds_activ:18,pdif:18,underli:17,www:14,right:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],old:[20,17],maxim:22,percentag:13,intern:2,sure:2,flatten:[2,22],pvddeck_px:2,indirect:27,successfulli:[14,22],transmiss:17,bottom:[2,18],rds_via1:18,rds_via2:18,rds_via3:18,rds_via4:18,rds_via5:18,multipli:18,track_spacing_alu8:18,track_spacing_alu4:18,track_spacing_alu5:18,track_spacing_alu6:18,track_spacing_alu7:18,track_spacing_alu1:18,track_spacing_alu2:18,track_spacing_alu3:18,core:[9,14,2,22,25,17,28],"2\u00b5m":18,pystring_asstr:6,repositori:[14,20],gouvin:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],nimbu:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],describ:[2,13,18],lauch:2,simul:[2,20],commit:14,soc:[14,13],mbk:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],"float":13,bound:[13,22],down:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],track_width_alu2:18,track_width_alu1:18,track_width_alu7:18,track_width_alu6:18,track_width_alu5:18,track_width_alu4:18,wrap:[6,23,17],track_width_alu8:18,east:2,accordingli:17,git:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],wai:[2,22,16,17,18,6],support:[14,22,23,8,17,6,20],transform:[6,18],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],avail:[0,10,17,14,1,25,4,5,11,7,13,26,20],stuck:18,reli:[14,22,17,18],editor:[2,22,18],disambigu:18,overhang:18,analysi:22,head:[9,6,13,28],form:[13,22],forc:[2,6,22],armi:22,"true":[2,13,22,18],reset:[6,22],pydatabse_o:6,maximum:22,x_grid:18,minor:[13,22],w8_64:14,retir:2,featur:22,classic:[13,17],"abstract":27,ripup:22,exist:[13,22],ship:20,ispycontact:27,check:22,assembl:13,p_r0:2,p_r3:2,when:[14,2,22,16,17,18,13],getstr:22,cont_via2:18,cont_via3:18,cont_via4:18,cont_via5:18,tie:18,implant:18,intend:22,consid:[23,18],longer:[22,17],anywher:22,flag:[22,18],geometr:[2,18],time:[27,22,17],cont_viax:18,phseg:18,completli:[22,20,17],global:[9,13,22,28,18,6,20],whitout:22,ispypoint:8,lepka:[14,2],hierarch:[2,22,18],recommand:22,depend:[14,2,23,20,18],pycontact_method:27,p_ng:2,intermedi:[9,27,28,24],cobject:16,tp_new:8,p_np:2,sourc:[14,22,20,18],string:[6,13],congest:22,cont_dif_p:18,pxlib:13,cont_dif_n:18,brows:[13,22],amd2901:2,level:[13,14,2,22,16,17,18,6,27],did:[22,17],gui:14,iter:22,item:22,unsupport:22,team:14,p_vsseck1:2,p_vsseck0:2,typedoubl:13,upper:[22,18],work:[14,2,6,22],pycomponent_getnet:27,sign:13,cost:22,pyseg:27,port:[14,20],appear:[6,22],dbu:[28,9,17,16,24],uniform:13,current:[14,2,13,22],"_baseobject":27,boost:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],slot:22,deriv:[9,2,24,28,17,6,27,8],gener:[9,0,10,14,1,2,22,25,4,5,28,11,18,12,7,13,26,20],disclaim:[28,9,15,17,24],modif:[2,22],along:[22,8],pyerr_clear:17,box:[2,22,17],shift:22,extrem:13,directdestroymethod:8,circumv:22,tweak:22,modul:[9,13,14,2,22,23,24,28,17,6,27,8],out_lo:13,pyhurrican:[6,27,23,8],visibl:22,instal:[9,14,22,23,12,13,28],mintracelevel:[13,22],franck:18,memori:[2,22],sake:27,univers:3,coriolisinit:13,suppl:2,deplib:23,connector:18,live:[22,17],checkout:14,capit:6,minim:18,peopl:17,clue:17,visual:[22,18],templat:17,"1\u00b5m":18,graphic:[9,14,2,22,28,12,13,20],getcel:[6,27],whatev:[14,13,22],purpos:22,nearest:2,tp_init:8,encapsul:[9,21,22,16,24,28,6,27,8],stream:22,chip:[9,2,28],stroke:22,meth_noarg:[6,27,8],alwai:[6,22,17],differenti:22,multipl:[22,20,18],write:[2,13,22,17],pure:22,strapripuplimit:22,map:22,dialog:22,max:13,clone:[14,22],lefdef:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],usabl:[8,18],c_x_p:18,routingpad:22,mai:[14,2,22,17,18,13,8],typestr:[2,13,22],data:[9,3,22,13,28],autotool:14,practic:[23,18],explicit:16,predic:6,inform:[22,17,18],cannot:[22,17,18],combin:14,masterlibrari:6,extractor:18,tty:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],nbsp:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pynet_link:27,still:[14,22,15,8,27,20],pointer:[6,27,17,8],dynam:[14,17],entiti:27,pixmap:22,conjunct:22,group:20,thank:[2,22,17],polici:13,getwidth:27,window:[14,13,22],logmod:[13,22],ramlib:13,non:[9,2,24,28,17,6,8],initi:[27,6,22,13],now:[27,22,20],pyinstance_link:17,nor:6,introduct:[9,28,17,24],track_width_alu3:18,term:3,name:[9,13,2,21,22,23,24,17,18,6,27,28],revers:[27,17],separ:[14,2,22,17,18,6],quarter:2,scriptmain:[2,22],y_slice:18,compil:[14,22,17],arg0:[6,16,8],arg1:[6,8],individu:[22,18],borrow:17,year:[22,17],shown:[2,6,18],"100k":22,patli:18,p_i8:2,minipag:3,p_i0:2,p_i1:2,p_i2:2,coriolisconfigur:13,p_i4:2,p_i5:2,p_i6:2,p_i7:2,"goto":22,state:[3,22],migrat:20,million:22,care:[2,22,17],scarri:22,"__c":[6,27,17,8],pvddick_px:2,sysconfdir:13,turn:22,place:[2,22,17],router:[9,3,22,20,18,28],first:[9,13,14,22,23,24,28,17,18,12,6,20],oper:17,globallengththreshold:22,redhat:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],onc:[2,6,22,17],blink:22,"long":[22,16],gdsii:22,ring:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],open:22,size:[2,22,18],given:[13,14,22,17,18,6,27],convent:17,fc13:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],checker:18,pythoncpp:24,white:22,conveni:6,access_class:27,routag:22,copi:[14,22,8],getheight:27,specifi:22,github:14,mostli:[22,23],than:[22,20,17,18],pytypecompon:[27,17],serv:[26,10],wide:13,whithout:[2,13],saturaterp:22,redefinit:27,balanc:22,were:22,posit:[2,22,18],phvia:18,physical_grid:18,pre:22,sai:[14,2,17],ana:10,pytyperootobjectdefinit:27,rectang:18,ani:[14,2,22,17,18,8],pypoint_new:8,repeatedli:22,squar:18,destroi:[6,27,8],moreov:17,note:[9,13,10,14,2,22,28,20,18,12,26,6,27,8],take:[6,22],advis:22,pwell:18,begin:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],printer:22,trace:[6,22],normal:22,buffer:2,price:22,abut:[2,22],pair:2,meth_stat:[6,27],synthesi:[9,22,28],latex:14,renam:2,later:[22,20,8],ispd:22,drive:2,runtim:22,axi:18,width:[27,22,17,18],show:[13,22,17,18],ec322005072076ef53984462fb4a1075c27c7dfd:14,iastat:3,hack:[9,13,28,12],corner:18,ground:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],xml:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],onli:[13,14,2,22,16,17,18,6,27,20],slow:22,ratio:[13,22],activ:[22,18],saturateratio:22,inithurrican:[6,27],ck_htree:2,black:13,thispagestyl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],overwritten:22,variou:[6,22,13,17],get:[13,2,16,17,18,6],directgetlongattribut:[27,16,8],obviou:[22,8],tailor:6,requir:[9,14,2,22,17,13,28],truli:13,i386:14,where:[13,22,23],summari:2,verboselevel2:[13,22],infinit:[14,22],innov:20,enumer:13,enough:2,pycontact_link:[27,17],between:[2,13,22,17,18],"import":[13,2,3,22,17,6,27,20],across:[13,22,18],quadri:2,parent:6,devtoolset:14,pycontact_getheight:27,comp:27,screen:22,style:[6,22],come:22,emit:6,tutori:[9,28,24],mani:[17,18],py_return_non:[27,16],unmov:22,anti:22,"__python_modul":17,poli:18,coupl:22,west:2,invert:18,resolut:22,ispycompon:27,repres:[22,18],those:[13,14,2,22,18,6,27],"case":[9,13,2,22,24,28,20,17,18,6,27,8],thesi:22,amend:13,cast:[6,27],sophi:3,margin:13,ctrl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],cluster:22,p_noe:2,eras:[2,22],am2901:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],develop:[14,22],same:[22,23,17,18,13,27],binari:[14,22],html:14,pad:2,document:[9,14,2,22,15,24,17,12,13,20],driven:13,capabl:[14,2,13,22,17],improv:22,footprint:22,drain:18,macro:[22,23,17,6,27,8],without:[22,18],model:[2,22,20,18],ccb:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],execut:[9,2,13,22,28],gdb:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],aspect:[13,22,17],flavor:[6,8],speed:22,dynamic_cast:27,dbodestroyattribut:[6,27],homedir:13,mbk_wireset:[9,15,28,18],except:6,littl:[22,18],blob:20,real:[9,13,15,18,6,28],around:[2,22,16],avala:[22,20],read:[6,20],ruler:22,swig:17,katana:[26,10],pyhorizont:27,grid:[9,15,28,18],amp:[3,13],througout:18,whitespac:22,pylayer_o:17,integ:13,either:[14,2,6,22,18],output:[22,20],manag:17,p_y0:2,p_y1:2,p_y2:2,p_y3:2,sentinel:[6,27,8],slsoc6x_64:14,netlist:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],definit:[6,27,23],legal:20,evolv:14,exit:[2,22],vtracksreservedloc:22,knife:22,refer:[9,0,10,17,14,1,25,4,5,28,11,18,7,26,20],pypoint_dealloc:8,power:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],tp_repr:6,inspect:22,in_lo:13,found:[14,17],standpoint:18,regexp:13,graal:18,src:14,stand:22,act:23,"32x32":22,allianc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],lastli:[6,8],imcomplet:20,your:[14,22,17],log:22,area:[13,22,18],start:[22,18],compliant:14,interfac:[9,13,2,22,28,17,12,6,20],low:22,pvddick:2,ago:17,tupl:13,bundl:14,corrioli:14,diffus:18,pvssick_px:2,durol:3,pull:14,possibl:[2,6,22,13,18],"default":[14,2,22,18,13,27],symbolic_technolog:13,exacltli:18,expect:[2,13,16],creat:[13,14,2,22,23,17,18,6,27,8],certain:8,deep:20,strongli:22,decreas:22,file:[9,13,24,14,2,22,15,23,28,20,17,18,12,6,27,8],encompass:17,again:[14,6,27],pyvertical_o:27,cnchu:3,event:[14,22],rubber:22,field:[27,6,22,8],valid:[2,6,17],you:[14,2,22,17,18,13],architectur:[14,9,13,28,12],pyentity_destroi:27,pypoint:[16,8],sequenc:22,symbol:[9,13,15,18,12,6,28],ansi:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],track:22,system_librari:13,pylibrary_link:6,dogleg:22,directori:[9,14,20,12,13,28],unselect:22,descript:[27,22],tricki:17,mimic:[6,13],py_initmodul:[6,27],cpp:[6,23,17],escap:22,localripuplimit:22,all:[13,14,2,3,22,17,18,6,20],founder:18,illustr:2,follow:[13,14,2,22,23,17,18,6,27],disk:22,extra:[13,22],init:[6,8],centerend:18,introduc:[14,22],replic:6,far:[15,17],mechan:[6,22,17,8],pyhorizontal_o:27,failur:22,veri:[2,13,22],wirelength:22,realtechno:13,appart:22,list:[14,2,13,22,23],emul:[14,6],"18\u00b5m":18,small:[2,13,22,18],dimens:[22,18],ten:17,pyobject:[17,6,27,16,8],sync:22,etesian:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],zero:[17,18],design:[9,2,22,24,28,17,18,20],masson:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pass:[2,17],p_cout:2,integr:[2,6],what:[6,22,17,18],abc:20,sub:2,clock:[9,2,13,28],section:13,abl:17,pycomponent_getx:27,overload:6,delet:[17,6,22,13,8],version:[14,22,15,24,12,23],pyvert:27,intersect:18,consecut:2,deepli:22,pycomponent_geti:27,method:[13,2,22,16,17,18,6,8],hasn:22,christian:3,directionn:8,behaviour:22,modular:17,shouldn:18,excess:22,modifi:[22,8],valu:[9,13,2,22,15,28,18,6,27,8],search:[9,13],ch_htree_bl_tl:2,prior:22,action:22,narrow:22,via:18,readabl:22,c_x_n:18,dangl:17,select:[9,14,22,12,13,28],mylib:13,regist:[6,23],two:[14,2,22,17,18,13,27,20],taken:17,toggl:22,more:[27,13,22,20,18],reachabl:22,wrapper:[6,13,17],hwidth:2,ital:22,unzoom:22,particular:6,known:22,cach:2,none:[2,22],damien:3,outlin:22,endswith:13,remain:[27,6,22,8],def:[14,2,22],share:[9,13,14,23,28,17,6,27,8],accept:22,minimum:[2,22],rds_pimp:18,romlib:13,xxxx:14,secur:13,rather:22,anoth:17,hugo:3,eplac:22,simpl:[9,2,22,18,12,13,28],reflect:22,catalog:13,plane:2,method_head:[6,27,8],unlink:13,associ:[9,22,23,24,28,17,18,6,27,8],"short":17,postfix:2,pycomponent_o:[27,17],caus:14,checkbox:22,help:14,soon:2,noindent:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pytypepoint:8,paper:22,through:[2,6,22,13,17],hierarchi:[9,2,22,24,27,28],taxonomi:13,suffer:22,out_ph:13,paramet:[9,13,2,22,28,17,6,8],member:20,typedef:[6,27,16,8],compatibilti:20,exact:[14,2],complex:[17,18],clement:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pck:2,good:[22,23],"return":[13,2,22,16,17,6,27,8],framework:[14,20],bigger:22,rds_alu1:18,rds_alu2:18,rds_alu3:18,rds_alu4:18,rds_alu5:18,rds_alu6:18,getobjectid:[6,8],unlik:[14,20],refresh:22,easili:[13,22],achiev:20,compris:22,stechno:2,hard:13,procedur:22,realli:22,connect:[2,22],orient:18,safeti:22,pycontact_linkpytyp:27,print:[9,13,22,28],occurr:27,entitycast:27,advanc:22,pub:14,reason:18,base:[9,6,10,14,3,22,24,28,17,26,13,27,20],constructorerror:[6,17,8],ask:18,defaultstyl:13,launch:[14,2],perhap:22,circuit:20,assign:22,coriolisenv:[14,9,28,12],misc:[13,22],number:[2,22,17,18,6,8],extern:[2,6,27,17,8],alexandr:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],done:[14,6,22,13],construct:8,stabl:14,dp_sxlib:13,typeopt:13,fanci:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],gpl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],superpos:22,differ:[27,13,22,8,18],script:[9,14,2,22,13,28],least:[2,13],dff:2,store:[6,22,16],pypoint_method:8,option:[14,9,6,22,28],appropri:6,pars:27,usersguid:12,dotfil:3,exposur:17,kind:[13,22,18],scheme:[2,22],"_chip":2,remov:[2,22],horizont:[27,2,22,18],pytypeobjectlinkpytypenewinit:8,toward:17,layoutt:13,pycontact_cr:[27,17],comput:[2,13,22,17],beforehand:22,wysiwyg:22,packag:[9,14,2,20,12,28],dedic:27,"null":[17,6,27,16,8],mauka:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],mbk_to_rds_seg:[9,15,28,18],equival:22,pypoint_link:8,odd:[2,18],cdebug:22,pytypeinheritedobjectdefinit:27,also:[14,10,22,18],build:[9,13,14,2,22,23,17,18,12,6,28],distribut:[14,20],previou:[13,22,18],reach:[22,17],miscellan:[9,22,28],most:[13,22],cygwin:14,maco:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],alpha:20,appertur:22,clear:[2,22,8],cover:18,ext:18,part:[9,13,2,22,28,17,18,6,27,8],clean:13,longglobalripuplimit:22,auxsc35:22,"_br":2,slsoc6x:14,p_b1:2,"_bl":2,fine:22,find:[14,13],htracksreservedloc:22,cell:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],copyright:3,paranoid:13,less:[22,17,18],solut:22,factor:[22,20],routingdriven:[13,22],express:[13,22,18],grew:22,hcmos9:13,restart:[2,22],pyvertical_link:27,synthet:[9,2,22,28,20],"__python_module__":[27,17,8],stl:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],common:[13,2,22,17,18,6,20],crl:[9,25,28],pytypelibrari:[6,23],set:[9,13,14,22,23,16,18,12,6,28],art:22,genlib:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],dump:[22,20],see:[13,14,2,22,17,18,6],arg:[17,6,27,16,8],pvsseck:2,close:[2,6,22,13],directsetlongattribut:[16,8],tp_compar:6,won:17,meth_vararg:[6,27,8],altern:[14,13,22,20],signatur:[6,27,17],popup:22,syntact:13,mbk_to_rds_bigvia_met:[9,15,28,18],fgr:22,lowercas:6,distinguish:[22,18],pycontact_destroi:27,pyentity_link:27,struct:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pydatabase_o:6,uint64_t:16,last:[14,6,22,13],ripupcost:22,pypoint_o:8,context:2,pdf:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],whole:[27,2,22,20,18],load:[9,2,22,12,13,28],simpli:18,point:[13,14,2,22,16,17,18,6,8],header:[9,24,8,6,27,28],linux:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],mistak:6,ispyhorizont:27,vertic:[27,2,22,18],width_vdd:18,static_cast:[27,16],devic:22,due:[13,22],empti:22,rds_ndif:18,strategi:2,pymodule_addobject:[6,27],imag:22,great:2,gap:22,coordin:[22,18],understand:17,convers:[9,6,15,28],dupui:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pyhurricane_method:[6,27],look:[9,13,22,8,6,28],histor:18,"while":[22,16],unifi:22,abov:[14,6,22,13],error:[6,27,17],loop:[14,22],propag:[2,22],rip:22,itself:[6,18],pytypeobject:[6,27,8],demot:18,pypoint_linkpytyp:8,anabat:26,decor:22,fedora:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],obsolet:20,belong:13,devtoolset2:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],el7_64:14,getnet:27,optim:14,parametertyp:13,user:[9,14,2,22,28,12,13,20],rds_cont:18,stack:6,recent:18,lower:[13,22],task:[14,27],pypoint_geti:8,older:[14,22],entri:[2,13,22],miss:22,p_d3:2,p_d2:2,p_d1:2,p_d0:2,pypoint_getx:[16,8],expens:16,swiss:22,worklib:13,self:[16,6,27,13,8],explan:[22,18],pylay:17,shape:18,failsaf:22,pylibrary_cr:6,botch:[9,28,17,24],restructuredtext:14,shortcut:[9,22,28],immediatli:22,input:20,bin:14,tp_str:6,format:[22,20],big:[22,18],bit:[22,18],docutil:14,signal:[10,2,22,26],amd2901_crl:2,toproutinglay:22,collect:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],api:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],add_python_modul:[23,17],vwidth:2,implemet:13,encount:14,pyany_aslong:[16,8],often:[22,18],creation:2,some:[2,22,17,18,13,20],back:20,mirror:2,affili:20,gcell:22,istself:23,larg:22,access_object:27,flute:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],run:[14,2,13,22],sroka:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],tp_dealloc:6,step:[13,14,2,22,18,6,27],prerequisit:14,lip6:14,isobar_py_entity_h:27,cgt:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],alu1:18,tp_hash:6,materi:22,"005\u00b5m":18,block:[2,17],pythonpath:22,within:22,contributor:3,chang:[2,22,8,13,27,20],inclus:22,span:[2,3,8],fast:[14,13,22],adjac:2,includ:[14,22,23,8,17,6,27,20],suit:22,chu:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],rds_gate:18,proxyerror:16,link:[9,14,8,17,6,28],translat:18,newer:14,delta:18,line:[14,9,2,22,28],info:[13,22],utf:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],cif:18,consist:14,verboselevel1:[13,22],opencham:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],similar:[27,22],constant:18,flow:22,parser:[20,18],doesn:22,cham:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],"char":6,cmake:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],titl:19,sequenti:13,invalid:[6,27,17,8],accross:17,declar:6,librari:[9,13,14,22,23,28,20,17,6,27,8],draw:[22,18],scrub:6,metal5:22,metal1:18,pycomponent_destroi:27,metal2:18,developp:22,meaning:18,eval:14,in_ph:13,svn:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],libisobar:17,algorithm:[22,20],dyld_framework_path:14,uniquif:22,evenli:22,depth:22,foundri:18,code:[13,2,8,17,6,27,20],partial:[27,20,17],edg:[2,22,18],pyentity_getcel:27,edu:3,hurricaneerror:27,symbolictechno:13,pylibrary_linkpytyp:6,effort:[13,22],send:18,coriolis2:[14,2,13,23,20],reorganis:2,rds_pdif:18,pyobject_head:[6,27,8],quadruplet:13,mous:22,trough:2,pycomponent_linkpytyp:27,relev:[2,6,27],button:22,"try":22,pylibrary_getcel:6,gabriel:3,design_kit:22,impli:8,accomod:2,download:22,hspace:2,click:22,append:[2,13],compat:14,index:[9,18],"64b":14,bdo:8,access:[14,27,22,20],bluntli:8,can:[14,2,22,17,18,13,27,20],"_pyobject":27,lef:[14,22],despit:13,pvsseck_px:2,let:[22,8],ubuntu:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],lex:14,becom:[27,2,22],accessor:6,convert:[6,16,8,18],pretti:13,vbe:22,technolog:[9,13,22,28,12],cerr:[6,27],typic:[14,2,6,13],appli:[13,17,18],catchcor:[13,22],"boolean":[6,13],"__name__":2,from:[13,14,2,3,22,15,16,20,17,18,6,27,8],commun:[6,17,8],doubl:17,usr:[14,13],seteditor:2,mbk_to_rds_bigvia_hol:[9,15,28,18],upmc:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],benchmark:22,asymetr:18,actual:[22,18],pvddeck:2,account:22,alia:14,smallskip:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],cumbersom:17,pycompon:[27,17],obvious:[14,2,17,18],sligthli:14,control:[9,22,17,18,12,28],process:[13,22,20],high:[13,22],conterpart:[26,10,18],bend:18,tab:[9,13,22,28],pycomponent_method:27,occur:17,pytypeobjectlinkpytyp:[6,27],instead:[14,27,22,17,8],chri:3,pylibrary_method:6,buf_x2:2,derivedobject:27,redund:18,pytypenet:17,physic:[9,22,15,20,18,28],si2:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],alloc:[6,22],drop:[14,20],bind:13,maxtracelevel:[13,22],correspond:22,element:22,issu:17,comprenhens:28,freebsd:14,move:22,bunch:6,accur:20,movabl:22,pylibrary_o:6,pvssick:2,ck_htree_bl:2,pixel:22,crash:[14,22],greater:20,python:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],devel:[14,9,28],analyt:[22,20],p_f3:2,amd2901_crl_chip:2,pymethoddef:[6,27,8],anyth:[2,13,22],edit:14,tran:2,mode:[9,14,2,22,28,13,20],ispylibrari:6,diseappear:18,p_vddick0:2,typeenumer:13,uniformdens:[13,22],"static":[14,16,17,6,27,8],our:[6,13,17],special:[2,6,22,13],out:17,variabl:[14,6,13,18],matrix:18,reload:22,defaultvalu:13,categori:22,rel:[14,18],cwd:13,red:22,marek:3,insid:[6,22,18],manipul:16,real_technolog:13,typebool:[13,22],standalon:[9,24,20,8,6,28],dictionari:6,usual:[6,27],releas:[9,14,3,22,28,12,20],p_cin:2,could:[2,13,22],p_ovr:2,put:[13,2,22,17,18,6,8],keep:8,length:18,outsid:23,retain:17,south:2,softwar:[9,3,22,12,13,28],hmeti:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],suffix:2,christoph:3,working_librari:13,ndif:18,qualiti:22,w7_64:14,lib:[14,6,22],paramid:13,suffic:22,strict:18,licens:[9,3,22,20,12,28],mkdir:14,capac:22,messag:22,termin:[9,2,22,24,27,28],rapidjson:14,boil:18,shell:14,shelf:17,transistor:18,exactli:[14,2,22,18],"150k":22,bother:6,structur:[9,14,22,23,24,17,28],bee:22,corioli:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],blif:[22,20],viewer:[9,0,2,22,28,12,20],linker:17,coher:22,reserv:22,need:[13,14,2,22,23,17,18,6,27,8],pycpp:23,min:13,dictionnari:[2,6],rout:[13,22,20,18],accuraci:22,mix:[14,26,10,17],which:[13,14,2,3,22,23,20,18,6,27,8],pypoint_setx:[16,8],mip:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],instanci:[27,2,22],singl:22,allow:[6,22,13,18],preliminari:20,segment:[9,22,15,28,18],why:[6,17],cbug:22,"32b":14,vsse:2,placement:[9,2,22,20,13,28],pycontact:27,request:2,vssi:2,inde:22,snapshot:[9,22,28],determin:6,highlit:22,satur:22,fact:[27,17],kite:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],dbo:[9,24,28,17,6,27,8],instens:13,text:[2,22],verbos:22,approx:22,width_vss:18,bring:17,directdeletemethod:8,basiclay:22,redirect:22,locat:[2,13,22],coloquint:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],should:[14,22,17,8],anneal:[2,20],local:[14,13,22],hope:17,ck_htree_bl_bl:2,notat:22,familiar:17,newpag:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],increas:[22,18],p_vddeck1:2,p_vddeck0:2,experi:22,enabl:22,organ:6,twice:17,medskip:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pytypeent:27,isobar_py_contact_h:27,cinfo:22,she:27,partit:2,contain:[14,2,22,23,17,18,13,20],dpi:22,view:[6,22,13,18],y_grid:18,vdde:2,unrout:22,textwidth:3,pitch:18,vddi:2,p_a0:2,p_a1:2,p_a2:2,p_a3:2,violet:22,pylibrary_destroi:6,wire:[22,18],pyinstanc:17,pattern:[9,22,28,1],written:[17,6,13,8,21],crude:22,neither:6,qt5:14,kei:[2,6,22],entir:17,endl:[6,27],memento:[9,22,28],addit:[13,22],doxygen:[0,10,14,2,25,11,7,26],plugin:[9,2,28,12],druc:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],equal:22,etc:[14,2,13],instanc:[2,13,22,17,18],eponym:22,pyentity_linkpytyp:27,pylibrary_dealloc:6,hurricaneam:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],walk:22,solv:22,respect:[13,22,17],rpm:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pyhorizontal_link:27,quit:22,shellsuccess:2,compos:22,compon:[9,2,22,15,28,17,18,13,27,20],json:20,electr:18,rf2lib:13,both:[14,2,13,22,18],presenc:27,ob_typ:[6,27,8],togeth:20,bull:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],pydatabas:6,present:[14,27,22],determinist:22,main:[14,22,20],plain:16,cursor:22,defin:[13,2,22,23,20,17,18,6,27,8],vspace:2,typeint:[2,13,22],layer:[9,22,28,18],pycell_link:[6,27],nero:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],helper:[9,13,14,12,6,28],almost:[27,2,13,22],libxml2:14,site:13,inspector:[9,22,28],cmos130:13,geti:[27,8],mutat:6,welcom:9,getx:[27,16,8],hurrican:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],pytypelay:17,ifndef:[6,27,8],listdir:13,http:[14,3],upon:17,effect:22,expand:18,off:[17,18],center:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],well:[2,22,18],seti:8,pydbu_fromlong:16,rflib:13,exampl:[9,13,2,22,23,16,18,12,6,27,28],command:[14,9,2,22,28],choos:[6,22],setx:[16,8],latest:14,distanc:18,camel:6,obtain:[22,18],incompatibilit:14,paul:3,prepend:13,amd64:14,makefil:14,exempl:22,add:[14,6],densiti:[13,22],match:[13,22],compnent:22,branch:[14,9,2,28],five:18,know:[14,2,6],denser:22,press:22,loader:20,recurs:[9,2,22,28],miloyip:14,python2:14,insert:[2,13],like:[14,6,27,13,17],success:2,page:9,ntran:18,vss:13,vst:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],captur:[9,22,28,20],suppli:[2,6,22,13],yosi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28],"export":[14,2,23,6,27,20],home:[14,3,13],mainli:[13,22,20],minimumsid:2,leaf:[2,22],lead:22,avoid:[22,18],feedthru:22,overlap:[22,18],esc:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],eventslimit:22,dosometh:2,usag:[22,18],talux:18,nutshel:14,although:[22,20,18],offset:18,stage:[9,14,22,12,13,28],about:[9,13,22,24,28,17,6,8],redraw:22,toolchain:22,socket:22,purist:18,cadenc:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],constructor:[6,17,8],fals:[27,6,22,13],polysilicium:18,disabl:22,own:[14,27,13,22],additionn:[14,9,28],automat:[14,2,22],"_object":[6,27,16,8],placer:[9,2,22,20,13,28],pictur:22,rcw:18,spread:22,pycfunct:[6,27,8],trigger:22,replac:[13,22,20],isobar_py_component_h:27,"function":[13,14,22,23,16,17,6,27,8],"09\u00b5m":18,north:2,escassut:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],basic:[9,22,23,28,24],getenv:13,eas:13,highest:22,bug:[13,22,20],count:[2,22,17],made:[2,22,17,18],refin:6,displac:22,whether:[27,2,22],displai:[6,22,13],record:22,below:[14,2,22,17,18,6],limit:22,lofig:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],otherwis:[22,17],problem:14,display:22,"int":8,dure:22,blockagenet:13,s2r:[13,18],implement:[20,6,22,13,17],ptran:18,pypoint_init:8,bzip2:14,contest:22,detail:[9,13,22,28,20],virtual:22,other:[13,14,2,3,22,16,17,18,6],futur:17,rememb:27,calux:18,debian:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],stai:18,tp_method:6,scientif:[0,22,2,3,4,5,6,7,8,10,11,12,13,14,15,16,17,18,19,20,21,1,23,24,25,26,27],space:[2,13,22,18],typetitl:13,rule:[2,22,18],parameterst:13},objtypes:{},titles:["Viewer Reference","Patterns Reference","Python Interface for Hurricane / Coriolis","Credits & License","Stratus Reference","DpGen Reference","3. Case 1 - DBo Derived, Standalone","Unicorn Reference","5. Case 3 - Non-DBo Standalone Classe","Welcome to Coriolis’s documentation!","Kite Reference","Hurricane Reference","Coriolis User’s Guide","Coriolis Configuration & Initialisation","Installation","Symbolic to Real Conversion in Alliance","6. Encapsulating DbU","1. Introduction","Symbolic Layout","<no title>","Release Notes","7. No C++ Hurricane::Name encapsulation","CGT - The Graphical Interface","2. Basic File Structure and CMake configuration","Hurricane Python/C++ API Tutorial","CRL Core Reference","Katabatic Reference","4. Case 2 - Hierarchy of DBo Derived Classes","Comprenhensive Table of Contents"],objnames:{},filenames:["Viewer/Viewer","Patterns/Patterns","UsersGuide/ScriptsPlugins","UsersGuide/LicenseCredits","Stratus/Stratus","DpGen/DpGen","PythonCpp/DBoStandalone","Unicorn/Unicorn","PythonCpp/NonDBo","index","Kite/Kite","Hurricane/Hurricane","UsersGuide/index","UsersGuide/Configuration","UsersGuide/Installation","RDS/index","PythonCpp/DbU","PythonCpp/Introduction","RDS/RDSpage","etc/definitions","UsersGuide/Releases","PythonCpp/Name","UsersGuide/ViewerTools","PythonCpp/Configuration","PythonCpp/index","CrlCore/CrlCore","Katabatic/Katabatic","PythonCpp/DBoHierarchy","Contents"]}) \ No newline at end of file diff --git a/documentation/_static/SoC-ReST.css b/documentation/_static/SoC-ReST.css new file mode 100644 index 00000000..6b45edf2 --- /dev/null +++ b/documentation/_static/SoC-ReST.css @@ -0,0 +1,506 @@ +/* -*- Mode: css -*- */ + +.sc { + font-variant: small-caps; + font-size: 120%; +} + +span.red { + color: red; +} + +span.italic, span.comment, span.name { + font-style: italic; +} + +span.keyword, span.name { + font-weight: bold; +} + +span.title { + font-family: "URW Bookman L", serif; + font-weight: bold; + font-size: 120%; + text-align: center; + display: block; +} + +span.header2 { + font-size: 140%; + font-weight: bold; +} + +hr { + color: #09550b; + border: 1px dotted #09550b; + border-style: none none dotted; +/* + padding-top: 10pt; + padding-bottom: 10pt; + */ +} + +h2, h3 { + text-align: left; +} + +div.contents, div.subcontents { + margin: 30pt; + padding: 0pt 10pt; + border-left: 6px solid black; + +/* Shadow explanation: + * The shadow is a rectangle the same size as the box. It is then shifted + * blurred according to the following parameters. + * + * 1. The horizontal offset of the shadow, positive means the shadow will be + * on the right of the box, a negative offset will put the shadow on the + * left of the box. + * 2. The vertical offset of the shadow, a negative one means the box-shadow + * will be above the box, a positive one means the shadow will be below + * the box. + * 3. The blur radius (optional), if set to 0 the shadow will be sharp, + * the higher the number, the more blurred it will be. + * 4. The spread radius (optional), positive values increase the size of the + * shadow, negative values decrease the size. Default is 0 (the shadow is + * same size as blur). + * 5. Color + + background-color: #ffdd66; + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + + */ +} + +div.contents p.first { + font-size: 160%; + font-weight: bold; +} + +table.contentstable { + width: 90%; +} + +table.contentstable, +table.contentstable tr, +table.contentstable tr td +{ + border: none; +} + + +div#centered { + margin-left: auto; + margin-right: auto; + text-align: center; +} + +pre, tt, code { + font-family: "courrier", "andale mono", monospace; + font-size: 100%; + white-space: pre; +} + +tt { + color: #09550b; +} + +pre.wiki, pre code, div.code, pre.literal-block { + font-size: 90%; + padding: 5pt; + margin-left: 4%; + margin-right: 4%; +/* + border: dashed; + border-width: thin; + border-color: #FC8676; + */ + background-color: #FCFCE1; + +} + +a:link, a:active { + font-weight: normal; + text-decoration: none; + color: black; + border-bottom: 1px solid black; +/* + border-bottom: 1px dotted #09550b; + border-bottom: 1px dotted #09550b; + */ +} + +a:hover, +a:focus, +a:visited +{ + font-weight: normal; + text-decoration: none; + color: black; + border-bottom: 2px solid black; +/* + font-style: italic; + color: #A40010; + border-bottom: 1px dotted #A40010; + color: #09550b; + border-bottom: 1px dotted #09550b; + */ +} + +a.toc-backref { + font-family: "URW Bookman L", serif; + font-size: 100%; + font-weight: bold; +} + +a.toc-backref:link, +a.toc-backref:active, +a.toc-backref:hover, +a.toc-backref:focus, +a.toc-backref:visited +{ + border-bottom: 0px; + text-align: left; +} + +p.credit { + margin-left: 10%; + margin-right: 10%; + font-size: 110%; +} + +p.credit span.left { + float: left; + white-space: nowrap; +} + +p.credit span.right { + float: right; + white-space: nowrap; +} + +img.addborder { + border: 1px solid black; +} + +img.align-center, img.align-middle { + display: block; +/* + clear: both; + */ + margin-left: auto; + margin-right: auto; + width: 70%; + text-align: center; +} + +img.align-top { + float: left; + padding: 0pt 20pt 20pt 0pt; + text-align: center; +} + +img.align-bottom { + float: right; + padding: 0pt 20pt 20pt 0pt; + text-align: center; +} + +div.code * { + background-color: #FCFCE1; +} + +div.note { + margin: 8px 2% 0px 2%; + border: 1px none #ffbb44; + border-left-width: 4px; + border-left-style: solid; + padding: 1px 10pt 1px 55px; +/*background: #fff676 url('/dsk/l1/jpc/pictures/ReST/clipboard.png') no-repeat 0% 50%;;*/ + background: #ffdd66 url('../_static/images/clipboard.png') no-repeat 0% 50%;; + font-size: 90% +} + +div.error { + margin: 8px 2% 0px 2%; + border: 1px none #dd0000; + border-left-width: 4px; + border-left-style: solid; + padding: 1px 10pt 1px 55px; + background: #ffddcc url('../_static/images/i-core.png') no-repeat 0% 50%;; + font-size: 90% +} + +p.admonition-title { + font-weight: bold; +} + +div.problematic { + margin: 5pt; + padding: 1pt 10pt; + background-color: #ffdd66; +} + +div.problematic p.first { + font-size: 160%; + font-weight: bold; +} + +div.problematic ul, div.contents ul, div.subcontents ul { + padding-left: 15pt; +} + +div.backlink { + text-align: center; +} + +div.backlink a { + font-size: 120%; + font-weight: bold; + text-align: center; + padding: 4pt; + border: 2px solid black; +} + +div.publications ul li { + margin-bottom: 10pt; +} + +div.publications a { + font-weight: bold; +} + +div.tools { + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: center; + align-content: space-around; +} + +div.toolblock { + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + padding: 5pt; + margin: 10pt; + flex: none; + text-align: center; + font-size: 120%; + font-weight: bold; +} + +div.toolblock a { + font-family: "URW Bookman L", serif; + font-size: 200%; + border-bottom: none; +} + +div.two-columns { + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: center; + align-content: space-around; +} + +div.two-columns ul { + padding-left: 10pt; +} + +div[class^="reliefblock"] { + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + -moz-border-radius: 5px; + border-radius: 10px; + width: 30%; + padding: 5pt; + margin: 10pt; + flex: none; +} + +div[class^="reliefblock"] a { + font-family: "URW Bookman L", serif; + font-weight: bold; + font-size: 120%; + text-align: center; + display: block; + border-bottom: none; +} + +div.reliefblock-green { background-color: #a3c090; } +div.reliefblock-blue { background-color: #b2ccdd; } +div.reliefblock-yellow { background-color: #F0e5b4; } +div.reliefblock-orange { background-color: #f1d1b5; } + +div.line-block { + font-family: "courrier", "andale mono", monospace; + font-size: 100%; +/*white-space: pre;*/ +} + +table.wiki th, table th { + color: black; + background: #FFFFCC; +} + +table.docutils { + margin-left: 5%; + margin-right: 5%; +} + +table.wiki, table.wiki th, table.wiki td { border: 1px solid black; } +table.wiki th * p { text-align: center; } +table.wiki * p { margin: 0pt; } +table.wiki * blockquote { margin: 0pt; } +table { border-collapse: collapse; } +table th, table td { border: 1px solid black; + padding: 2px 10px 2px 10px; } + +table.docinfo { + margin-top: 10pt; + margin-left: auto; + margin-right: 0pt; + border: 10px solid #303030; + border-collapse: collapse; + background: #303030; + font-size: 90%; + font-family: sans-serif; +} + +table.docinfo tr { + border-bottom: 1px dotted white; +} + +th.docinfo-name, +table.docinfo td, +table.docinfo td a:link, +table.docinfo td a:active, +table.docinfo td a:visited, +table.docinfo td a:focus, +table.docinfo td a:hover +{ + border: 0px solid white; + background: #303030; + color: white; + text-align: left; + font-weight: bold; +} + +th.docinfo-name { + font-weight: normal; +} + +table.docinfo td { + font-weight: bold; +} + +span.ul { + text-decoration: underline; +} + +* span.smallcaps { +/*font-variant: "small-caps";*/ + text-transform: "uppercase"; + font-size: "smaller"; +} + + +span.cb { + font-family: "andale mono", monospace; + font-weight: bold; + white-space: pre; +} + +span.fboxtt { + border: 1px solid black; + padding: 0px 4px; + font-family: "andale mono", monospace; + font-weight: bold; + white-space: pre; +} + +#notice.system-message, .notice.system-message { + color: black; + background: #DDFFDD; + padding-top: 5pt; + padding-bottom: 5pt; + border: 1px none #55BB55; + border-top-width: 4px; + border-top-style: solid; +} + +#content.error .message, div.system-message { + color: #550000; + background: #ffddcc; + border: 2px none #dd0000; + border-top-width: 4px; + border-top-style: solid; + padding: .5em; + margin: 1em 0; +} + +#main { + float: right; + width: 70%; + padding: 0pt; + margin: 0pt; + min-height: 700px; + background: white; +} + +div#main h1 { + border-bottom: 2px solid #09550b; +} + +div#main div.section h1 { + border-bottom: none; +} + +#cmscontent { + padding: 0pt 4% 10pt 4%; + margin: 0pt; +} + +div#htmlerrorcontents { + padding: 10pt 4% 10pt 4%; + margin: 0pt; +} + +div#htmlerrorcontents span.cs { + font-size: 80%; + font-family: "andale mono", monospace; + white-space: pre; +} + +div#htmlerrorcontents hr.lang_separator { + border: 1px dotted black; + border-style: none none dotted; + margin-top: 20pt; + margin-bottom: 10pt; +} + +#embedcontent { + border: 0pt; + padding: 0pt; + margin: 0pt; +} + +table.citation, table.footnote { + border: none; + padding-left: 5pt; + margin-left: 5pt; + margin-bottom: 5pt; + background-color: #eeeeee; +} + +table.citation th, table.citation td, table.footnote th, table.footnote td { + border: none; +} + +table.citation td.label, table.footnote td.label { + width: 50pt; +} diff --git a/documentation/_static/SoC.css b/documentation/_static/SoC.css new file mode 100644 index 00000000..391cd3e0 --- /dev/null +++ b/documentation/_static/SoC.css @@ -0,0 +1,5 @@ + +@import url("../_static/css/theme.css"); +@import url("../_static/www-SoC.css"); +@import url("../_static/SoC-ReST.css"); +@import url("../_static/pygments.css"); diff --git a/documentation/_static/images/clipboard.bb b/documentation/_static/images/clipboard.bb new file mode 100644 index 00000000..3bd31e10 --- /dev/null +++ b/documentation/_static/images/clipboard.bb @@ -0,0 +1 @@ +%%BoundingBox: 0 0 48 48 diff --git a/documentation/_static/images/clipboard.eps b/documentation/_static/images/clipboard.eps new file mode 100644 index 00000000..95427f8d --- /dev/null +++ b/documentation/_static/images/clipboard.eps @@ -0,0 +1,456 @@ +%!PS-Adobe-3.0 EPSF-3.0 +%%Creator: (ImageMagick) +%%Title: (../images/clipboard.eps) +%%CreationDate: (2012-02-27T23:17:15+01:00) +%%BoundingBox: 0 0 48 48 +%%HiResBoundingBox: 0 0 48 48 +%%DocumentData: Clean7Bit +%%LanguageLevel: 1 +%%Pages: 1 +%%EndComments + +%%BeginDefaults +%%EndDefaults + +%%BeginProlog +% +% Display a color image. The image is displayed in color on +% Postscript viewers or printers that support color, otherwise +% it is displayed as grayscale. +% +/DirectClassPacket +{ + % + % Get a DirectClass packet. + % + % Parameters: + % red. + % green. + % blue. + % length: number of pixels minus one of this color (optional). + % + currentfile color_packet readhexstring pop pop + compression 0 eq + { + /number_pixels 3 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add 3 mul def + } ifelse + 0 3 number_pixels 1 sub + { + pixels exch color_packet putinterval + } for + pixels 0 number_pixels getinterval +} bind def + +/DirectClassImage +{ + % + % Display a DirectClass image. + % + systemdict /colorimage known + { + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { DirectClassPacket } false 3 colorimage + } + { + % + % No colorimage operator; convert to grayscale. + % + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { GrayDirectClassPacket } image + } ifelse +} bind def + +/GrayDirectClassPacket +{ + % + % Get a DirectClass packet; convert to grayscale. + % + % Parameters: + % red + % green + % blue + % length: number of pixels minus one of this color (optional). + % + currentfile color_packet readhexstring pop pop + color_packet 0 get 0.299 mul + color_packet 1 get 0.587 mul add + color_packet 2 get 0.114 mul add + cvi + /gray_packet exch def + compression 0 eq + { + /number_pixels 1 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add def + } ifelse + 0 1 number_pixels 1 sub + { + pixels exch gray_packet put + } for + pixels 0 number_pixels getinterval +} bind def + +/GrayPseudoClassPacket +{ + % + % Get a PseudoClass packet; convert to grayscale. + % + % Parameters: + % index: index into the colormap. + % length: number of pixels minus one of this color (optional). + % + currentfile byte readhexstring pop 0 get + /offset exch 3 mul def + /color_packet colormap offset 3 getinterval def + color_packet 0 get 0.299 mul + color_packet 1 get 0.587 mul add + color_packet 2 get 0.114 mul add + cvi + /gray_packet exch def + compression 0 eq + { + /number_pixels 1 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add def + } ifelse + 0 1 number_pixels 1 sub + { + pixels exch gray_packet put + } for + pixels 0 number_pixels getinterval +} bind def + +/PseudoClassPacket +{ + % + % Get a PseudoClass packet. + % + % Parameters: + % index: index into the colormap. + % length: number of pixels minus one of this color (optional). + % + currentfile byte readhexstring pop 0 get + /offset exch 3 mul def + /color_packet colormap offset 3 getinterval def + compression 0 eq + { + /number_pixels 3 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add 3 mul def + } ifelse + 0 3 number_pixels 1 sub + { + pixels exch color_packet putinterval + } for + pixels 0 number_pixels getinterval +} bind def + +/PseudoClassImage +{ + % + % Display a PseudoClass image. + % + % Parameters: + % class: 0-PseudoClass or 1-Grayscale. + % + currentfile buffer readline pop + token pop /class exch def pop + class 0 gt + { + currentfile buffer readline pop + token pop /depth exch def pop + /grays columns 8 add depth sub depth mul 8 idiv string def + columns rows depth + [ + columns 0 0 + rows neg 0 rows + ] + { currentfile grays readhexstring pop } image + } + { + % + % Parameters: + % colors: number of colors in the colormap. + % colormap: red, green, blue color packets. + % + currentfile buffer readline pop + token pop /colors exch def pop + /colors colors 3 mul def + /colormap colors string def + currentfile colormap readhexstring pop pop + systemdict /colorimage known + { + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { PseudoClassPacket } false 3 colorimage + } + { + % + % No colorimage operator; convert to grayscale. + % + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { GrayPseudoClassPacket } image + } ifelse + } ifelse +} bind def + +/DisplayImage +{ + % + % Display a DirectClass or PseudoClass image. + % + % Parameters: + % x & y translation. + % x & y scale. + % label pointsize. + % image label. + % image columns & rows. + % class: 0-DirectClass or 1-PseudoClass. + % compression: 0-none or 1-RunlengthEncoded. + % hex color packets. + % + gsave + /buffer 512 string def + /byte 1 string def + /color_packet 3 string def + /pixels 768 string def + + currentfile buffer readline pop + token pop /x exch def + token pop /y exch def pop + x y translate + currentfile buffer readline pop + token pop /x exch def + token pop /y exch def pop + currentfile buffer readline pop + token pop /pointsize exch def pop + /Times-Roman findfont pointsize scalefont setfont + x y scale + currentfile buffer readline pop + token pop /columns exch def + token pop /rows exch def pop + currentfile buffer readline pop + token pop /class exch def pop + currentfile buffer readline pop + token pop /compression exch def pop + class 0 gt { PseudoClassImage } { DirectClassImage } ifelse +} bind def +%%EndProlog +%%Page: 1 1 +%%PageBoundingBox: 0 0 48 48 +userdict begin +DisplayImage +0 0 +48 48 +12.000000 +48 48 +0 +0 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF383448383448384848383448FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF384848FFFFFFFFFFFFD0D0E0384848182428FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD09C78FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFC09C68784828684828784828684828 +784828684828784828684828784828684828784828684828784828383448FFFFFF585858000000 +A0ACC0A09CC0384848281428784828784838685828784838785828784838785828784838785828 +784838785828784838785828784838C09C68784828FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF684838685828684828685828684838685828784838685828684838 +685828784838685828784838384848FFFFFFFFFFFF000000485868FFFFFFB0BCC0B0BCD0182428 +182428685828784838685828785838685828784838685838785838685828784838785838785838 +685828785838000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +684828784828684828784828684828784828384848383448383448383448384848383448383448 +FFFFFFFFFFFFFFFFFFA0ACB0A09CC0A0ACB0D0BCD0B0BCC0B0ACB0182428281428383448383448 +384848383448383448585858785828784838785828784838785828784838785828000000686868 +908C90FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF784838685828684838685828 +784838284848484868FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE0E0F0D0E0E0D0D0E0 +C0D0D0C0D0E0C0D0D0C0BCD0B0BCD0B0BCD0B0BCC0B0ACC0A0ACC0A09CC0A0ACC0485868182428 +585858785838785838785838784838785838785838000000585858787878908C90FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF684828784828684828FFFFFFFFFFFF383448FFFFFFD0D0E0 +D0D0D0D0BCD0C0D0D0C0BCD0C0BCC0C0ACC0B0BCC0B0ACC0A0ACB0B09CC0A0ACB0A09CB0909CB0 +A09CB0909CA0908CB0909CA0908CA0909CA0908CB0909CA0484858182428908C90B0BCB0F0F0F0 +382418784838785828000000484848686868908C90FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF684838685828784838F0FFFFFFFFFF384848D0D0E0485858585868486868585868485858 +585868486868585868485858585868486868585868485858585868486868585868485858585868 +486868585868485858585868283438181428788C90B0ACC0F0FFF0482428785838785838000000 +383438484848A02428A02428FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF684828784828685828 +FFF0FFFFFFF0281428181418181418181418181418181418181418181418181418181418181418 +181418181418181418181418181418181418181418181418181418181418181418181418181418 +181418181418907890B0BCB0F0F0F0383418904838785828000000383438A02428F09C78FF8C78 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF784838685828784838F0FFFFFFFFFFF0FFFF908CA0 +908C90685868383438282428787878908C90788C90908C90908C90908C90788C90908C90908C90 +908C90788C90908C90788C90908C90788C90908C90788C90908C90788C90908C90788C90C0ACC0 +F0F0F0482428785838905838000000484868F09C78A02428A02428000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF685828784828684828FFF0FFF0FFF0FFF0FFC0BCC0786878382428684800484800 +483448B0BCB0C0ACC0C0BCB0C0ACC0B0BCB0C0ACC0B0BCB0C0ACC0B0BCB0C0ACC0B0BCB0C0ACC0 +B0BCB0C0ACC0B0BCB0C0ACC0B0BCB0C0ACC0B0BCB0C0ACC0B0BCB0F0F0F0382418905838785828 +484868FFFFFF000000A02428000000481418FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF784838685828 +784838F0FFFFFFFFFFF0FFFFE0E0E0181418901418F07828E05890382438787878F0FFF0F0F0FF +F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0 +F0F0FFF0FFF0F0F0FFE0FFF0F0F0FFF0FFF0482428785838485868FFFFFFA0ACC0485858000000 +481418FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785828784838685828FFF0FFF0FFF0FFF0FF +C0BCC0000000587818188C28480048380038788C78FFF0FFF0FFF0FFF0FFF0FFF0FFF0FFF0FFF0 +FFF0F0F0F0F0F0F0FFF0FFF0FFF0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0 +F0F0F0F0F0F0383418484868FFFFFFA09CC0485858000000182428FFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF784838685828784838F0FFFFFFFFFFF0FFF0B0ACB028242800141818D028 +004818000000E0E0E0F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FF +F0FFF0F0F0FFF0F0F0F0F0FFF0FFF0F0F0FFE0F0F0F0F0FFF0F0F0F0F0F0E0F0F0484868FFFFFF +A0ACC0485858000000182428787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF685828 +784838785828FFF0FFF0FFF0FFF0FFE0E0D0A08CA0000000181400000000787878F0FFF0FFF0FF +F0F0F0F0F0FFF0F0F0F0F0F0F0F0F0F0F0FFF0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0 +F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0E0F0F0483428FFFFFF484868485858000000182428484848 +787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF784838685828785838F0FFF0F0F0FF +F0FFF0F0F0FFD0E0D0484848586858C0BCC0F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0 +F0F0FFF0FFF0F0F0FFF0FFF0F0F0F0E0F0F0F0F0FFE0FFF0F0F0F0E0F0F0F0F0FFE0FFF0F0F0F0 +E0F0F0483428FFFFFFF0E078F0AC90000000001400282428484848787878FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF785828784838785828FFF0FFF0FFF0FFF0FFF0FFF0FFF0F0D0E0D0 +E0D0E0F0FFF0FFF0F0F0F0F0F0F0FFF0FFF0FFF0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0 +F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0E0F0F0483428FFFFFFF0E078F0AC90 +000000483428000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +785838685828784838F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FF +F0FFF0F0F0FFF0FFF0F0F0FFF0F0F0F0F0FFF0FFF0F0F0FFE0F0F0F0F0FFE0F0F0F0F0F0E0F0F0 +F0F0FFE0F0F0F0F0F0E0F0F0483428FFFFFFF0E078F0AC90000000483428905838000000282428 +484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785828784838785828F0F0FF +F0FFF0FFF0FFF0F0F0F0F0FFF0F0F0484868485858484868485858484868485858484868485858 +484868485858484868485858484868485858484868485858484868485858484868485858483428 +FFFFFFF0E078F0AC90000000483428905838785838000000383438484848787878FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838785838785838F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0 +F0F0FFF0FFF0F0F0FFE0FFF0F0F0FFF0FFF0F0F0F0E0F0F0F0F0FFE0FFF0F0F0F0E0F0F0F0F0F0 +E0FFF0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0483428FFFFFFF0E078F0AC90000000483428 +482428786838905848000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF785828784838785828FFF0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0281428F0F0F0F0F0F0 +F0F0F0F0F0F0485858484868485858A09CC0A0ACB0A09CC0A0ACB0484868485858484868A0ACB0 +A09CC0A0ACB0483428FFFFFFF0E078F0AC90000000483428F0F0F0483418905838905838000000 +383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838785838784838 +F0FFF0F0F0FFF0FFF0F0F0FFF0FFF0F0F0FFF0F0F0F0F0FFF0FFF0F0F0FFE0F0F0F0F0FFE0F0F0 +F0F0F0E0F0F0F0F0FFE0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0483428FFFFFFF0E078 +F0AC90000000483428F0F0F0E0F0F0482428906838905848000000282428484848787878FFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785828904838785838F0F0FFF0F0F0F0F0F0F0F0F0 +F0F0F0F0F0F0484868485858484868485858484868485858484868485858484868485858484868 +485858484868485858484868A0ACB0483428FFFFFFF0E078F0AC90000000483428F0E0F0E0F0E0 +F0E0F0483418905838905838000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF785838785838785838E0FFF0F0F0FFF0FFF0F0F0F0E0F0F0F0F0FFE0FFF0F0F0F0 +E0F0F0F0F0F0E0FFF0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0 +483428FFFFFFF0E078F0AC90000000483428E0F0F0E0F0F0E0F0F0E0F0F0483428786838905848 +000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785828905838 +785828F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0281428F0F0F0F0F0F0F0F0F0F0F0F0A0ACB0 +484868485858A09CC0A0ACB0A09CC0A0ACB0484868A0ACB0483428FFFFFFF0E078F0AC90000000 +483428F0E0F0E0F0E0F0E0F0E0F0E0E0E0F0483418905838905838000000383438484848787878 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838785838785838F0FFF0F0F0F0E0F0F0 +F0F0FFE0F0F0F0F0F0E0F0F0F0F0FFE0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0 +E0F0F0F0F0F0E0F0F0483428FFFFFFF0E078F0AC90000000483428E0F0F0E0F0F0E0E0F0E0F0F0 +E0F0F0E0F0F0482428906838905848000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF785828904838785838F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0E0F0F0484868 +485858484868485858484868485858484868485858484868485858484868A0ACB0483428FFFFFF +F0E078F0AC90000000483428484868485858484868E0F0E0E0E0F0E0F0E0E0E0F0483418905848 +785838000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838 +785838905838E0F0F0F0F0F0E0FFF0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0 +F0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0483428FFFFFFF0E078F0AC90000000483428E0F0F0 +E0F0E0E0E0F0E0F0F0E0F0F0E0F0E0E0E0F0D0E0E0482428685828583438000000282428484848 +787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838905838785828F0F0F0F0F0F0 +F0F0F0E0F0F0F0F0F0E0F0F0281428E0F0F0F0E0F0E0F0F0F0F0F0485858484868A0ACB0484868 +A0ACB0483428FFFFFFF0E078F0AC90000000483428E0E0F0E0F0E0F0E0F0E0F0E0E0E0F0D0E0E0 +D0BCD0B0ACB0A08CA0282418482428382418000000383438484848787878FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF905838785838905838E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0F0F0F0 +E0F0F0F0F0F0E0F0F0F0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0483428FFFFFFF0E078F0AC90 +000000483428E0F0F0E0F0F0E0E0F0D0F0E0D0D0D0B0BCC0A09CB0788C90686878485858181418 +282418382418000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +785838905838785838F0F0F0E0F0F0F0E0F0E0F0F0F0F0F0E0F0F0484868485858484868485858 +484868485858484868A0ACB0483428FFFFFFF0E078F0AC90000000483428484868485858484858 +384858383448283438282438585858484858384838483448181400482428483428000000383438 +484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905838786838905838E0F0F0 +E0F0F0E0F0F0F0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0683438 +FFFFFFF0E078F0AC90000000483428C0BCD0C0D0C0A0ACB0909C90787890586868484858384848 +484848485848686868687878382418684838785848000000282428484848787878FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905838905838785838F0E0F0E0F0F0F0F0F0E0F0E0F0E0F0 +E0F0E0281428E0F0E0F0E0F0E0F0E0F0E0F0A0ACB0903438907868903438F0AC90000000483428 +383448383438382438484848383448182418383438485848585858687868908C90A0ACA0C0BCC0 +483418A05848906838000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF905838785838905848E0F0F0F0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0F0F0E0E0F0E0F0F0 +E0F0F0E0F0F0B08C90784838FFFFFFE0F0E0000000382418686868586868585858384848484848 +384848585858687878908C90909CA0B0ACC0C0D0D0D0E0E0D0F0E0483428906848A06848000000 +282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF785838905838905838 +F0E0F0E0F0E0F0E0F0E0F0F0E0E0F0E0F0E0484868485858484868485858484868784828D0ACB0 +784828000000282438282428182418181428181418281428282428382438383438383458384858 +484868D0E0E0E0E0F0D0E0E0E0E0E0483428A05848906838000000383438484848787878FFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905848786838905838E0F0F0E0F0F0E0F0F0E0F0F0 +E0F0F0E0E0F0E0F0F0E0F0F0E0F0E0E0E0F0787868000000282418282428687878585868485858 +585858586868787878909C90B0ACC0C0D0D0D0D0E0D0E0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0 +D0F0E0483428906848A06848000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF905838905838905838F0E0F0E0F0E0E0E0F0E0F0E0F0E0F0E0F0E0281428E0F0E0 +F0E0F0E0F0E0000000383418A09CA0908C90908C90788C78908C90909C90B09CB0C0BCC0D0D0E0 +E0E0E0E0E0F0D0E0E0E0E0E0E0E0E0E0E0E0D0E0E0E0E0E0D0E0E0E0E0E0483418A05848A06838 +000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905848786838 +905848E0F0F0E0F0F0E0F0F0E0E0F0E0F0F0E0E0F0E0F0E0E0E0F0E0F0F0E0E0F0C0D0D0C0BCD0 +C0D0C0C0D0D0C0D0D0C0D0D0C0E0D0D0D0E0D0E0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0 +E0E0F0D0E0E0E0E0F0D0F0E0E0E0F0D0E0E0483428906848A06848000000282428484848787878 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905838905838905838E0E0F0E0F0E0E0E0F0 +E0F0E0E0E0F0E0F0E0484868485858484868485858484868485858484868485858484868485858 +484868485858484868485858484868485858484868485858484868485858484868D0E0E0E0E0E0 +D0E0E0E0E0E0483428A05848906838000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF905848906838905848E0F0E0E0E0F0E0F0F0E0E0F0D0F0E0E0E0F0E0F0E0 +E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0 +D0F0E0E0E0F0D0F0E0E0E0F0D0E0E0D0E0F0D0F0E0D0E0E0D0E0E0D0E0F0D0F0E0483428906848 +A06848000000282428484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905838 +905848906838E0E0F0E0F0E0E0E0F0E0F0E0E0E0F0E0F0E0E0E0F0E0F0E0E0E0F0E0E0E0E0E0F0 +E0F0E0E0E0E0E0E0E0E0E0F0D0E0E0E0E0E0E0E0E0E0E0E0D0E0E0E0E0E0D0E0E0E0E0E0D0E0E0 +E0E0E0D0E0E0E0E0E0D0E0E0E0E0E0D0E0E0E0E0E0483418A05848A06838000000383438484848 +787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF905848906838905848E0F0F0E0E0F0 +D0F0E0E0E0F0E0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0E0E0F0D0F0E0 +E0E0F0D0F0E0E0E0F0D0E0E0E0E0F0D0F0E0E0E0F0D0E0E0D0E0F0D0E0E0D0E0E0D0E0E0D0E0F0 +D0E0E0D0E0E0D0E0E0483428906848A06848000000282428484848787878FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF906838A05848905838482428483418482428483418482428483418 +482428483418482428483418482428483418482428483418582428483428482428483418582428 +483428482428483418582428483428582428483418582428483428582428483418582428483428 +A06848A06848000000383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +905848906838905848906838905848906838906848906838905848906838A06848906838905848 +906848A06848906838905848906848A06848906848A06848906848A06848906848A06848906848 +A06848906848A06848906848A06848906848A06848906848A06848906848A06848000000282428 +484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFD08C78D09C68A05848906838A05848 +906838A05848906838A05848906838A05848906838A05848906838A05848906838A05848906838 +A05848906838A05848A06838A05848906838A05848A06838A06848A06838A05848A06848A06848 +A06838A05848A06848A06848A06838A06848684828000000383438484848787878FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF784838000000000000000000000000000000000000000000 +000000000000000000000000000000000000000000000000000000000000000000000000000000 +000000000000000000000000000000000000000000000000000000000000000000000000000000 +000000000000000000283428383438484848787878FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF686868484848383438282428383438282428383438282428 +383438282428383438282428383438282428383438282428383438282428383438282428383438 +282428383438282428383438282428383438282428383438282428383438282428383438383438 +484848686868FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF787878787878787878686868686868686868686868686868686868686868686868686868 +686868686868686868686868686868686868686868686868686868686868686868686868686868 +686868686868686868686868686868686868686868686868686868686868787878FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF + +end +%%PageTrailer +%%Trailer +%%EOF diff --git a/documentation/_static/images/clipboard.pdf b/documentation/_static/images/clipboard.pdf new file mode 100644 index 00000000..5424a7a2 Binary files /dev/null and b/documentation/_static/images/clipboard.pdf differ diff --git a/documentation/_static/images/clipboard.png b/documentation/_static/images/clipboard.png new file mode 100644 index 00000000..aefb16da Binary files /dev/null and b/documentation/_static/images/clipboard.png differ diff --git a/documentation/_static/images/i-core.bb b/documentation/_static/images/i-core.bb new file mode 100644 index 00000000..3bd31e10 --- /dev/null +++ b/documentation/_static/images/i-core.bb @@ -0,0 +1 @@ +%%BoundingBox: 0 0 48 48 diff --git a/documentation/_static/images/i-core.eps b/documentation/_static/images/i-core.eps new file mode 100644 index 00000000..250d1dba --- /dev/null +++ b/documentation/_static/images/i-core.eps @@ -0,0 +1,456 @@ +%!PS-Adobe-3.0 EPSF-3.0 +%%Creator: (ImageMagick) +%%Title: (../images/i-core.eps) +%%CreationDate: (2012-04-20T17:48:52+02:00) +%%BoundingBox: 0 0 48 48 +%%HiResBoundingBox: 0 0 48 48 +%%DocumentData: Clean7Bit +%%LanguageLevel: 1 +%%Pages: 1 +%%EndComments + +%%BeginDefaults +%%EndDefaults + +%%BeginProlog +% +% Display a color image. The image is displayed in color on +% Postscript viewers or printers that support color, otherwise +% it is displayed as grayscale. +% +/DirectClassPacket +{ + % + % Get a DirectClass packet. + % + % Parameters: + % red. + % green. + % blue. + % length: number of pixels minus one of this color (optional). + % + currentfile color_packet readhexstring pop pop + compression 0 eq + { + /number_pixels 3 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add 3 mul def + } ifelse + 0 3 number_pixels 1 sub + { + pixels exch color_packet putinterval + } for + pixels 0 number_pixels getinterval +} bind def + +/DirectClassImage +{ + % + % Display a DirectClass image. + % + systemdict /colorimage known + { + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { DirectClassPacket } false 3 colorimage + } + { + % + % No colorimage operator; convert to grayscale. + % + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { GrayDirectClassPacket } image + } ifelse +} bind def + +/GrayDirectClassPacket +{ + % + % Get a DirectClass packet; convert to grayscale. + % + % Parameters: + % red + % green + % blue + % length: number of pixels minus one of this color (optional). + % + currentfile color_packet readhexstring pop pop + color_packet 0 get 0.299 mul + color_packet 1 get 0.587 mul add + color_packet 2 get 0.114 mul add + cvi + /gray_packet exch def + compression 0 eq + { + /number_pixels 1 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add def + } ifelse + 0 1 number_pixels 1 sub + { + pixels exch gray_packet put + } for + pixels 0 number_pixels getinterval +} bind def + +/GrayPseudoClassPacket +{ + % + % Get a PseudoClass packet; convert to grayscale. + % + % Parameters: + % index: index into the colormap. + % length: number of pixels minus one of this color (optional). + % + currentfile byte readhexstring pop 0 get + /offset exch 3 mul def + /color_packet colormap offset 3 getinterval def + color_packet 0 get 0.299 mul + color_packet 1 get 0.587 mul add + color_packet 2 get 0.114 mul add + cvi + /gray_packet exch def + compression 0 eq + { + /number_pixels 1 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add def + } ifelse + 0 1 number_pixels 1 sub + { + pixels exch gray_packet put + } for + pixels 0 number_pixels getinterval +} bind def + +/PseudoClassPacket +{ + % + % Get a PseudoClass packet. + % + % Parameters: + % index: index into the colormap. + % length: number of pixels minus one of this color (optional). + % + currentfile byte readhexstring pop 0 get + /offset exch 3 mul def + /color_packet colormap offset 3 getinterval def + compression 0 eq + { + /number_pixels 3 def + } + { + currentfile byte readhexstring pop 0 get + /number_pixels exch 1 add 3 mul def + } ifelse + 0 3 number_pixels 1 sub + { + pixels exch color_packet putinterval + } for + pixels 0 number_pixels getinterval +} bind def + +/PseudoClassImage +{ + % + % Display a PseudoClass image. + % + % Parameters: + % class: 0-PseudoClass or 1-Grayscale. + % + currentfile buffer readline pop + token pop /class exch def pop + class 0 gt + { + currentfile buffer readline pop + token pop /depth exch def pop + /grays columns 8 add depth sub depth mul 8 idiv string def + columns rows depth + [ + columns 0 0 + rows neg 0 rows + ] + { currentfile grays readhexstring pop } image + } + { + % + % Parameters: + % colors: number of colors in the colormap. + % colormap: red, green, blue color packets. + % + currentfile buffer readline pop + token pop /colors exch def pop + /colors colors 3 mul def + /colormap colors string def + currentfile colormap readhexstring pop pop + systemdict /colorimage known + { + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { PseudoClassPacket } false 3 colorimage + } + { + % + % No colorimage operator; convert to grayscale. + % + columns rows 8 + [ + columns 0 0 + rows neg 0 rows + ] + { GrayPseudoClassPacket } image + } ifelse + } ifelse +} bind def + +/DisplayImage +{ + % + % Display a DirectClass or PseudoClass image. + % + % Parameters: + % x & y translation. + % x & y scale. + % label pointsize. + % image label. + % image columns & rows. + % class: 0-DirectClass or 1-PseudoClass. + % compression: 0-none or 1-RunlengthEncoded. + % hex color packets. + % + gsave + /buffer 512 string def + /byte 1 string def + /color_packet 3 string def + /pixels 768 string def + + currentfile buffer readline pop + token pop /x exch def + token pop /y exch def pop + x y translate + currentfile buffer readline pop + token pop /x exch def + token pop /y exch def pop + currentfile buffer readline pop + token pop /pointsize exch def pop + /Times-Roman findfont pointsize scalefont setfont + x y scale + currentfile buffer readline pop + token pop /columns exch def + token pop /rows exch def pop + currentfile buffer readline pop + token pop /class exch def pop + currentfile buffer readline pop + token pop /compression exch def pop + class 0 gt { PseudoClassImage } { DirectClassImage } ifelse +} bind def +%%EndProlog +%%Page: 1 1 +%%PageBoundingBox: 0 0 48 48 +userdict begin +DisplayImage +0 0 +48 48 +12.000000 +48 48 +0 +0 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000 +000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF000000000000000000000000000000000000000000000000000000 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000000000000000000000000000 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF000000A39121F5E78AEFD532C5B029A391216E6216000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFF00000092821A +000000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000A39121 +F7EEAEEFD532C5B029A391216E6216000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000F2D72C00000000000092821AF2D72C000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000A39121F5E78AEFD532C5B029A39121 +5B5112000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +F2D72CF2D72C5A5010F2D72CF2D72C000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +0000000A09004C450B887A1BCFC36CEADD8BE9CF38E5CA38D1BA31B19C27807319453E0A0A0900 +000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000F2D72CF2D72CF2D72C +92821A000000000000FFFFFFFFFFFFFFFFFFFFFFFF0000002421037E721ADAC036EDD33AF4D83A +F5DE5BF3DD5AEED336EBD136E8CC35E5CA34E2C834DBC033CBB0317063171E1C02000000FFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF00000092821AF2D72CF2D72CF2D72CF2D72CF2D72CF2D72C000000 +FFFFFFFFFFFF000000746817D9C135E9CF38F5DA38F8DC38F6DB37F5DA35F3D834F2D634EFD532 +EDD231E9CE32E6CA32E4C932E0C433D7BC33CBB033605513000000FFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +F2D72CF2D72CF2D72CF2D72CF2D72C000000000000000000FFFFFF000000242204AF9C29EAD039 +F2D738F9DE36FADE36F8DD35F7DD32F7DB31F5DB2FF4DA2FF2D72FF0D52FEDD230EBCF30E9CC30 +E6C932E1C533DCBF33CDB2338F7D211C1A02000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000F2D72CF2D72C000000000000F2D72C +F2D72C000000FFFFFFFFFFFF000000302C06CCB432F2D739FADD39FADF36FADF33FADE32FADF30 +F9DE2DF8DD2DF7DD2CF6DB2CF4DA2CF2D72CF0D52DEED32CECD02EE8CB2FE3C630E0C331DABC32 +CDAF31A38B28221F03000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFF000000F2D72CF2D72C000000FFFFFF +242004CAB332F3D539F9DD37FADE35FADE32FADF30FADF2EFAE02CF9DF2AF9DF29F8DE29F8DD29 +F6DC28F4DA29F3D82AF0D52AEFD22BEBCF2CE6C92DE3C630DEC030D3B630B79B2D917C24171502 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF000000F2D72CF2D72C000000000000AE9A28F1D438F9DD37FADD34 +FADE32FADE2FFADF2CFAE02AFAE029F9DF27F9DF26F9DF25F8DE25F7DE25F6DC26B8A41DB6A21D +F1D529EED12AEACD2BE6C92CE0C22EDBBB2FCAAC2EB1952C73601C000000FFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFF000000F2D72C000000786B18F1D33AF8DB38F9DC35F9DD31F9DD2EFADF2B3B3509746812 +FAE026F9E1249C8D15000000F9E023F8DE23F7DD235F550D1A1704C8B11FEFD327C3AB21685B13 +C7AD26DEBF2DD6B62FC2A42DA38827463C0F000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000252104 +ECCE3AF8D93AF8DA36F9DB32F9DC2FF9DE2BF9DE29CBB51F0D0C029B8B1551490A161402A59515 +FAE120F9DF20F8DE21CCB61C1412020E0C0260550F040400151203C9AD24DFC02CDAB92DCFAE2E +B9992B957A25121001FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000088781DF4D43BF7D837F8DA32F8DB2F +F8DC2CF9DD29F9DE26F9DF244B430A040400161402C1AE17FAE11FFAE21FF9E120F8DF21F8DD20 +BDA91A0000000000004C430CECCE27E6C829E2C22ADABA2CD3B22EC3A22B987D2440350E000000 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF0A0900E1C237F7D639F7D835F8D931F8DB2DF8DC2AF9DD27F9DE25665B0E +0000002A2505000000A59513FAE324FAE32AF9E22AF7DF279B8B15090801060500000000121002 +DEC123E8C927E2C228DCBB29D3B02BC5A32BA48626745E1D070600FFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF49410C +E5C537F6D537F7D732F7D92FF7DA2BF8DB28F8DD25F8DE23373207CBB619FAE11D766B0D000000 +CCBA27FAE63EF3E041ECD8397A6E14403908E7CD1EBAA3180C0A01231E05E9CA27E2C228DCBC28 +D3B12ACBA92BAE8F278369201F1A05FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000080701BE9C837F5D435F6D631F6D82D +F7DA2AF7DB27F8DD23F8DE22F9DF1FF9E01DFAE11CFAE21CCBB925ECDA44F8E75EEBDC5DDBCB49 +D6C230E1C920F0D51EEBD01E7768101D1904917D16E2C227DCBB27D3B128CAA729B998298D7121 +362B0C000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000A68E26EAC735F4D333F5D530F6D82CF6D829F7DA26F8DC23F8DE21 +F9DF1FF9E01DFAE11BFAE323FBE84FFCED77F8ED8AEADF82D4C85FC4B335C7B21ED4BC1ACAB31A +D8BD1EC6AD1CCAAE1EE2C125DCBA27D2B126C8A427B99727957622504013000000FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000 +AC9228DAB931EFCC31F4D430F5D72BF6D828F6D925F7DB23F8DD20F9DF1DF9DF1CF7DE1DF6E240 +FCEE7EFDF3A8FCF4B5F1E8A3DACE75BCAC39A090189D8B139E8B14C3AA1ADCBF1FE3C321E1C025 +DAB826D1AF26C6A327B89526967822604B17000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000BF9F2EE0BE32F0CE30F3D22E +F3D42BF5D628F6D825F7DB22F8DC1FF8DE1EF7DD1BEFD929E7D75CF8EE9FFDF7C6FDF8CCF8F1B7 +E3D77FC0B03A8677125C520B6C5E0DB09917D6B91EE1C122DEBE24D9B525CFAB25C3A126B49224 +9A792272591B000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF000000BFA02DDEBC31EECA2FF2D02DF2D22AF4D427F5D724F6D923 +F7DB20F7DC1EF7DC1DEBD42FDDCF66F3EAA8FBF6CDFCF7CFFCF4B5EFE17CC6B4347F710F53490A +4F450A917E13D3B61EE0BF21DDBB23D6B324CBA824C09C24B08D2496762172571A000000FFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +000000AA8E27D1B02EE8C52FEFCD2CF1CF2AF3D226F4D524F5D722F6D920F6DA1EF6DB1DEBD42F +D8CA5FE8DE96ECE6B3F0E9B4F6EB9AE9D95F92831B64580B6E600D61540C9F8A15D7B91DE0BF20 +DAB722D2AE23C8A524BD9922AB88238F6E1F5D4715000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000967E20DBB631E9C42E +ECC92DEECC29EFCF27F2D225F3D422F4D621F5D81EF6DA1DEFD62BDDCA48CCC067B6AD6EB9B06B +C2B4569A8B25594F0C6F610DA79114A18C15C9AC1AE0BF1FDFBC21D8B622CFAB23C39F22B79223 +A5812181631D44340E000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000006A5A14CDAB2DE2BD2EE8C42CEBC829EDCC26EFCE23 +F0D122F2D420F4D51FF4D71EF5D923F0D834DFCC44BFB045A49636A2922492801387770FBEA716 +DCBE1AD9BB1BE3C11FE1BF20DBB820D2AF21C9A522BF9B22AF8A2197741F775A1A32260A000000 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFF342D08C8A52CDFB92CE4BF2BE6C328E9C826EBCA24EECD22F0D020F1D31EE6CA1C +907F14665C145E551B61581C564E1450470C4E44085449099C8712BAA016E4C21EDCBA1EDDBA20 +D6B420CFAA21C49F20B89320A984208B6B1D7155181A1503FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF070700B89528 +DCB42CDFB92BE2BD29E5C127E8C524EAC822E9C820AC9617050400090503371E153E25193F2717 +261E0931200C472B1345281437230E3D300A9D8614BA9C19D9B520D0AC20C8A320BD9720B28D1F +9F7A1D7F601A6E5117060500FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000604F12C49F29DAB22ADDB828E0BC27 +E2BF25E6C221CFB11D171303000000452914A84B44AE4A4AA547474E2222783333A24444A34842 +7E3E2F39270D010100907714CCA91EC9A61FC19C20B8921FA9841F906D1C745617382A09000000 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFF181602A18222C8A328D7B129DAB526DCB823D2B120282206000000 +090601AC4848C45353CA5555C85454863C3CA94949C75454BF5151AC4949622929261F052D2506 +987C17BB971DB8921EAD871E99761C7B5C186F51170D0B00FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +0000004D3F0DB49123CFA827D3AE26D7B2259F84190101001714033A290CBA4E4ED05555D55A5A +B94C4C7C3939B34949C85353B54B4B9C43437D38380E0C020302005D4A0EA5821AAE881D9E7A1B +795B166A4D14312608000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000846A19BC9625 +CCA425D1AA253D320A0000000F0C02722F2FCD5555DD5C5CD55A5AA94848924040C55151CA5555 +B74C4C9841417436360706011D17041410038E6F17A07B1B816216664B134E390D000000FFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF1B180198761FB89124CAA1259075180A0801 +140D03823535D35757DB5C5CD65A5AB44C4CAD4848CD5555C75454B54B4B9340406C3333201606 +000000070501765A137F6015644A12583F100F0D00FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF000000201C038A6C1BAF8821BF96226E5812000000CE5555D45959D85B5B +D45959C55252C14F4FCC5454BF4F4FAA4848873C3C643131050300251D067356127E5F15654B11 +563D0F131001000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +000000161401755D15A47F1EB98F21C66F3ECD5555CE5555CF5555D15656CD5454C85252C35151 +B54B4B9B41417837375E2E2E775813926E18795A14664A1146330B0F0D00000000FFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000004F400B +A67F1EBC6D38C35050C35151C45151C45252BF5050BB4E4EB04A4A9C4343853A3A6A3333714027 +8764167054126146102B2105000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000001714015B480DB55444B84E4E +B74B4BB14B4BAD4848A144449140407D39396C33336B392B76571263480F3125060F0D00000000 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00000009080059311B894430A14343913E3E823939 +7235357042235F40163A2D071C1802060600000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000000000000000000000000000000000000000 +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF +FFFFFFFFFFFFFFFFFF + +end +%%PageTrailer +%%Trailer +%%EOF diff --git a/documentation/_static/images/i-core.pdf b/documentation/_static/images/i-core.pdf new file mode 100644 index 00000000..2bb22c3b Binary files /dev/null and b/documentation/_static/images/i-core.pdf differ diff --git a/documentation/_static/images/i-core.png b/documentation/_static/images/i-core.png new file mode 100644 index 00000000..12289072 Binary files /dev/null and b/documentation/_static/images/i-core.png differ diff --git a/documentation/_static/pygments.css b/documentation/_static/pygments.css new file mode 100644 index 00000000..68e7c8c8 --- /dev/null +++ b/documentation/_static/pygments.css @@ -0,0 +1,46 @@ +div.codeblock, div[class^="highlight"] { + font-family: "courrier", "andale mono", monospace; + font-size: 90%; + white-space: pre; +/* + margin: 10pt; +*/ + padding: 1px 10pt 1px 10pt; + margin: 0pt; + border: none; + background-color: #fcfce1; + } +.codeblock * .hll, [class^="highlight"] * .hll { background-color: #fcfce1 } +.codeblock * .c , [class^="highlight"] * .c { color: black } /* Comment */ +.codeblock * .err, [class^="highlight"] * .err { border: 1px solid #FF0000 } /* Error */ +.codeblock * .k , [class^="highlight"] * .k { color: black; font-weight: bold } /* Keyword */ +.codeblock * .cm , [class^="highlight"] * .cm { color: black; font-style: italic } /* Comment.Multiline */ +.codeblock * .cp , [class^="highlight"] * .cp { color: black; font-style: italic } /* Comment.Preproc */ +.codeblock * .c1 , [class^="highlight"] * .c1 { color: black; font-style: italic } /* Comment.Single */ +.codeblock * .cs , [class^="highlight"] * .cs { color: black; font-style: italic } /* Comment.Special */ +.codeblock * .ge , [class^="highlight"] * .ge { font-style: italic } /* Generic.Emph */ +.codeblock * .gh , [class^="highlight"] * .gh { font-weight: bold } /* Generic.Heading */ +.codeblock * .gp , [class^="highlight"] * .gp { font-weight: bold } /* Generic.Prompt */ +.codeblock * .gs , [class^="highlight"] * .gs { font-weight: bold } /* Generic.Strong */ +.codeblock * .gu , [class^="highlight"] * .gu { font-weight: bold } /* Generic.Subheading */ +.codeblock * .kc , [class^="highlight"] * .kc { color: black } /* Keyword.Constant */ +.codeblock * .kd , [class^="highlight"] * .kd { color: black } /* Keyword.Declaration */ +.codeblock * .kn , [class^="highlight"] * .kn { color: black } /* Keyword.Namespace */ +.codeblock * .kp , [class^="highlight"] * .kp { color: black } /* Keyword.Pseudo */ +.codeblock * .kr , [class^="highlight"] * .kr { color: black } /* Keyword.Reserved */ +.codeblock * .kt , [class^="highlight"] * .kt { color: black } /* Keyword.Type */ +.codeblock * .s , [class^="highlight"] * .s { color: black } /* Literal.String */ +.codeblock * .n , [class^="highlight"] * .n { font-weight: bold; font-style: italic } /* Name.Class */ +.codeblock * .nc , [class^="highlight"] * .nc { color: black } /* Name.Class */ +.codeblock * .ow , [class^="highlight"] * .ow { color: black } /* Operator.Word */ +.codeblock * .sb , [class^="highlight"] * .sb { color: black } /* Literal.String.Backtick */ +.codeblock * .sc , [class^="highlight"] * .sc { color: black } /* Literal.String.Char */ +.codeblock * .sd , [class^="highlight"] * .sd { color: black } /* Literal.String.Doc */ +.codeblock * .s2 , [class^="highlight"] * .s2 { color: black } /* Literal.String.Double */ +.codeblock * .se , [class^="highlight"] * .se { color: black } /* Literal.String.Escape */ +.codeblock * .sh , [class^="highlight"] * .sh { color: black } /* Literal.String.Heredoc */ +.codeblock * .si , [class^="highlight"] * .si { color: black } /* Literal.String.Interpol */ +.codeblock * .sx , [class^="highlight"] * .sx { color: black } /* Literal.String.Other */ +.codeblock * .sr , [class^="highlight"] * .sr { color: black } /* Literal.String.Regex */ +.codeblock * .s1 , [class^="highlight"] * .s1 { color: black } /* Literal.String.Single */ +.codeblock * .ss , [class^="highlight"] * .ss { color: black } /* Literal.String.Symbol */ diff --git a/documentation/_static/www-SoC.css b/documentation/_static/www-SoC.css new file mode 100644 index 00000000..c4c864bd --- /dev/null +++ b/documentation/_static/www-SoC.css @@ -0,0 +1,567 @@ +/* -*- Mode: css; explicit-buffer-name: "www-SoC.css" -*- */ + + +/*@media (max-resolution: 150dpi) {*/ +/*body { font-size: 9pt; }*/ + p#lip6 { font-size: 14pt; } + p#soc { font-size: 28pt; } +/* +} + +@media (min-resolution: 151dpi) { + body { font-size: 11pt; } + p#lip6 { font-size: 18pt; } + p#soc { font-size: 40pt; } +} +*/ + + +/* +body { + font-family: "Open Sans", verdana, sans-serif; + margin-left: auto; + margin-right: auto; + margin-top: 20pt; + margin-bottom: 20pt; + padding-top: 0pt; + padding-bottom: 30pt; + padding-left: 30pt; + padding-right: 30pt; + width: 580pt; + background-color: white; + */ +/*background-color: #f5f5f5;*/ +/*background: #f5f5f5 url('../images/flowers-abstract-grey.png') repeat;*/ +/*background: #f5f5f5 url('../images/layout-motif-faded-2.png') repeat;*/ +/* + background-size: 20%; + -moz-box-shadow: 0px 0px 5px 5px #ccc; + -webkit-box-shadow: 0px 0px 5px 5px #ccc; + box-shadow: 0px 0px 5px 5px #ccc; +} +*/ + +ul { + list-style-type: square; +} + +ul ul { + list-style-type: disc; +} + +ul ul ul { + list-style-type: circle; +} + +h1 { + font-family: "URW Bookman L", serif; + font-weight: bold; + font-size: 150%; + text-align: center; +/*font-family: "adelle", Georgia, "Times New Roman", serif;*/ +} + +h2, h3, h4 { + font-family: "URW Bookman L", serif; + font-weight: bold; +} + +h1.title { + text-align: center; + font-size: 140%; +} + +div#header { + background: url(../images/UPMC-Jussieu-faded.png) #c0d1f3; + padding: 10px 0px 0px 10px; + margin: 0px; + height: 90px; + width: 843pt; + position: fixed; + z-index: 1; +} + +div#header img { + height: 80px; +} + +div#header div#logos { + float: left; + width: 210pt; + padding: 0px; + margin: 0px; +} + +div#header div#title { + padding: 0px; + margin: 0px; +} + +p#lip6 { + font-weight: bold; + color: white; + margin: 0px; + padding: 0px; +} + +p#soc { + font-weight: bold; + color: white; + margin: 0px; + padding: 0px; +} + +div#logos a { + text-decoration: none; + border-bottom: none; + outline: 0; +} + +#sidebar { + background: #c0d1f3; +/* + float: left; + */ + position: fixed; + z-index: 1; + top: 100px; + width: 220pt; + padding: 5pt 0pt 0pt 0pt; + margin: 0pt; +} + +div.iconrow { + padding: 0pt 10pt; +} + +div.iconrow a { + padding: 0pt; + outline: 0; +} + +div.iconrow a:link, +div.iconrow a:active, +div.iconrow a:visited, +div.iconrow a:focus { + border-bottom: none; + vertical-align: bottom, +} + +div.iconrow a:hover { + border-bottom: 4px solid black; +} + +div#langmenu a { + padding: 0pt; + outline: 0; +} + +div#langmenu a:link, +div#langmenu a:active, +div#langmenu a:visited, +div#langmenu a:focus { + border-bottom: none; + vertical-align: bottom, +} + +div#langmenu a:hover { + border-bottom: 4px solid black; +} + +div#pagemenu { + width: 100%; + margin: 0pt; + padding: 2pt 0pt; +} + +div#pagemenu ul { + list-style-type: none; + padding-left: 10pt; + padding-right: 10pt; +} + +div#pagemenu ul li { + border-bottom: 2px dotted black; + padding-left: 0pt; + padding-right: 0pt; +} + +div#pagemenu ul li:first-child { + border-top: 2px dotted black; +} + +/* + * div#pagemenu ul li.depth-2 { + * border-bottom: none; + * padding-left: 10pt; + * } + */ + +div#pagemenu ul li.depth-0 a, +div#pagemenu ul li.active-0 a +{ + display: block; + color: black; + font-family: "URW Bookman L", serif; + font-size: 120%; + font-weight: bold; + border-bottom: none; + padding-left: 0pt; + padding-right: 0pt; + outline: 0; +} + +div#pagemenu ul li.depth-0 a:focus, +div#pagemenu ul li.depth-0 a:hover, +div#pagemenu ul li.depth-0 a:active, +div#pagemenu ul li.active-0 a:focus, +div#pagemenu ul li.active-0 a:hover, +div#pagemenu ul li.active-0 a:active +{ +/*background-color: white;*/ + font-family: "URW Bookman L", serif; + font-size: 160%; + font-style: normal; + padding-top: 5px; + padding-bottom: 5px; + padding-left: 10pt; + border-left: 6px solid black; + margin-left: -10pt; + margin-right: -10pt; +} + +div#pagemenu ul li.depth-1 a, +div#pagemenu ul li.active-1 a +{ + display: block; + color: black; + font-size: 100%; + font-weight: normal; + font-family: "URW Bookman L", serif; + border-bottom: none; + padding-left: 10pt; + margin-left: -10pt; + margin-right: -10pt; + outline: 0; +} + +div#pagemenu ul li.depth-1 a:focus, +div#pagemenu ul li.depth-1 a:hover, +div#pagemenu ul li.active-1 a:focus, +div#pagemenu ul li.active-1 a:hover +{ +/*background-color: white;*/ + font-family: "URW Bookman L", serif; + font-size: 120%; + font-style: normal; + font-weight: bold; + border-left: 6px solid black; + padding-top: 5px; + padding-bottom: 5px; +} + +div#pagemenu ul li.depth-2 a, +div#pagemenu ul li.active-2 a +{ + display: block; + color: black; + font-family: "URW Bookman L", serif; + font-size: 100%; + font-weight: normal; + border-bottom: none; + padding-left: 20pt; + margin-left: -10pt; + margin-right: -10pt; + outline: 0; +} + +div#pagemenu ul li.depth-2 a:focus, +div#pagemenu ul li.depth-2 a:hover, +div#pagemenu ul li.active-2 a:focus, +div#pagemenu ul li.active-2 a:hover +{ + font-family: "URW Bookman L", serif; + font-size: 120%; + font-style: normal; + font-weight: bold; + border-left: 6px solid black; + padding-top: 5px; + padding-bottom: 5px; +/*background-color: white;*/ +} + +div#main_page { + padding: 0pt; + margin-left: 220pt; + width: 630pt; +/* + *-moz-box-shadow: 4px 4px 5px 2px #ccc; + *-webkit-box-shadow: 4px 4px 5px 2px #ccc; + *box-shadow: 4px 4px 5px 2px #ccc; + */ +} + +div#topbar { + position: fixed; + z-index: 1; + top: 100px; + margin-left: 220pt; + background-color: #c0d1f3; + padding-top: 5pt; + height: 20pt; + width: 630pt; +} + +div#langmenu { + float: right; + vertical-align: bottom; +} + +div#breadcrumb { + margin: 0pt; + padding-left: 0pt; + background-color: #c0d1f3; +} + +div#breadcrumb a:link, +div#breadcrumb a:active, +div#breadcrumb a:visited, +div#breadcrumb a:focus { + color: black; + font-weight: bold; + border-bottom: none; + vertical-align: bottom, +} + +div#breadcrumb a:hover { + color: black; + font-weight: bold; + font-style: italic; + border-bottom: none; +} + +/* +div.contents li a:before { + display: block; + content: " "; + margin-top: -400px; + height: 400px; + visibility: hidden; +} +*/ + +div.section:before { + display: block; + content: " "; + margin-top: -120px; + height: 120px; + visibility: hidden; +} + +div#main_content { + padding: 10pt; + top: 120px; + position: relative; +/* + border-left: 1px solid #c0d1f3; + border-right: 1px solid #c0d1f3; + */ + min-height: 350pt; + text-align: justify; + background-color: white; +} + +div#column0 { + padding: 0pt; +/*border: 1px solid black;*/ + display: inline-block; +/*float: left;*/ + width: 305pt; + vertical-align: top; +} + +div#column1 { + padding: 0pt; +/*border: 1px solid black;*/ + display: inline-block; +/*float: right;*/ + width: 295pt; + vertical-align: top; +} + +div#column0 h1, div#column1 h1 { +/*font-family: "adelle", Georgia, "Times New Roman", serif;*/ + font-family: "URW Bookman L", serif; + font-weight: bold; + font-size: 120%; + text-align: center; +} + +div#column0 h2, div#column1 h2 { + font-size: 110%; +} + +div#column0 div { +/* + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + background-color: #e6ccb8; + */ + padding: 0pt; + margin-bottom: 5pt; + margin-right: 10pt; +} + +div#column1 div { +/* + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + background-color: #e6ccb8; + */ + padding: 0pt; + margin-bottom: 5pt; +} + +ul.ce-menu { + -moz-box-shadow: 4px 4px 5px 2px #ccc; + -webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + padding-left: 16pt; + background-color: #e6ccb8; +} +} + +div.csc-default { + padding: 0pt; + margin: 0pt; +} + +/* +ul.ce-menu-1 { + padding-left: 8pt; +} + +ul.ce-menu-1 li { + padding-left: 0pt; +} +*/ + + +div#footer { + top: 120px; + position: relative; +/* + bottom: 0pt; + margin-left: 220pt; + width: 620pt; + */ + padding: 5pt; + color: white; + background-color: #242729; + font-size: 90%; + font-weight: bold; +} + + +table.footer1, table.footer2 { width: 100%; border: 0px; } +td.LFooter { text-align: left; border: 0px; padding-left: 0px; } +td.RFooter { text-align: right; border: 0px; padding-right: 0px; } +td.CFooter { text-align: center;} +table.footer2 td.RFooter { font-weight: bold; width: 35%; border: 0px; } +table.footer2 td.LFooter { font-weight: bold; width: 35%; border: 0px; } +table.footer2 td.CFooter { width: 30%; border: 0px; } + +div.tx-felogin-pi1 { + border: 0px; + padding: 10pt; + moz-box-shadow: 4px 4px 5px 2px #ccc; + webkit-box-shadow: 4px 4px 5px 2px #ccc; + box-shadow: 4px 4px 5px 2px #ccc; + font-size: 100%; + display: block; + text-align: center; + width: 50%; + margin: 5% 25% 5% 25%; +} + +div.tx-felogin-pi1 fieldset { + border: none; +} + +div.tx-felogin-pi1 h3 { + font-family: "URW Bookman L", serif; + font-size: 200%; + text-align: center; +} + +div.tx-felogin-pi1 > form > fieldset > div { + font-family: "courrier", "andale mono", monospace; + font-weight: bold; + font-size: 110%; + padding-bottom: 5pt; +} + +div.tx-felogin-pi1 > form > fieldset > div > label { + font-family: "Open Sans", verdana, sans-serif; + font-weight: normal; + font-size: 100%; +} + +.tx-felogin-pi1 table.form { + border-collapse: collapse; + border: 1px solid black; + font-size: 110%; + margin: 10pt; +} + +.tx-felogin-pi1 table.form th,.tx-felogin-pi1 table.form td { + padding: 2pt; +} + +.tx-felogin-pi1 table.form th { + color: white; + background-color: black; + width: 70pt; + font-weight: bold; +} + +.tx-felogin-pi1 table.form td { +} + +.tx-felogin-pi1 table.form input { + width: 200pt; + border-style: none; +} + +.tx-felogin-pi1 input#Login, .tx-felogin-pi1 input#Logout { + border-style: none; + color: white; + background-color: black; + padding: 4pt 10pt; + font-family: "URW Bookman L", serif; + font-size: 120%; + font-weight: bold; +} + +body.gsummary h1 { + padding-top: 40pt; + padding-bottom: 30pt; + font-size: 200%; +} + +body.gsummary table { + border-collapse: collapse; + border-color: transparent; + border: 0px; + width: 80%; + margin-left: auto; + margin-right: auto; +} + +body.gsummary table td { + border: none; +} + +@import 'SoC-ReST.css'; diff --git a/documentation/_templates/indexcontent.html b/documentation/_templates/indexcontent.html new file mode 100644 index 00000000..703846f7 --- /dev/null +++ b/documentation/_templates/indexcontent.html @@ -0,0 +1,62 @@ +{% extends "defindex.html" %} +{% block tables %} +

        Documentation Topics

        + + + + + + + + +
        +

        Coriolis User's Guide
        + Using the software

        +         		+

        Hurricane Reference
        + Hurricane Netlist & Physical data-structure C++ API

        +
        +

        Stratus Language
        + A Netlist Capture Language (on top of Python)

        +         		+

        Viewer Reference
        + Graphical Interface C++ API

        +
        +

        DpGen Extension (Stratus)
        + Netlist Capture extension for Datapathes

        +         		+

        CRL Core Reference
        + Parser/Drivers (I/O) C++ API

        +
        +

        Patterns Extension (Stratus)
        + Patterns generation extension

        +         		+

        Unicorn Reference
        + Main GUI C++ API

        +
        + +

        Katabatic Reference
        + Articulated Segments Data-Structure

        +
        + +

        Kite Reference
        + Digital Router

        +
        + +

        Coriolis Python/C API
        + Tutorial for C/C++ programmers

        +
        + +

        Indices and Tables

        + + +
        +

        General Index
        + All functions, classes, terms

        +         		+

        Search page
        + Search this documentation

        +

        Complete Table of Contents
        Lists all sections and subsections

        +
        +{% endblock %} diff --git a/documentation/_themes/sphinx_rtd_theme/__init__.py b/documentation/_themes/sphinx_rtd_theme/__init__.py new file mode 100644 index 00000000..95ddc52a --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/__init__.py @@ -0,0 +1,17 @@ +"""Sphinx ReadTheDocs theme. + +From https://github.com/ryan-roemer/sphinx-bootstrap-theme. + +""" +import os + +VERSION = (0, 1, 8) + +__version__ = ".".join(str(v) for v in VERSION) +__version_full__ = __version__ + + +def get_html_theme_path(): + """Return list of HTML theme paths.""" + cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) + return cur_dir diff --git a/documentation/_themes/sphinx_rtd_theme/breadcrumbs.html b/documentation/_themes/sphinx_rtd_theme/breadcrumbs.html new file mode 100644 index 00000000..0028421e --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/breadcrumbs.html @@ -0,0 +1,23 @@ +
        + +
        +
        diff --git a/documentation/_themes/sphinx_rtd_theme/defindex.html b/documentation/_themes/sphinx_rtd_theme/defindex.html new file mode 100644 index 00000000..2078aa02 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/defindex.html @@ -0,0 +1,34 @@ +{# + basic/defindex.html + ~~~~~~~~~~~~~~~~~~~ + + Default template for the "index" page. + + :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{% extends "layout.html" %} +{% set title = _('Overview') %} +{% block body %} +

        {{ docstitle|e }}

        +

        + {% block description %} + {% if last_updated %}Documentation generated on {{ last_updated|e }}{% endif %}{% endblock %}. +

        + {% block tables %} +

        {{ _('Indices and tables:') }}

        + + +
        +

        {{ _('Complete Table of Contents') }}
        + {{ _('lists all sections and subsections') }}

        +

        {{ _('Search Page') }}
        + {{ _('search this documentation') }}

        +         		+

        {{ _('Global Module Index') }}
        + {{ _('quick access to all modules') }}

        +

        {{ _('General Index') }}
        + {{ _('all functions, classes, terms') }}

        +
        + {% endblock %} +{% endblock %} diff --git a/documentation/_themes/sphinx_rtd_theme/footer.html b/documentation/_themes/sphinx_rtd_theme/footer.html new file mode 100644 index 00000000..371f040c --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/footer.html @@ -0,0 +1,44 @@ +
        + {% if next or prev %} + + {% endif %} + +
        + +
        + + + + + +
        + {%- if last_updated %} + {% trans last_updated=last_updated|e %}Generated by Sphinx + using a RTD theme on {{ last_updated }}.{% endtrans %} + {%- endif %} +
        + + + + + +
        Coriolis 2 Documentation + {%- if show_copyright %} + {%- if hasdoc('copyright') %} + {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- else %} + {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- endif %} + {%- endif %} +
        +
        + +
        + diff --git a/documentation/_themes/sphinx_rtd_theme/layout.html b/documentation/_themes/sphinx_rtd_theme/layout.html new file mode 100644 index 00000000..9481d8b4 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/layout.html @@ -0,0 +1,181 @@ +{# TEMPLATE VAR SETTINGS #} +{%- set url_root = pathto('', 1) %} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} +{%- if not embedded and docstitle %} + {%- set titlesuffix = " — "|safe + docstitle|e %} +{%- else %} + {%- set titlesuffix = "" %} +{%- endif %} + + + + + + + {{ metatags }} + + {% block htmltitle %} + {{ title|striptags|e }}{{ titlesuffix }} + {% endblock %} + + {# FAVICON #} + {% if favicon %} + + {% endif %} + + {# CSS #} + + {# OPENSEARCH #} + {% if not embedded %} + {% if use_opensearch %} + + {% endif %} + + {% endif %} + + {# RTD hosts this file, so just load on non RTD builds #} + {% if not READTHEDOCS %} + + {% endif %} + + {% for cssfile in css_files %} + + {% endfor %} + + {% for cssfile in extra_css_files %} + + {% endfor %} + + {%- block linktags %} + {%- if hasdoc('about') %} + + {%- endif %} + {%- if hasdoc('genindex') %} + + {%- endif %} + {%- if hasdoc('search') %} + + {%- endif %} + {%- if hasdoc('copyright') %} + + {%- endif %} + + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} + {%- endblock %} + {%- block extrahead %} {% endblock %} + + {# Keep modernizr in head - http://modernizr.com/docs/#installing #} + + + + + + +
        + + {# SIDE NAV, TOGGLES ON MOBILE #} + + +
        + + {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} + + + + {# PAGE CONTENT #} +
        +
        + {% include "breadcrumbs.html" %} +
        + {% block body %}{% endblock %} +
        + {% include "footer.html" %} +
        +
        + +
        + +
        + {% include "versions.html" %} + + {% if not embedded %} + + + {%- for scriptfile in script_files %} + + {%- endfor %} + + {% endif %} + + {# RTD hosts this file, so just load on non RTD builds #} + {% if not READTHEDOCS %} + + {% endif %} + + {# STICKY NAVIGATION #} + {% if theme_sticky_navigation %} + + {% endif %} + + {%- block footer %} {% endblock %} + + + diff --git a/documentation/_themes/sphinx_rtd_theme/layout_old.html b/documentation/_themes/sphinx_rtd_theme/layout_old.html new file mode 100644 index 00000000..deb8df2a --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/layout_old.html @@ -0,0 +1,205 @@ +{# + basic/layout.html + ~~~~~~~~~~~~~~~~~ + + Master layout template for Sphinx themes. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- block doctype -%} + +{%- endblock %} +{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} +{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} +{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and + (sidebars != []) %} +{%- set url_root = pathto('', 1) %} +{# XXX necessary? #} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} +{%- if not embedded and docstitle %} + {%- set titlesuffix = " — "|safe + docstitle|e %} +{%- else %} + {%- set titlesuffix = "" %} +{%- endif %} + +{%- macro relbar() %} +
        +

        {{ _('Navigation') }}

        +
          + {%- for rellink in rellinks %} +
        • + {{ rellink[3] }} + {%- if not loop.first %}{{ reldelim2 }}{% endif %}
          • + {%- endfor %} + {%- block rootrellink %} +
        • {{ shorttitle|e }}{{ reldelim1 }}
          • + {%- endblock %} + {%- for parent in parents %} +
        • {{ parent.title }}{{ reldelim1 }}
          • + {%- endfor %} + {%- block relbaritems %} {% endblock %} +
        +
        +{%- endmacro %} + +{%- macro sidebar() %} + {%- if render_sidebar %} +
        +
        + {%- block sidebarlogo %} + {%- if logo %} + + {%- endif %} + {%- endblock %} + {%- if sidebars != None %} + {#- new style sidebar: explicitly include/exclude templates #} + {%- for sidebartemplate in sidebars %} + {%- include sidebartemplate %} + {%- endfor %} + {%- else %} + {#- old style sidebars: using blocks -- should be deprecated #} + {%- block sidebartoc %} + {%- include "localtoc.html" %} + {%- endblock %} + {%- block sidebarrel %} + {%- include "relations.html" %} + {%- endblock %} + {%- block sidebarsourcelink %} + {%- include "sourcelink.html" %} + {%- endblock %} + {%- if customsidebar %} + {%- include customsidebar %} + {%- endif %} + {%- block sidebarsearch %} + {%- include "searchbox.html" %} + {%- endblock %} + {%- endif %} +
        +
        + {%- endif %} +{%- endmacro %} + +{%- macro script() %} + + {%- for scriptfile in script_files %} + + {%- endfor %} +{%- endmacro %} + +{%- macro css() %} + + + {%- for cssfile in css_files %} + + {%- endfor %} +{%- endmacro %} + + + + + {{ metatags }} + {%- block htmltitle %} + {{ title|striptags|e }}{{ titlesuffix }} + {%- endblock %} + {{ css() }} + {%- if not embedded %} + {{ script() }} + {%- if use_opensearch %} + + {%- endif %} + {%- if favicon %} + + {%- endif %} + {%- endif %} +{%- block linktags %} + {%- if hasdoc('about') %} + + {%- endif %} + {%- if hasdoc('genindex') %} + + {%- endif %} + {%- if hasdoc('search') %} + + {%- endif %} + {%- if hasdoc('copyright') %} + + {%- endif %} + + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} +{%- endblock %} +{%- block extrahead %} {% endblock %} + + +{%- block header %}{% endblock %} + +{%- block relbar1 %}{{ relbar() }}{% endblock %} + +{%- block content %} + {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} + +
        + {%- block document %} +
        + {%- if render_sidebar %} +
        + {%- endif %} +
        + {% block body %} {% endblock %} +
        + {%- if render_sidebar %} +
        + {%- endif %} +
        + {%- endblock %} + + {%- block sidebar2 %}{{ sidebar() }}{% endblock %} +
        +
        +{%- endblock %} + +{%- block relbar2 %}{{ relbar() }}{% endblock %} + +{%- block footer %} +
        + {%- if show_copyright %} + {%- if hasdoc('copyright') %} + {% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- else %} + {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} + {%- endif %} + {%- endif %} + {%- if last_updated %} + {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} + {%- endif %} + {%- if show_sphinx %} + {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %} + {%- endif %} +
        +

        asdf asdf asdf asdf 22

        +{%- endblock %} + + + diff --git a/documentation/_themes/sphinx_rtd_theme/search.html b/documentation/_themes/sphinx_rtd_theme/search.html new file mode 100644 index 00000000..e3aa9b5c --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/search.html @@ -0,0 +1,50 @@ +{# + basic/search.html + ~~~~~~~~~~~~~~~~~ + + Template for the search page. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- extends "layout.html" %} +{% set title = _('Search') %} +{% set script_files = script_files + ['_static/searchtools.js'] %} +{% block footer %} + + {# this is used when loading the search index using $.ajax fails, + such as on Chrome for documents on localhost #} + + {{ super() }} +{% endblock %} +{% block body %} + + + {% if search_performed %} +

        {{ _('Search Results') }}

        + {% if not search_results %} +

        {{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}

        + {% endif %} + {% endif %} +
        + {% if search_results %} +
          + {% for href, caption, context in search_results %} +
        • + {{ caption }} +

          {{ context|e }}

          +
          • + {% endfor %} +
        + {% endif %} +
        +{% endblock %} diff --git a/documentation/_themes/sphinx_rtd_theme/searchbox.html b/documentation/_themes/sphinx_rtd_theme/searchbox.html new file mode 100644 index 00000000..35ad52c5 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/searchbox.html @@ -0,0 +1,9 @@ +{%- if builder != 'singlehtml' %} +
        +
        + + + +
        +
        +{%- endif %} diff --git a/documentation/_themes/sphinx_rtd_theme/static/css/badge_only.css b/documentation/_themes/sphinx_rtd_theme/static/css/badge_only.css new file mode 100644 index 00000000..7e17fb14 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/css/badge_only.css @@ -0,0 +1,2 @@ +.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}} +/*# sourceMappingURL=badge_only.css.map */ diff --git a/documentation/_themes/sphinx_rtd_theme/static/css/theme.css b/documentation/_themes/sphinx_rtd_theme/static/css/theme.css new file mode 100644 index 00000000..c865f138 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/css/theme.css @@ -0,0 +1,3886 @@ + +/* +*{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box} + +article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block} + +audio,canvas,video{display:inline-block; + *display:inline; + *zoom:1} + +audio:not([controls]){display:none} + +[hidden]{display:none} + +*{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box} + +html{font-size:80%; + -webkit-text-size-adjust:80%; + -ms-text-size-adjust:80%} +*/ + +body { margin: 0; } + +a:hover, a:active { outline: 0; } + +/* +abbr[title]{border-bottom:1px dotted} + +b,strong{font-weight:bold} + +blockquote{margin:0} + +dfn{font-style:italic} + +ins{background:#ff9; + color:#000; + text-decoration:none} + +mark{background:#ff0; + color:#000; + font-style:italic; + font-weight:bold} + +pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif; + _font-family:"courier new",monospace; + font-size:1em} + +pre{white-space:pre} + +q{quotes:none} + +q:before,q:after{content:""; + content:none} + +small{font-size:85%} + +sub,sup{font-size:75%; + line-height:0; + position:relative; + vertical-align:baseline} + +sup{top:-0.5em} + +sub{bottom:-0.25em} +*/ + +.wy-menu ul, +.wy-menu ol, +.wy-menu dl +{ + margin: 0; + padding: 0; + list-style: none; + list-style-image: none; +} + +.wy-menu li { list-style: none; } + +/* +dd{margin:0} + +img{border:0; + -ms-interpolation-mode:bicubic; + vertical-align:middle; + max-width:100%} + +svg:not(:root){overflow:hidden} + +figure{margin:0} + +form{margin:0} + +fieldset{border:0; + margin:0; + padding:0} + +label{cursor:pointer} + +legend{border:0; + *margin-left:-7px; + padding:0; + white-space:normal} + +button,input,select,textarea{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle} + +button,input{line-height:normal} + +button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer; + -webkit-appearance:button; + *overflow:visible} + +button[disabled],input[disabled]{cursor:default} + +input[type="checkbox"],input[type="radio"]{box-sizing:border-box; + padding:0; + *width:13px; + *height:13px} + +input[type="search"]{-webkit-appearance:textfield; + -moz-box-sizing:content-box; + -webkit-box-sizing:content-box; + box-sizing:content-box} + +input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none} + +button::-moz-focus-inner,input::-moz-focus-inner{border:0; + padding:0} + +textarea{overflow:auto; + vertical-align:top; + resize:vertical} + +.chromeframe{margin:0.2em 0; + background:#ccc; + color:#000; + padding:0.2em 0} + +.ir{display:block; + border:0; + text-indent:-999em; + overflow:hidden; + background-color:transparent; + background-repeat:no-repeat; + text-align:left; + direction:ltr; + *line-height:0} + +.ir br{display:none} + +.hidden{display:none !important; + visibility:hidden} + +.visuallyhidden{border:0; + clip:rect(0 0 0 0); + height:1px; + margin:-1px; + overflow:hidden; + padding:0; + position:absolute; + width:1px} + +.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto; + height:auto; + margin:0; + overflow:visible; + position:static; + width:auto} + +.invisible{visibility:hidden} + +.relative{position:relative} + +big,small{font-size:100%} + +@media print{html,body,section{background:none !important} + +*{box-shadow:none !important; + text-shadow:none !important; + filter:none !important; + -ms-filter:none !important} + +a,a:visited{text-decoration:underline} +*/ + +.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""} + +/* +pre,blockquote{page-break-inside:avoid} + +thead{display:table-header-group} + +tr,img{page-break-inside:avoid} + +img{max-width:100% !important} + +@page{margin:0.5cm} + +p,h2,.rst-content p.caption,h3{orphans:3; + widows:3} + +h2,.rst-content p.caption,h3{page-break-after:avoid} + +} +*/ + +.fa:before, +.wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before, +.rst-content h1 .headerlink:before, +.rst-content h2 .headerlink:before, +.rst-content p.caption .headerlink:before, +.rst-content h3 .headerlink:before, +.rst-content h4 .headerlink:before, +.rst-content h5 .headerlink:before, +.rst-content h6 .headerlink:before, +.rst-content dl dt .headerlink:before, +.rst-content tt.download span:first-child:before, +.rst-content code.download span:first-child:before, +.icon:before, +.wy-dropdown .caret:before, +.wy-inline-validate.wy-inline-validate-success .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before, +.wy-alert, +.btn, +input[type="text"], +input[type="password"], +input[type="email"], +input[type="url"], +input[type="date"], +input[type="month"], +input[type="time"], +input[type="datetime"], +input[type="datetime-local"], +input[type="week"], +input[type="number"], +input[type="search"], +input[type="tel"], +input[type="color"], +select, +textarea, +.wy-menu-vertical li.on a, +.wy-menu-vertical li.current>a, +.wy-side-nav-search>a, +.wy-side-nav-search .wy-dropdown>a, +.wy-nav-top a +{ -webkit-font-smoothing:antialiased; } + +/* +.clearfix{*zoom:1} + +.clearfix:before,.clearfix:after{display:table; + content:""} + +.clearfix:after{clear:both} +*/ + +/*! + * Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */ +@font-face { + font-family: 'FontAwesome'; + src: url("../fonts/fontawesome-webfont.eot?v=4.2.0"); + src: url("../fonts/fontawesome-webfont.eot?#iefix&v=4.2.0") format("embedded-opentype"), + url("../fonts/fontawesome-webfont.woff?v=4.2.0") format("woff"), + url("../fonts/fontawesome-webfont.ttf?v=4.2.0") format("truetype"), + url("../fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular") format("svg"); + font-weight: normal; + font-style: normal; +} + +.fa, +.wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +.rst-content h1 .headerlink, +.rst-content h2 .headerlink, +.rst-content h3 .headerlink, +.rst-content h4 .headerlink, +.rst-content h5 .headerlink, +.rst-content h6 .headerlink, +.rst-content dl dt .headerlink, +.rst-content p.caption .headerlink, +.rst-content tt.download span:first-child, +.rst-content code.download span:first-child, +.icon { + display: inline-block; + font: normal normal normal 14px/1 FontAwesome; + font-size: inherit; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +/* +.fa-lg{font-size:1.33333em; + line-height:0.75em; + vertical-align:-15%} + +.fa-2x{font-size:2em} + +.fa-3x{font-size:3em} + +.fa-4x{font-size:4em} + +.fa-5x{font-size:5em} + +.fa-fw{width:1.28571em; + text-align:center} + +.fa-ul{padding-left:0; + margin-left:2.14286em; + list-style-type:none} + +.fa-ul>li{position:relative} + +.fa-li{position:absolute; + left:-2.14286em; + width:2.14286em; + top:0.14286em; + text-align:center} + +.fa-li.fa-lg{left:-1.85714em} + +.fa-border{padding:.2em .25em .15em; + border:solid 0.08em #eee; + border-radius:.1em} + +.pull-right{float:right} + +.pull-left{float:left} +*/ + +/* +.rst-content .pull-left.admonition-title, +.rst-content h1 .pull-left.headerlink, +.rst-content h2 .pull-left.headerlink, +.rst-content p.caption .pull-left.headerlink, +.rst-content h3 .pull-left.headerlink, +.rst-content h4 .pull-left.headerlink, +.rst-content h5 .pull-left.headerlink, +.rst-content h6 .pull-left.headerlink, +.rst-content dl dt .pull-left.headerlink, +.rst-content tt.download span.pull-left:first-child, +.rst-content code.download span.pull-left:first-child, +*/ +.fa.pull-left, +.wy-menu-vertical li span.pull-left.toctree-expand, +.wy-menu-vertical li.on a span.pull-left.toctree-expand, +.wy-menu-vertical li.current>a span.pull-left.toctree-expand, +.pull-left.icon +{ margin-right:.3em; } + +/* +.rst-content .pull-right.admonition-title, +.rst-content h1 .pull-right.headerlink, +.rst-content h2 .pull-right.headerlink, +.rst-content p.caption .pull-right.headerlink, +.rst-content h3 .pull-right.headerlink, +.rst-content h4 .pull-right.headerlink, +.rst-content h5 .pull-right.headerlink, +.rst-content h6 .pull-right.headerlink, +.rst-content dl dt .pull-right.headerlink, +.rst-content tt.download span.pull-right:first-child, +.rst-content code.download span.pull-right:first-child, +*/ +.fa.pull-right, +.wy-menu-vertical li span.pull-right.toctree-expand, +.wy-menu-vertical li.on a span.pull-right.toctree-expand, +.wy-menu-vertical li.current>a span.pull-right.toctree-expand, +.pull-right.icon +{ margin-left:.3em; } + +/* +.fa-spin{-webkit-animation:fa-spin 2s infinite linear; + animation:fa-spin 2s infinite linear} + +@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg); + transform:rotate(0deg)} + +100%{-webkit-transform:rotate(359deg); + transform:rotate(359deg)} + +} + +@keyframes fa-spin{0%{-webkit-transform:rotate(0deg); + transform:rotate(0deg)} + +100%{-webkit-transform:rotate(359deg); + transform:rotate(359deg)} + +} + +.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1); + -webkit-transform:rotate(90deg); + -ms-transform:rotate(90deg); + transform:rotate(90deg)} + +.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2); + -webkit-transform:rotate(180deg); + -ms-transform:rotate(180deg); + transform:rotate(180deg)} + +.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3); + -webkit-transform:rotate(270deg); + -ms-transform:rotate(270deg); + transform:rotate(270deg)} + +.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0); + -webkit-transform:scale(-1, 1); + -ms-transform:scale(-1, 1); + transform:scale(-1, 1)} + +.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2); + -webkit-transform:scale(1, -1); + -ms-transform:scale(1, -1); + transform:scale(1, -1)} + +:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none} + +.fa-stack{position:relative; + display:inline-block; + width:2em; + height:2em; + line-height:2em; + vertical-align:middle} + +.fa-stack-1x,.fa-stack-2x{position:absolute; + left:0; + width:100%; + text-align:center} + +.fa-stack-1x{line-height:inherit} + +.fa-stack-2x{font-size:2em} + +.fa-inverse{color:#fff} +*/ + +.fa-glass:before{content:""} + +.fa-music:before{content:""} + +.fa-search:before,.icon-search:before{content:""} + +.fa-envelope-o:before{content:""} + +.fa-heart:before{content:""} + +.fa-star:before{content:""} + +.fa-star-o:before{content:""} + +.fa-user:before{content:""} + +.fa-film:before{content:""} + +.fa-th-large:before{content:""} + +.fa-th:before{content:""} + +.fa-th-list:before{content:""} + +.fa-check:before{content:""} + +.fa-remove:before,.fa-close:before,.fa-times:before{content:""} + +.fa-search-plus:before{content:""} + +.fa-search-minus:before{content:""} + +.fa-power-off:before{content:""} + +.fa-signal:before{content:""} + +.fa-gear:before,.fa-cog:before{content:""} + +.fa-trash-o:before{content:""} + +.fa-home:before,.icon-home:before { content: ""; } + +.fa-file-o:before{content:""} + +.fa-clock-o:before{content:""} + +.fa-road:before{content:""} + +.fa-download:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{content:""} + +.fa-arrow-circle-o-down:before{content:""} + +.fa-arrow-circle-o-up:before{content:""} + +.fa-inbox:before{content:""} + +.fa-play-circle-o:before{content:""} + +.fa-rotate-right:before,.fa-repeat:before{content:""} + +.fa-refresh:before{content:""} + +.fa-list-alt:before{content:""} + +.fa-lock:before{content:""} + +.fa-flag:before{content:""} + +.fa-headphones:before{content:""} + +.fa-volume-off:before{content:""} + +.fa-volume-down:before{content:""} + +.fa-volume-up:before{content:""} + +.fa-qrcode:before{content:""} + +.fa-barcode:before{content:""} + +.fa-tag:before{content:""} + +.fa-tags:before{content:""} + +.fa-book:before,.icon-book:before{content:""} + +.fa-bookmark:before{content:""} + +.fa-print:before{content:""} + +.fa-camera:before{content:""} + +.fa-font:before{content:""} + +.fa-bold:before{content:""} + +.fa-italic:before{content:""} + +.fa-text-height:before{content:""} + +.fa-text-width:before{content:""} + +.fa-align-left:before{content:""} + +.fa-align-center:before{content:""} + +.fa-align-right:before{content:""} + +.fa-align-justify:before{content:""} + +.fa-list:before{content:""} + +.fa-dedent:before,.fa-outdent:before{content:""} + +.fa-indent:before{content:""} + +.fa-video-camera:before{content:""} + +.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""} + +.fa-pencil:before{content:""} + +.fa-map-marker:before{content:""} + +.fa-adjust:before{content:""} + +.fa-tint:before{content:""} + +.fa-edit:before,.fa-pencil-square-o:before{content:""} + +.fa-share-square-o:before{content:""} + +.fa-check-square-o:before{content:""} + +.fa-arrows:before{content:""} + +.fa-step-backward:before{content:""} + +.fa-fast-backward:before{content:""} + +.fa-backward:before{content:""} + +.fa-play:before{content:""} + +.fa-pause:before{content:""} + +.fa-stop:before{content:""} + +.fa-forward:before{content:""} + +.fa-fast-forward:before{content:""} + +.fa-step-forward:before{content:""} + +.fa-eject:before{content:""} + +.fa-chevron-left:before{content:""} + +.fa-chevron-right:before{content:""} + +.fa-plus-circle:before{content:""} + +.fa-minus-circle:before{content:""} + +.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""} + +.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""} + +.fa-question-circle:before{content:""} + +.fa-info-circle:before{content:""} + +.fa-crosshairs:before{content:""} + +.fa-times-circle-o:before{content:""} + +.fa-check-circle-o:before{content:""} + +.fa-ban:before{content:""} + +.fa-arrow-left:before{content:""} + +.fa-arrow-right:before{content:""} + +.fa-arrow-up:before{content:""} + +.fa-arrow-down:before{content:""} + +.fa-mail-forward:before,.fa-share:before{content:""} + +.fa-expand:before{content:""} + +.fa-compress:before{content:""} + +.fa-plus:before{content:""} + +.fa-minus:before{content:""} + +.fa-asterisk:before{content:""} + +.fa-exclamation-circle:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before +{content:""} + +.fa-gift:before{content:""} + +.fa-leaf:before{content:""} + +.fa-fire:before,.icon-fire:before{content:""} + +.fa-eye:before{content:""} + +.fa-eye-slash:before{content:""} + +.fa-warning:before,.fa-exclamation-triangle:before{content:""} + +.fa-plane:before{content:""} + +.fa-calendar:before{content:""} + +.fa-random:before{content:""} + +.fa-comment:before{content:""} + +.fa-magnet:before{content:""} + +.fa-chevron-up:before{content:""} + +.fa-chevron-down:before{content:""} + +.fa-retweet:before{content:""} + +.fa-shopping-cart:before{content:""} + +.fa-folder:before{content:""} + +.fa-folder-open:before{content:""} + +.fa-arrows-v:before{content:""} + +.fa-arrows-h:before{content:""} + +.fa-bar-chart-o:before,.fa-bar-chart:before{content:""} + +.fa-twitter-square:before{content:""} + +.fa-facebook-square:before{content:""} + +.fa-camera-retro:before{content:""} + +.fa-key:before{content:""} + +.fa-gears:before,.fa-cogs:before{content:""} + +.fa-comments:before{content:""} + +.fa-thumbs-o-up:before{content:""} + +.fa-thumbs-o-down:before{content:""} + +.fa-star-half:before{content:""} + +.fa-heart-o:before{content:""} + +.fa-sign-out:before{content:""} + +.fa-linkedin-square:before{content:""} + +.fa-thumb-tack:before{content:""} + +.fa-external-link:before{content:""} + +.fa-sign-in:before{content:""} + +.fa-trophy:before{content:""} + +.fa-github-square:before{content:""} + +.fa-upload:before{content:""} + +.fa-lemon-o:before{content:""} + +.fa-phone:before{content:""} + +.fa-square-o:before{content:""} + +.fa-bookmark-o:before{content:""} + +.fa-phone-square:before{content:""} + +.fa-twitter:before{content:""} + +.fa-facebook:before{content:""} + +.fa-github:before,.icon-github:before{content:""} + +.fa-unlock:before{content:""} + +.fa-credit-card:before{content:""} + +.fa-rss:before{content:""} + +.fa-hdd-o:before{content:""} + +.fa-bullhorn:before{content:""} + +.fa-bell:before{content:""} + +.fa-certificate:before{content:""} + +.fa-hand-o-right:before{content:""} + +.fa-hand-o-left:before{content:""} + +.fa-hand-o-up:before{content:""} + +.fa-hand-o-down:before{content:""} + +.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""} + +.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""} + +.fa-arrow-circle-up:before{content:""} + +.fa-arrow-circle-down:before{content:""} + +.fa-globe:before{content:""} + +.fa-wrench:before{content:""} + +.fa-tasks:before{content:""} + +.fa-filter:before{content:""} + +.fa-briefcase:before{content:""} + +.fa-arrows-alt:before{content:""} + +.fa-group:before,.fa-users:before{content:""} + +.fa-chain:before,.fa-link:before,.icon-link:before{content:""} + +.fa-cloud:before{content:""} + +.fa-flask:before{content:""} + +.fa-cut:before,.fa-scissors:before{content:""} + +.fa-copy:before,.fa-files-o:before{content:""} + +.fa-paperclip:before{content:""} + +.fa-save:before,.fa-floppy-o:before{content:""} + +.fa-square:before{content:""} + +.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""} + +.fa-list-ul:before{content:""} + +.fa-list-ol:before{content:""} + +.fa-strikethrough:before{content:""} + +.fa-underline:before{content:""} + +.fa-table:before{content:""} + +.fa-magic:before{content:""} + +.fa-truck:before{content:""} + +.fa-pinterest:before{content:""} + +.fa-pinterest-square:before{content:""} + +.fa-google-plus-square:before{content:""} + +.fa-google-plus:before{content:""} + +.fa-money:before{content:""} + +.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""} + +.fa-caret-up:before{content:""} + +.fa-caret-left:before{content:""} + +.fa-caret-right:before{content:""} + +.fa-columns:before{content:""} + +.fa-unsorted:before,.fa-sort:before{content:""} + +.fa-sort-down:before,.fa-sort-desc:before{content:""} + +.fa-sort-up:before,.fa-sort-asc:before{content:""} + +.fa-envelope:before{content:""} + +.fa-linkedin:before{content:""} + +.fa-rotate-left:before,.fa-undo:before{content:""} + +.fa-legal:before,.fa-gavel:before{content:""} + +.fa-dashboard:before,.fa-tachometer:before{content:""} + +.fa-comment-o:before{content:""} + +.fa-comments-o:before{content:""} + +.fa-flash:before,.fa-bolt:before{content:""} + +.fa-sitemap:before{content:""} + +.fa-umbrella:before{content:""} + +.fa-paste:before,.fa-clipboard:before{content:""} + +.fa-lightbulb-o:before{content:""} + +.fa-exchange:before{content:""} + +.fa-cloud-download:before{content:""} + +.fa-cloud-upload:before{content:""} + +.fa-user-md:before{content:""} + +.fa-stethoscope:before{content:""} + +.fa-suitcase:before{content:""} + +.fa-bell-o:before{content:""} + +.fa-coffee:before{content:""} + +.fa-cutlery:before{content:""} + +.fa-file-text-o:before{content:""} + +.fa-building-o:before{content:""} + +.fa-hospital-o:before{content:""} + +.fa-ambulance:before{content:""} + +.fa-medkit:before{content:""} + +.fa-fighter-jet:before{content:""} + +.fa-beer:before{content:""} + +.fa-h-square:before{content:""} + +.fa-plus-square:before{content:""} + +.fa-angle-double-left:before{content:""} + +.fa-angle-double-right:before{content:""} + +.fa-angle-double-up:before{content:""} + +.fa-angle-double-down:before{content:""} + +.fa-angle-left:before{content:""} + +.fa-angle-right:before{content:""} + +.fa-angle-up:before{content:""} + +.fa-angle-down:before{content:""} + +.fa-desktop:before{content:""} + +.fa-laptop:before{content:""} + +.fa-tablet:before{content:""} + +.fa-mobile-phone:before,.fa-mobile:before{content:""} + +.fa-circle-o:before{content:""} + +.fa-quote-left:before{content:""} + +.fa-quote-right:before{content:""} + +.fa-spinner:before{content:""} + +.fa-circle:before{content:""} + +.fa-mail-reply:before,.fa-reply:before{content:""} + +.fa-github-alt:before{content:""} + +.fa-folder-o:before{content:""} + +.fa-folder-open-o:before{content:""} + +.fa-smile-o:before{content:""} + +.fa-frown-o:before{content:""} + +.fa-meh-o:before{content:""} + +.fa-gamepad:before{content:""} + +.fa-keyboard-o:before{content:""} + +.fa-flag-o:before{content:""} + +.fa-flag-checkered:before{content:""} + +.fa-terminal:before{content:""} + +.fa-code:before{content:""} + +.fa-mail-reply-all:before,.fa-reply-all:before{content:""} + +.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""} + +.fa-location-arrow:before{content:""} + +.fa-crop:before{content:""} + +.fa-code-fork:before{content:""} + +.fa-unlink:before,.fa-chain-broken:before{content:""} + +.fa-question:before{content:""} + +.fa-info:before{content:""} + +.fa-exclamation:before{content:""} + +.fa-superscript:before{content:""} + +.fa-subscript:before{content:""} + +.fa-eraser:before{content:""} + +.fa-puzzle-piece:before{content:""} + +.fa-microphone:before{content:""} + +.fa-microphone-slash:before{content:""} + +.fa-shield:before{content:""} + +.fa-calendar-o:before{content:""} + +.fa-fire-extinguisher:before{content:""} + +.fa-rocket:before{content:""} + +.fa-maxcdn:before{content:""} + +.fa-chevron-circle-left:before{content:""} + +.fa-chevron-circle-right:before{content:""} + +.fa-chevron-circle-up:before{content:""} + +.fa-chevron-circle-down:before{content:""} + +.fa-html5:before{content:""} + +.fa-css3:before{content:""} + +.fa-anchor:before{content:""} + +.fa-unlock-alt:before{content:""} + +.fa-bullseye:before{content:""} + +.fa-ellipsis-h:before{content:""} + +.fa-ellipsis-v:before{content:""} + +.fa-rss-square:before{content:""} + +.fa-play-circle:before{content:""} + +.fa-ticket:before{content:""} + +.fa-minus-square:before{content:""} + +.fa-minus-square-o:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before +{ content:""; } + +.fa-level-up:before{content:""} + +.fa-level-down:before{content:""} + +.fa-check-square:before{content:""} + +.fa-pencil-square:before{content:""} + +.fa-external-link-square:before{content:""} + +.fa-share-square:before{content:""} + +.fa-compass:before{content:""} + +.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""} + +.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""} + +.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""} + +.fa-euro:before,.fa-eur:before{content:""} + +.fa-gbp:before{content:""} + +.fa-dollar:before,.fa-usd:before{content:""} + +.fa-rupee:before,.fa-inr:before{content:""} + +.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""} + +.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""} + +.fa-won:before,.fa-krw:before{content:""} + +.fa-bitcoin:before,.fa-btc:before{content:""} + +.fa-file:before{content:""} + +.fa-file-text:before{content:""} + +.fa-sort-alpha-asc:before{content:""} + +.fa-sort-alpha-desc:before{content:""} + +.fa-sort-amount-asc:before{content:""} + +.fa-sort-amount-desc:before{content:""} + +.fa-sort-numeric-asc:before{content:""} + +.fa-sort-numeric-desc:before{content:""} + +.fa-thumbs-up:before{content:""} + +.fa-thumbs-down:before{content:""} + +.fa-youtube-square:before{content:""} + +.fa-youtube:before{content:""} + +.fa-xing:before{content:""} + +.fa-xing-square:before{content:""} + +.fa-youtube-play:before{content:""} + +.fa-dropbox:before{content:""} + +.fa-stack-overflow:before{content:""} + +.fa-instagram:before{content:""} + +.fa-flickr:before{content:""} + +.fa-adn:before{content:""} + +.fa-bitbucket:before,.icon-bitbucket:before{content:""} + +.fa-bitbucket-square:before{content:""} + +.fa-tumblr:before{content:""} + +.fa-tumblr-square:before{content:""} + +.fa-long-arrow-down:before{content:""} + +.fa-long-arrow-up:before{content:""} + +.fa-long-arrow-left:before{content:""} + +.fa-long-arrow-right:before{content:""} + +.fa-apple:before{content:""} + +.fa-windows:before{content:""} + +.fa-android:before{content:""} + +.fa-linux:before{content:""} + +.fa-dribbble:before{content:""} + +.fa-skype:before{content:""} + +.fa-foursquare:before{content:""} + +.fa-trello:before{content:""} + +.fa-female:before{content:""} + +.fa-male:before{content:""} + +.fa-gittip:before{content:""} + +.fa-sun-o:before{content:""} + +.fa-moon-o:before{content:""} + +.fa-archive:before{content:""} + +.fa-bug:before{content:""} + +.fa-vk:before{content:""} + +.fa-weibo:before{content:""} + +.fa-renren:before{content:""} + +.fa-pagelines:before{content:""} + +.fa-stack-exchange:before{content:""} + +.fa-arrow-circle-o-right:before{content:""} + +.fa-arrow-circle-o-left:before{content:""} + +.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""} + +.fa-dot-circle-o:before{content:""} + +.fa-wheelchair:before{content:""} + +.fa-vimeo-square:before{content:""} + +.fa-turkish-lira:before,.fa-try:before{content:""} + +.fa-plus-square-o:before, +.wy-menu-vertical li span.toctree-expand:before +{ content:""; } + +.fa-space-shuttle:before{content:""} + +.fa-slack:before{content:""} + +.fa-envelope-square:before{content:""} + +.fa-wordpress:before{content:""} + +.fa-openid:before{content:""} + +.fa-institution:before,.fa-bank:before,.fa-university:before{content:""} + +.fa-mortar-board:before,.fa-graduation-cap:before{content:""} + +.fa-yahoo:before{content:""} + +.fa-google:before{content:""} + +.fa-reddit:before{content:""} + +.fa-reddit-square:before{content:""} + +.fa-stumbleupon-circle:before{content:""} + +.fa-stumbleupon:before{content:""} + +.fa-delicious:before{content:""} + +.fa-digg:before{content:""} + +.fa-pied-piper:before{content:""} + +.fa-pied-piper-alt:before{content:""} + +.fa-drupal:before{content:""} + +.fa-joomla:before{content:""} + +.fa-language:before{content:""} + +.fa-fax:before{content:""} + +.fa-building:before{content:""} + +.fa-child:before{content:""} + +.fa-paw:before{content:""} + +.fa-spoon:before{content:""} + +.fa-cube:before{content:""} + +.fa-cubes:before{content:""} + +.fa-behance:before{content:""} + +.fa-behance-square:before{content:""} + +.fa-steam:before{content:""} + +.fa-steam-square:before{content:""} + +.fa-recycle:before{content:""} + +.fa-automobile:before,.fa-car:before{content:""} + +.fa-cab:before,.fa-taxi:before{content:""} + +.fa-tree:before{content:""} + +.fa-spotify:before{content:""} + +.fa-deviantart:before{content:""} + +.fa-soundcloud:before{content:""} + +.fa-database:before{content:""} + +.fa-file-pdf-o:before{content:""} + +.fa-file-word-o:before{content:""} + +.fa-file-excel-o:before{content:""} + +.fa-file-powerpoint-o:before{content:""} + +.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""} + +.fa-file-zip-o:before,.fa-file-archive-o:before{content:""} + +.fa-file-sound-o:before,.fa-file-audio-o:before{content:""} + +.fa-file-movie-o:before,.fa-file-video-o:before{content:""} + +.fa-file-code-o:before{content:""} + +.fa-vine:before{content:""} + +.fa-codepen:before{content:""} + +.fa-jsfiddle:before{content:""} + +.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""} + +.fa-circle-o-notch:before{content:""} + +.fa-ra:before,.fa-rebel:before{content:""} + +.fa-ge:before,.fa-empire:before{content:""} + +.fa-git-square:before{content:""} + +.fa-git:before{content:""} + +.fa-hacker-news:before{content:""} + +.fa-tencent-weibo:before{content:""} + +.fa-qq:before{content:""} + +.fa-wechat:before,.fa-weixin:before{content:""} + +.fa-send:before,.fa-paper-plane:before{content:""} + +.fa-send-o:before,.fa-paper-plane-o:before{content:""} + +.fa-history:before{content:""} + +.fa-circle-thin:before{content:""} + +.fa-header:before{content:""} + +.fa-paragraph:before{content:""} + +.fa-sliders:before{content:""} + +.fa-share-alt:before{content:""} + +.fa-share-alt-square:before{content:""} + +.fa-bomb:before{content:""} + +.fa-soccer-ball-o:before,.fa-futbol-o:before{content:""} + +.fa-tty:before{content:""} + +.fa-binoculars:before{content:""} + +.fa-plug:before{content:""} + +.fa-slideshare:before{content:""} + +.fa-twitch:before{content:""} + +.fa-yelp:before{content:""} + +.fa-newspaper-o:before{content:""} + +.fa-wifi:before{content:""} + +.fa-calculator:before{content:""} + +.fa-paypal:before{content:""} + +.fa-google-wallet:before{content:""} + +.fa-cc-visa:before{content:""} + +.fa-cc-mastercard:before{content:""} + +.fa-cc-discover:before{content:""} + +.fa-cc-amex:before{content:""} + +.fa-cc-paypal:before{content:""} + +.fa-cc-stripe:before{content:""} + +.fa-bell-slash:before{content:""} + +.fa-bell-slash-o:before{content:""} + +.fa-trash:before{content:""} + +.fa-copyright:before{content:""} + +.fa-at:before{content:""} + +.fa-eyedropper:before{content:""} + +.fa-paint-brush:before{content:""} + +.fa-birthday-cake:before{content:""} + +.fa-area-chart:before{content:""} + +.fa-pie-chart:before{content:""} + +.fa-line-chart:before{content:""} + +.fa-lastfm:before{content:""} + +.fa-lastfm-square:before{content:""} + +.fa-toggle-off:before{content:""} + +.fa-toggle-on:before{content:""} + +.fa-bicycle:before{content:""} + +.fa-bus:before{content:""} + +.fa-ioxhost:before{content:""} + +.fa-angellist:before{content:""} + +.fa-cc:before{content:""} + +.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:""} + +.fa-meanpath:before{content:""} + +/* +.rst-content h1 .headerlink, +.rst-content h2 .headerlink, +.rst-content p.caption .headerlink, +.rst-content h3 .headerlink, +.rst-content h4 .headerlink, +.rst-content h5 .headerlink, +.rst-content h6 .headerlink, +.rst-content dl dt .headerlink, +.rst-content tt.download span:first-child, +.rst-content code.download span:first-child, +*/ +.fa, +.wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +.icon, +.wy-dropdown .caret, +.wy-inline-validate.wy-inline-validate-success .wy-input-context, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context, +.wy-inline-validate.wy-inline-validate-info .wy-input-context +{ font-family: inherit; } + +/* +.rst-content h1 .headerlink:before, +.rst-content h2 .headerlink:before, +.rst-content p.caption .headerlink:before, +.rst-content h3 .headerlink:before, +.rst-content h4 .headerlink:before, +.rst-content h5 .headerlink:before, +.rst-content h6 .headerlink:before, +.rst-content dl dt .headerlink:before, +.rst-content tt.download span:first-child:before, +.rst-content code.download span:first-child:before, +*/ +.fa:before, +.wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li.on a span.toctree-expand:before, +.wy-menu-vertical li.current>a span.toctree-expand:before, +.icon:before, +.wy-dropdown .caret:before, +.wy-inline-validate.wy-inline-validate-success .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before, +.wy-inline-validate.wy-inline-validate-info .wy-input-context:before +{ + font-family: "FontAwesome"; + display: inline-block; + font-style: normal; + font-weight: normal; + line-height: 1; + text-decoration: inherit +} + +/* +a .rst-content h1 .headerlink, +.rst-content h1 a .headerlink, +a .rst-content h2 .headerlink, +.rst-content h2 a .headerlink, +a .rst-content p.caption .headerlink, +.rst-content p.caption a .headerlink, +a .rst-content h3 .headerlink, +.rst-content h3 a .headerlink, +a .rst-content h4 .headerlink, +.rst-content h4 a .headerlink, +a .rst-content h5 .headerlink, +.rst-content h5 a .headerlink, +a .rst-content h6 .headerlink, +.rst-content h6 a .headerlink, +a .rst-content dl dt .headerlink, +.rst-content dl dt a .headerlink, +a .rst-content tt.download span:first-child, +.rst-content tt.download a span:first-child, +a .rst-content code.download span:first-child, +.rst-content code.download a span:first-child, +*/ +a .fa, +a .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li a span.toctree-expand, +.wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.current>a span.toctree-expand, +a .icon +{ + display: inline-block; + text-decoration: inherit; +} + +.btn .fa, +.btn .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .btn span.toctree-expand, +.btn .wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.on a .btn span.toctree-expand, +.btn .wy-menu-vertical li.current>a span.toctree-expand, +.wy-menu-vertical li.current>a .btn span.toctree-expand, +.btn .rst-content .admonition-title, +.rst-content .btn .admonition-title, +.btn .rst-content h1 .headerlink, +.rst-content h1 .btn .headerlink, +.btn .rst-content h2 .headerlink, +.rst-content h2 .btn .headerlink, +.btn .rst-content p.caption .headerlink, +.rst-content p.caption .btn .headerlink, +.btn .rst-content h3 .headerlink, +.rst-content h3 .btn .headerlink, +.btn .rst-content h4 .headerlink, +.rst-content h4 .btn .headerlink, +.btn .rst-content h5 .headerlink, +.rst-content h5 .btn .headerlink, +.btn .rst-content h6 .headerlink, +.rst-content h6 .btn .headerlink, +.btn .rst-content dl dt .headerlink, +.rst-content dl dt .btn .headerlink, +.btn .rst-content tt.download span:first-child, +.rst-content tt.download .btn span:first-child, +.btn .rst-content code.download span:first-child, +.rst-content code.download .btn span:first-child, +.btn .icon, +.nav .fa, +.nav .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .nav span.toctree-expand, +.nav .wy-menu-vertical li.on a span.toctree-expand, +.wy-menu-vertical li.on a .nav span.toctree-expand, +.nav .wy-menu-vertical li.current>a span.toctree-expand, +.wy-menu-vertical li.current>a .nav span.toctree-expand, +.nav .rst-content .admonition-title, +.rst-content .nav .admonition-title, +.nav .rst-content h1 .headerlink, +.rst-content h1 .nav .headerlink, +.nav .rst-content h2 .headerlink, +.rst-content h2 .nav .headerlink, +.nav .rst-content p.caption .headerlink, +.rst-content p.caption .nav .headerlink, +.nav .rst-content h3 .headerlink, +.rst-content h3 .nav .headerlink, +.nav .rst-content h4 .headerlink, +.rst-content h4 .nav .headerlink, +.nav .rst-content h5 .headerlink, +.rst-content h5 .nav .headerlink, +.nav .rst-content h6 .headerlink, +.rst-content h6 .nav .headerlink, +.nav .rst-content dl dt .headerlink, +.rst-content dl dt .nav .headerlink, +.nav .rst-content tt.download span:first-child, +.rst-content tt.download .nav span:first-child, +.nav .rst-content code.download span:first-child, +.rst-content code.download .nav span:first-child, +.nav .icon +{ display: inline; } + +.btn .fa.fa-large, +.btn .wy-menu-vertical li span.fa-large.toctree-expand, +.wy-menu-vertical li .btn span.fa-large.toctree-expand, +.btn .rst-content .fa-large.admonition-title, +.rst-content .btn .fa-large.admonition-title, +.btn .rst-content h1 .fa-large.headerlink, +.rst-content h1 .btn .fa-large.headerlink, +.btn .rst-content h2 .fa-large.headerlink, +.rst-content h2 .btn .fa-large.headerlink, +.btn .rst-content p.caption .fa-large.headerlink, +.rst-content p.caption .btn .fa-large.headerlink, +.btn .rst-content h3 .fa-large.headerlink, +.rst-content h3 .btn .fa-large.headerlink, +.btn .rst-content h4 .fa-large.headerlink, +.rst-content h4 .btn .fa-large.headerlink, +.btn .rst-content h5 .fa-large.headerlink, +.rst-content h5 .btn .fa-large.headerlink, +.btn .rst-content h6 .fa-large.headerlink, +.rst-content h6 .btn .fa-large.headerlink, +.btn .rst-content dl dt .fa-large.headerlink, +.rst-content dl dt .btn .fa-large.headerlink, +.btn .rst-content tt.download span.fa-large:first-child, +.rst-content tt.download .btn span.fa-large:first-child, +.btn .rst-content code.download span.fa-large:first-child, +.rst-content code.download .btn span.fa-large:first-child, +.btn .fa-large.icon, +.nav .fa.fa-large, +.nav .wy-menu-vertical li span.fa-large.toctree-expand, +.wy-menu-vertical li .nav span.fa-large.toctree-expand, +.nav .rst-content .fa-large.admonition-title, +.rst-content .nav .fa-large.admonition-title, +.nav .rst-content h1 .fa-large.headerlink, +.rst-content h1 .nav .fa-large.headerlink, +.nav .rst-content h2 .fa-large.headerlink, +.rst-content h2 .nav .fa-large.headerlink, +.nav .rst-content p.caption .fa-large.headerlink, +.rst-content p.caption .nav .fa-large.headerlink, +.nav .rst-content h3 .fa-large.headerlink, +.rst-content h3 .nav .fa-large.headerlink, +.nav .rst-content h4 .fa-large.headerlink, +.rst-content h4 .nav .fa-large.headerlink, +.nav .rst-content h5 .fa-large.headerlink, +.rst-content h5 .nav .fa-large.headerlink, +.nav .rst-content h6 .fa-large.headerlink, +.rst-content h6 .nav .fa-large.headerlink, +.nav .rst-content dl dt .fa-large.headerlink, +.rst-content dl dt .nav .fa-large.headerlink, +.nav .rst-content tt.download span.fa-large:first-child, +.rst-content tt.download .nav span.fa-large:first-child, +.nav .rst-content code.download span.fa-large:first-child, +.rst-content code.download .nav span.fa-large:first-child, +.nav .fa-large.icon +{ line-height: 0.9em; } + +.btn .fa.fa-spin, +.btn .wy-menu-vertical li span.fa-spin.toctree-expand, +.wy-menu-vertical li .btn span.fa-spin.toctree-expand, +.btn .rst-content .fa-spin.admonition-title, +.rst-content .btn .fa-spin.admonition-title, +.btn .rst-content h1 .fa-spin.headerlink, +.rst-content h1 .btn .fa-spin.headerlink, +.btn .rst-content h2 .fa-spin.headerlink, +.rst-content h2 .btn .fa-spin.headerlink, +.btn .rst-content p.caption .fa-spin.headerlink, +.rst-content p.caption .btn .fa-spin.headerlink, +.btn .rst-content h3 .fa-spin.headerlink, +.rst-content h3 .btn .fa-spin.headerlink, +.btn .rst-content h4 .fa-spin.headerlink, +.rst-content h4 .btn .fa-spin.headerlink, +.btn .rst-content h5 .fa-spin.headerlink, +.rst-content h5 .btn .fa-spin.headerlink, +.btn .rst-content h6 .fa-spin.headerlink, +.rst-content h6 .btn .fa-spin.headerlink, +.btn .rst-content dl dt .fa-spin.headerlink, +.rst-content dl dt .btn .fa-spin.headerlink, +.btn .rst-content tt.download span.fa-spin:first-child, +.rst-content tt.download .btn span.fa-spin:first-child, +.btn .rst-content code.download span.fa-spin:first-child, +.rst-content code.download .btn span.fa-spin:first-child, +.btn .fa-spin.icon, +.nav .fa.fa-spin, +.nav .wy-menu-vertical li span.fa-spin.toctree-expand, +.wy-menu-vertical li .nav span.fa-spin.toctree-expand, +.nav .rst-content .fa-spin.admonition-title, +.rst-content .nav .fa-spin.admonition-title, +.nav .rst-content h1 .fa-spin.headerlink, +.rst-content h1 .nav .fa-spin.headerlink, +.nav .rst-content h2 .fa-spin.headerlink, +.rst-content h2 .nav .fa-spin.headerlink, +.nav .rst-content p.caption .fa-spin.headerlink, +.rst-content p.caption .nav .fa-spin.headerlink, +.nav .rst-content h3 .fa-spin.headerlink, +.rst-content h3 .nav .fa-spin.headerlink, +.nav .rst-content h4 .fa-spin.headerlink, +.rst-content h4 .nav .fa-spin.headerlink, +.nav .rst-content h5 .fa-spin.headerlink, +.rst-content h5 .nav .fa-spin.headerlink, +.nav .rst-content h6 .fa-spin.headerlink, +.rst-content h6 .nav .fa-spin.headerlink, +.nav .rst-content dl dt .fa-spin.headerlink, +.rst-content dl dt .nav .fa-spin.headerlink, +.nav .rst-content tt.download span.fa-spin:first-child, +.rst-content tt.download .nav span.fa-spin:first-child, +.nav .rst-content code.download span.fa-spin:first-child, +.rst-content code.download .nav span.fa-spin:first-child, +.nav .fa-spin.icon +{ display: inline-block; } + +.btn.fa:before, +.wy-menu-vertical li span.btn.toctree-expand:before, +.rst-content .btn.admonition-title:before, +.rst-content h1 .btn.headerlink:before, +.rst-content h2 .btn.headerlink:before, +.rst-content p.caption .btn.headerlink:before, +.rst-content h3 .btn.headerlink:before, +.rst-content h4 .btn.headerlink:before, +.rst-content h5 .btn.headerlink:before, +.rst-content h6 .btn.headerlink:before, +.rst-content dl dt .btn.headerlink:before, +.rst-content tt.download span.btn:first-child:before, +.rst-content code.download span.btn:first-child:before, +.btn.icon:before +{ + opacity: 0.5; + -webkit-transition: opacity 0.05s ease-in; + -moz-transition: opacity 0.05s ease-in; + transition: opacity 0.05s ease-in; +} + +.btn.fa:hover:before, +.wy-menu-vertical li span.btn.toctree-expand:hover:before, +.rst-content .btn.admonition-title:hover:before, +.rst-content h1 .btn.headerlink:hover:before, +.rst-content h2 .btn.headerlink:hover:before, +.rst-content p.caption .btn.headerlink:hover:before, +.rst-content h3 .btn.headerlink:hover:before, +.rst-content h4 .btn.headerlink:hover:before, +.rst-content h5 .btn.headerlink:hover:before, +.rst-content h6 .btn.headerlink:hover:before, +.rst-content dl dt .btn.headerlink:hover:before, +.rst-content tt.download span.btn:first-child:hover:before, +.rst-content code.download span.btn:first-child:hover:before, +.btn.icon:hover:before +{ opacity: 1; } + +.btn-mini .fa:before, +.btn-mini .wy-menu-vertical li span.toctree-expand:before, +.wy-menu-vertical li .btn-mini span.toctree-expand:before, +.btn-mini .rst-content .admonition-title:before, +.rst-content .btn-mini .admonition-title:before, +.btn-mini .rst-content h1 .headerlink:before, +.rst-content h1 .btn-mini .headerlink:before, +.btn-mini .rst-content h2 .headerlink:before, +.rst-content h2 .btn-mini .headerlink:before, +.btn-mini .rst-content p.caption .headerlink:before, +.rst-content p.caption .btn-mini .headerlink:before, +.btn-mini .rst-content h3 .headerlink:before, +.rst-content h3 .btn-mini .headerlink:before, +.btn-mini .rst-content h4 .headerlink:before, +.rst-content h4 .btn-mini .headerlink:before, +.btn-mini .rst-content h5 .headerlink:before, +.rst-content h5 .btn-mini .headerlink:before, +.btn-mini .rst-content h6 .headerlink:before, +.rst-content h6 .btn-mini .headerlink:before, +.btn-mini .rst-content dl dt .headerlink:before, +.rst-content dl dt .btn-mini .headerlink:before, +.btn-mini .rst-content tt.download span:first-child:before, +.rst-content tt.download .btn-mini span:first-child:before, +.btn-mini .rst-content code.download span:first-child:before, +.rst-content code.download .btn-mini span:first-child:before, +.btn-mini .icon:before +{ + font-size: 14px; + vertical-align: -15%; +} + +/* +.wy-alert{padding:12px; + line-height:24px; + margin-bottom:24px; + background:#e7f2fa} + +.wy-alert-title{color:#fff; + font-weight:bold; + display:block; + color:#fff; + background:#6ab0de; + margin:-12px; + padding:6px 12px; + margin-bottom:12px} + +.wy-alert.wy-alert-danger, +.rst-content .wy-alert-danger.note, +.rst-content .wy-alert-danger.attention, +.rst-content .wy-alert-danger.caution, +.rst-content .wy-alert-danger.hint, +.rst-content .wy-alert-danger.important, +.rst-content .wy-alert-danger.tip, +.rst-content .wy-alert-danger.warning, +.rst-content .wy-alert-danger.seealso, +.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2} + +.wy-alert.wy-alert-danger .wy-alert-title, +.rst-content .wy-alert-danger.note .wy-alert-title, +.rst-content .wy-alert-danger.attention .wy-alert-title, +.rst-content .wy-alert-danger.caution .wy-alert-title, +.rst-content .danger .wy-alert-title, +.rst-content .error .wy-alert-title, +.rst-content .wy-alert-danger.hint .wy-alert-title, +.rst-content .wy-alert-danger.important .wy-alert-title, +.rst-content .wy-alert-danger.tip .wy-alert-title, +.rst-content .wy-alert-danger.warning .wy-alert-title, +.rst-content .wy-alert-danger.seealso .wy-alert-title, +.rst-content .wy-alert-danger.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-danger .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-danger .admonition-title, +.rst-content .wy-alert-danger.note .admonition-title, +.rst-content .wy-alert-danger.attention .admonition-title, +.rst-content .wy-alert-danger.caution .admonition-title, +.rst-content .wy-alert-danger.hint .admonition-title, +.rst-content .wy-alert-danger.important .admonition-title, +.rst-content .wy-alert-danger.tip .admonition-title, +.rst-content .wy-alert-danger.warning .admonition-title, +.rst-content .wy-alert-danger.seealso .admonition-title, +.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97} + +.wy-alert.wy-alert-warning, +.rst-content .wy-alert-warning.note, +.rst-content .wy-alert-warning.danger, +.rst-content .wy-alert-warning.error, +.rst-content .wy-alert-warning.hint, +.rst-content .wy-alert-warning.important, +.rst-content .wy-alert-warning.tip, +.rst-content .wy-alert-warning.seealso +{background:#ffedcc} + +.wy-alert.wy-alert-warning .wy-alert-title, +.rst-content .wy-alert-warning.note .wy-alert-title, +.rst-content .attention .wy-alert-title, +.rst-content .caution .wy-alert-title, +.rst-content .wy-alert-warning.danger .wy-alert-title, +.rst-content .wy-alert-warning.error .wy-alert-title, +.rst-content .wy-alert-warning.hint .wy-alert-title, +.rst-content .wy-alert-warning.important .wy-alert-title, +.rst-content .wy-alert-warning.tip .wy-alert-title, +.rst-content .warning .wy-alert-title, +.rst-content .wy-alert-warning.seealso .wy-alert-title, +.rst-content .admonition-todo .wy-alert-title, +.wy-alert.wy-alert-warning .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-warning .admonition-title, +.rst-content .wy-alert-warning.note .admonition-title, +.rst-content .wy-alert-warning.danger .admonition-title, +.rst-content .wy-alert-warning.error .admonition-title, +.rst-content .wy-alert-warning.hint .admonition-title, +.rst-content .wy-alert-warning.important .admonition-title, +.rst-content .wy-alert-warning.tip .admonition-title, +.rst-content .wy-alert-warning.seealso .admonition-title +{background:#f0b37e} + +.wy-alert.wy-alert-info, +.rst-content .wy-alert-info.attention, +.rst-content .wy-alert-info.caution, +.rst-content .wy-alert-info.danger, +.rst-content .wy-alert-info.error, +.rst-content .wy-alert-info.hint, +.rst-content .wy-alert-info.important, +.rst-content .wy-alert-info.tip, +.rst-content .wy-alert-info.warning, +.rst-content .wy-alert-info.admonition-todo{background:#e7f2fa} + +.wy-alert.wy-alert-info .wy-alert-title, +.rst-content .note .wy-alert-title, +.rst-content .wy-alert-info.attention .wy-alert-title, +.rst-content .wy-alert-info.caution .wy-alert-title, +.rst-content .wy-alert-info.danger .wy-alert-title, +.rst-content .wy-alert-info.error .wy-alert-title, +.rst-content .wy-alert-info.hint .wy-alert-title, +.rst-content .wy-alert-info.important .wy-alert-title, +.rst-content .wy-alert-info.tip .wy-alert-title, +.rst-content .wy-alert-info.warning .wy-alert-title, +.rst-content .seealso .wy-alert-title, +.rst-content .wy-alert-info.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-info .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-info .admonition-title, +.rst-content .wy-alert-info.attention .admonition-title, +.rst-content .wy-alert-info.caution .admonition-title, +.rst-content .wy-alert-info.danger .admonition-title, +.rst-content .wy-alert-info.error .admonition-title, +.rst-content .wy-alert-info.hint .admonition-title, +.rst-content .wy-alert-info.important .admonition-title, +.rst-content .wy-alert-info.tip .admonition-title, +.rst-content .wy-alert-info.warning .admonition-title, +.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#6ab0de} + +.wy-alert.wy-alert-success, +.rst-content .wy-alert-success.note, +.rst-content .wy-alert-success.attention, +.rst-content .wy-alert-success.caution, +.rst-content .wy-alert-success.danger, +.rst-content .wy-alert-success.error, +.rst-content .wy-alert-success.warning, +.rst-content .wy-alert-success.seealso, +.rst-content .wy-alert-success.admonition-todo{background:#dbfaf4} + +.wy-alert.wy-alert-success .wy-alert-title, +.rst-content .wy-alert-success.note .wy-alert-title, +.rst-content .wy-alert-success.attention .wy-alert-title, +.rst-content .wy-alert-success.caution .wy-alert-title, +.rst-content .wy-alert-success.danger .wy-alert-title, +.rst-content .wy-alert-success.error .wy-alert-title, +.rst-content .hint .wy-alert-title, +.rst-content .important .wy-alert-title, +.rst-content .tip .wy-alert-title, +.rst-content .wy-alert-success.warning .wy-alert-title, +.rst-content .wy-alert-success.seealso .wy-alert-title, +.rst-content .wy-alert-success.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-success .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-success .admonition-title, +.rst-content .wy-alert-success.note .admonition-title, +.rst-content .wy-alert-success.attention .admonition-title, +.rst-content .wy-alert-success.caution .admonition-title, +.rst-content .wy-alert-success.danger .admonition-title, +.rst-content .wy-alert-success.error .admonition-title, +.rst-content .wy-alert-success.warning .admonition-title, +.rst-content .wy-alert-success.seealso .admonition-title, +.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#1abc9c} + +.wy-alert.wy-alert-neutral, +.rst-content .wy-alert-neutral.note, +.rst-content .wy-alert-neutral.attention, +.rst-content .wy-alert-neutral.caution, +.rst-content .wy-alert-neutral.danger, +.rst-content .wy-alert-neutral.error, +.rst-content .wy-alert-neutral.hint, +.rst-content .wy-alert-neutral.important, +.rst-content .wy-alert-neutral.tip, +.rst-content .wy-alert-neutral.warning, +.rst-content .wy-alert-neutral.seealso, +.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6} + +.wy-alert.wy-alert-neutral .wy-alert-title, +.rst-content .wy-alert-neutral.note .wy-alert-title, +.rst-content .wy-alert-neutral.attention .wy-alert-title, +.rst-content .wy-alert-neutral.caution .wy-alert-title, +.rst-content .wy-alert-neutral.danger .wy-alert-title, +.rst-content .wy-alert-neutral.error .wy-alert-title, +.rst-content .wy-alert-neutral.hint .wy-alert-title, +.rst-content .wy-alert-neutral.important .wy-alert-title, +.rst-content .wy-alert-neutral.tip .wy-alert-title, +.rst-content .wy-alert-neutral.warning .wy-alert-title, +.rst-content .wy-alert-neutral.seealso .wy-alert-title, +.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title, +.wy-alert.wy-alert-neutral .rst-content .admonition-title, +.rst-content .wy-alert.wy-alert-neutral .admonition-title, +.rst-content .wy-alert-neutral.note .admonition-title, +.rst-content .wy-alert-neutral.attention .admonition-title, +.rst-content .wy-alert-neutral.caution .admonition-title, +.rst-content .wy-alert-neutral.danger .admonition-title, +.rst-content .wy-alert-neutral.error .admonition-title, +.rst-content .wy-alert-neutral.hint .admonition-title, +.rst-content .wy-alert-neutral.important .admonition-title, +.rst-content .wy-alert-neutral.tip .admonition-title, +.rst-content .wy-alert-neutral.warning .admonition-title, +.rst-content .wy-alert-neutral.seealso .admonition-title, +.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040; + background:#e1e4e5} + +.wy-alert.wy-alert-neutral a, +.rst-content .wy-alert-neutral.note a, +.rst-content .wy-alert-neutral.attention a, +.rst-content .wy-alert-neutral.caution a, +.rst-content .wy-alert-neutral.danger a, +.rst-content .wy-alert-neutral.error a, +.rst-content .wy-alert-neutral.hint a, +.rst-content .wy-alert-neutral.important a, +.rst-content .wy-alert-neutral.tip a, +.rst-content .wy-alert-neutral.warning a, +.rst-content .wy-alert-neutral.seealso a, +.rst-content .wy-alert-neutral.admonition-todo a{color:#2980B9} + +.wy-alert p:last-child{margin-bottom:0} + +.wy-tray-container{position:fixed; + bottom:0px; + left:0; + z-index:600} + +.wy-tray-container li{display:block; + width:300px; + background:transparent; + color:#fff; + text-align:center; + box-shadow:0 5px 5px 0 rgba(0,0,0,0.1); + padding:0 24px; + min-width:20%; + opacity:0; + height:0; + line-height:56px; + overflow:hidden; + -webkit-transition:all 0.3s ease-in; + -moz-transition:all 0.3s ease-in; + transition:all 0.3s ease-in} + +.wy-tray-container li.wy-tray-item-success{background:#27AE60} + +.wy-tray-container li.wy-tray-item-info{background:#2980B9} + +.wy-tray-container li.wy-tray-item-warning{background:#E67E22} + +.wy-tray-container li.wy-tray-item-danger{background:#E74C3C} + +.wy-tray-container li.on{opacity:1; + height:56px} + +@media screen and (max-width: 768px){.wy-tray-container{bottom:auto; + top:0; + width:100%} + +.wy-tray-container li{width:100%} + +} + +button{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle; + cursor:pointer; + line-height:normal; + -webkit-appearance:button; + *overflow:visible} + +button::-moz-focus-inner,input::-moz-focus-inner{border:0; + padding:0} + +button[disabled]{cursor:default} +*/ + +a.btn, a.btn:link { + display: inline-block; + text-align: center; + cursor: pointer; + font-size: 110%; + font-weight: bold; + padding: 4pt; + margin-top: 10pt; + border: 2px solid black; + border-bottom: 2px solid black; +} + +a.btn:hover { + color: white; + background: black; +} + +/* +.btn { + display: inline-block; + border-radius: 2px; + line-height: normal; + white-space: nowrap; + text-align: center; + cursor: pointer; + font-size: 100%; + padding: 6px 12px 8px 12px; + color: #fff; + border: 1px solid rgba(0,0,0,0.1); + background-color: #27AE60; + text-decoration: none; + font-weight: normal; + font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + box-shadow: 0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset; + outline-none: false; + vertical-align: middle; + *display: inline; + zoom: 1; + -webkit-user-drag: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + -webkit-transition: all 0.1s linear; + -moz-transition: all 0.1s linear; + transition: all 0.1s linear; +} + +.btn-hover { background: #2e8ece; color: #fff; } +.btn:hover { background: #2cc36b; color: #fff; } +.btn:focus { background: #2cc36b; outline: 0; } + +.btn:active { + box-shadow: 0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset; + padding: 8px 12px 6px 12px; +} + +.btn:visited { color: #fff; } + +.btn:disabled { + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn-disabled { + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn-disabled:hover, +.btn-disabled:focus, +.btn-disabled:active +{ + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled = false); + filter: alpha(opacity=40); + opacity: 0.4; + cursor: not-allowed; + box-shadow: none; +} + +.btn::-moz-focus-inner { + padding: 0; + border: 0; +} + +.btn-small { font-size: 80%; } +.btn-info { background-color: #2980B9 !important; } +.btn-info:hover { background-color: #2e8ece !important; } +.btn-neutral { background-color: #f3f6f6 !important; color:#404040 !important; } +.btn-neutral:hover { background-color: #e5ebeb !important; color:#404040; } +.btn-neutral:visited { color: #404040 !important; } +.btn-success { background-color: #27AE60 !important; } +.btn-success:hover { background-color: #295 !important; } +.btn-danger { background-color: #E74C3C !important; } +.btn-danger:hover { background-color: #ea6153 !important; } +.btn-warning { background-color: #E67E22 !important; } +.btn-warning:hover { background-color: #e98b39 !important; } +.btn-invert { background-color: #222} +.btn-invert:hover { background-color: #2f2f2f !important; } + +.btn-link { + background-color: transparent !important; + color: #2980B9; + box-shadow: none; + border-color: transparent !important; +} + +.btn-link:hover { + background-color: transparent !important; + color: #409ad5 !important; + box-shadow: none; +} + +.btn-link:active { + background-color: transparent !important; + color: #409ad5 !important; + box-shadow: none; +} + +.btn-link:visited { color:#9B59B6; } + +.wy-btn-group .btn, +.wy-control .btn +{ vertical-align: middle; } + +.wy-btn-group { margin-bottom: 24px; *zoom:1; } + +.wy-btn-group:before, +.wy-btn-group:after +{ display:table; content: ""; } + +.wy-btn-group:after { clear: both; } + +.wy-dropdown{position:relative; + display:inline-block} + +.wy-dropdown-active .wy-dropdown-menu{display:block} + +.wy-dropdown-menu{position:absolute; + left:0; + display:none; + float:left; + top:100%; + min-width:100%; + background:#fcfcfc; + z-index:100; + border:solid 1px #cfd7dd; + box-shadow:0 2px 2px 0 rgba(0,0,0,0.1); + padding:12px} + +.wy-dropdown-menu>dd>a{display:block; + clear:both; + color:#404040; + white-space:nowrap; + font-size:90%; + padding:0 12px; + cursor:pointer} + +.wy-dropdown-menu>dd>a:hover{background:#2980B9; + color:#fff} + +.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd; + margin:6px 0} + +.wy-dropdown-menu>dd.search{padding-bottom:12px} + +.wy-dropdown-menu>dd.search input[type="search"]{width:100%} + +.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3; + text-transform:uppercase; + font-weight:500; + font-size:80%} + +.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3} + +.wy-dropdown-menu>dd.call-to-action .btn{color:#fff} + +.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%; + top:auto; + left:auto; + right:0} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc; + margin-top:2px} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px} + +.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980B9; + color:#fff} + +.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0; + left:auto; + text-align:right} + +.wy-dropdown-arrow:before{content:" "; + border-bottom:5px solid #f5f5f5; + border-left:5px solid transparent; + border-right:5px solid transparent; + position:absolute; + display:block; + top:-4px; + left:50%; + margin-left:-3px} + +.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px} + +.wy-form-stacked select{display:block} + +.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block; + *display:inline; + *zoom:1; + vertical-align:middle} + +.wy-form-aligned .wy-control-group>label{display:inline-block; + vertical-align:middle; + width:10em; + margin:6px 12px 0 0; + float:left} + +.wy-form-aligned .wy-control{float:left} + +.wy-form-aligned .wy-control label{display:block} + +.wy-form-aligned .wy-control select{margin-top:6px} + +fieldset{border:0; + margin:0; + padding:0} + +legend{display:block; + width:100%; + border:0; + padding:0; + white-space:normal; + margin-bottom:24px; + font-size:150%; + *margin-left:-7px} + +label{display:block; + margin:0 0 0.3125em 0; + color:#333; + font-size:90%} + +input,select,textarea{font-size:100%; + margin:0; + vertical-align:baseline; + *vertical-align:middle} + +.wy-control-group{margin-bottom:24px; + *zoom:1; + max-width:68em; + margin-left:auto; + margin-right:auto; + *zoom:1} + +.wy-control-group:before,.wy-control-group:after{display:table; + content:""} + +.wy-control-group:after{clear:both} + +.wy-control-group:before,.wy-control-group:after{display:table; + content:""} + +.wy-control-group:after{clear:both} + +.wy-control-group.wy-control-group-required>label:after{content:" *"; + color:#E74C3C} + +.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px} + +.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%} + +.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%} + +.wy-control-group .wy-form-full{float:left; + display:block; + margin-right:2.35765%; + width:100%; + margin-right:0} + +.wy-control-group .wy-form-full:last-child{margin-right:0} + +.wy-control-group .wy-form-halves{float:left; + display:block; + margin-right:2.35765%; + width:48.82117%} + +.wy-control-group .wy-form-halves:last-child{margin-right:0} + +.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0} + +.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left} + +.wy-control-group .wy-form-thirds{float:left; + display:block; + margin-right:2.35765%; + width:31.76157%} + +.wy-control-group .wy-form-thirds:last-child{margin-right:0} + +.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0} + +.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left} + +.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0; + font-size:90%} + +.wy-control-no-input{display:inline-block; + margin:6px 0 0 0; + font-size:90%} + +.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%} + +.wy-form-message-inline{display:inline-block; + padding-left:0.3em; + color:#666; + vertical-align:middle; + font-size:90%} + +.wy-form-message{display:block; + color:#999; + font-size:70%; + margin-top:0.3125em; + font-style:italic} + +.wy-form-message p{font-size:inherit; + font-style:italic; + margin-bottom:6px} + +.wy-form-message p:last-child{margin-bottom:0} + +input{line-height:normal} + +input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button; + cursor:pointer; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + *overflow:visible} + +input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none; + padding:6px; + display:inline-block; + border:1px solid #ccc; + font-size:80%; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + box-shadow:inset 0 1px 3px #ddd; + border-radius:0; + -webkit-transition:border 0.3s linear; + -moz-transition:border 0.3s linear; + transition:border 0.3s linear} + +input[type="datetime-local"]{padding:0.34375em 0.625em} + +input[disabled]{cursor:default} + +input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box; + padding:0; + margin-right:0.3125em; + *height:13px; + *width:13px} +*/ + +input[type="search"] { + -webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box +} + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none +} + +input[type="text"]:focus, +input[type="password"]:focus, +input[type="email"]:focus, +input[type="url"]:focus, +input[type="date"]:focus, +input[type="month"]:focus, +input[type="time"]:focus, +input[type="datetime"]:focus, +input[type="datetime-local"]:focus, +input[type="week"]:focus, +input[type="number"]:focus, +input[type="search"]:focus, +input[type="tel"]:focus, +input[type="color"]:focus$ +{ + outline: 0; + outline: thin dotted \9; + border-color: #333 +} + +/* +input.no-focus:focus{border-color:#ccc !important} + +input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333; + outline:1px auto #129FEA} + +input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed; + background-color:#fafafa} + +input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C; + border:1px solid #E74C3C} + +input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C} + +input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C} + +input.wy-input-large{padding:12px; + font-size:100%} + +textarea{overflow:auto; + vertical-align:top; + width:100%; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif} + +select,textarea{padding:0.5em 0.625em; + display:inline-block; + border:1px solid #ccc; + font-size:80%; + box-shadow:inset 0 1px 3px #ddd; + -webkit-transition:border 0.3s linear; + -moz-transition:border 0.3s linear; + transition:border 0.3s linear} + +select{border:1px solid #ccc; + background-color:#fff} + +select[multiple]{height:auto} + +select:focus,textarea:focus{outline:0} + +select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed; + background-color:#fafafa} + +input[type="radio"][disabled],input[type="checkbox"][disabled]{cursor:not-allowed} + +.wy-checkbox,.wy-radio{margin:6px 0; + color:#404040; + display:block} + +.wy-checkbox input,.wy-radio input{vertical-align:baseline} + +.wy-form-message-inline{display:inline-block; + *display:inline; + *zoom:1; + vertical-align:middle} + +.wy-input-prefix,.wy-input-suffix{white-space:nowrap; + padding:6px} + +.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px; + padding:0 8px; + display:inline-block; + font-size:80%; + background-color:#f3f6f6; + border:solid 1px #ccc; + color:#999} + +.wy-input-suffix .wy-input-context{border-left:0} + +.wy-input-prefix .wy-input-context{border-right:0} + +.wy-switch{width:36px; + height:12px; + margin:12px 0; + position:relative; + border-radius:4px; + background:#ccc; + cursor:pointer; + -webkit-transition:all 0.2s ease-in-out; + -moz-transition:all 0.2s ease-in-out; + transition:all 0.2s ease-in-out} + +.wy-switch:before{position:absolute; + content:""; + display:block; + width:18px; + height:18px; + border-radius:4px; + background:#999; + left:-3px; + top:-3px; + -webkit-transition:all 0.2s ease-in-out; + -moz-transition:all 0.2s ease-in-out; + transition:all 0.2s ease-in-out} + +.wy-switch:after{content:"false"; + position:absolute; + left:48px; + display:block; + font-size:12px; + color:#ccc} + +.wy-switch.active{background:#1e8449} + +.wy-switch.active:before{left:24px; + background:#27AE60} + +.wy-switch.active:after{content:"true"} + +.wy-switch.disabled,.wy-switch.active.disabled{cursor:not-allowed} + +.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C} + +.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C} + +.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C} + +.wy-inline-validate{white-space:nowrap} + +.wy-inline-validate .wy-input-context{padding:0.5em 0.625em; + display:inline-block; + font-size:80%} + +.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60} + +.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C} + +.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22} + +.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980B9} + +.rotate-90{-webkit-transform:rotate(90deg); + -moz-transform:rotate(90deg); + -ms-transform:rotate(90deg); + -o-transform:rotate(90deg); + transform:rotate(90deg)} + +.rotate-180{-webkit-transform:rotate(180deg); + -moz-transform:rotate(180deg); + -ms-transform:rotate(180deg); + -o-transform:rotate(180deg); + transform:rotate(180deg)} + +.rotate-270{-webkit-transform:rotate(270deg); + -moz-transform:rotate(270deg); + -ms-transform:rotate(270deg); + -o-transform:rotate(270deg); + transform:rotate(270deg)} + +.mirror{-webkit-transform:scaleX(-1); + -moz-transform:scaleX(-1); + -ms-transform:scaleX(-1); + -o-transform:scaleX(-1); + transform:scaleX(-1)} + +.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg); + -moz-transform:scaleX(-1) rotate(90deg); + -ms-transform:scaleX(-1) rotate(90deg); + -o-transform:scaleX(-1) rotate(90deg); + transform:scaleX(-1) rotate(90deg)} + +.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg); + -moz-transform:scaleX(-1) rotate(180deg); + -ms-transform:scaleX(-1) rotate(180deg); + -o-transform:scaleX(-1) rotate(180deg); + transform:scaleX(-1) rotate(180deg)} + +.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg); + -moz-transform:scaleX(-1) rotate(270deg); + -ms-transform:scaleX(-1) rotate(270deg); + -o-transform:scaleX(-1) rotate(270deg); + transform:scaleX(-1) rotate(270deg)} + +@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0} + +.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em; + display:block} + +.wy-form label{margin-bottom:0.3em; + display:block} + +.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0} + +.wy-form-aligned .wy-control-group label{margin-bottom:0.3em; + text-align:left; + display:block; + width:100%} + +.wy-form-aligned .wy-control{margin:1.5em 0 0 0} + +.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block; + font-size:80%; + padding:6px 0} + +} + +@media screen and (max-width: 768px){.tablet-hide{display:none} + +} + +@media screen and (max-width: 480px){.mobile-hide{display:none} + +} +*/ + +.float-left { float: left; } +.float-right { float: right; } +.full-width { width: 100%; } + +/* +.wy-table{border-collapse:collapse; + border-spacing:0; + empty-cells:show; + margin-bottom:24px} + +.wy-table caption{color:#000; + font:italic 85%/1 arial,sans-serif; + padding:1em 0; + text-align:center} + +.wy-table td,.wy-table th{font-size:90%; + margin:0; + overflow:visible; + padding:8px 16px} + +.wy-table td:first-child,.wy-table th:first-child{border-left-width:0} + +.wy-table thead{color:#000; + text-align:left; + vertical-align:bottom; + white-space:nowrap} + +.wy-table thead th{font-weight:bold; + border-bottom:solid 2px #e1e4e5} + +.wy-table td{background-color:transparent; + vertical-align:middle} + +.wy-table td p{line-height:18px} + +.wy-table td p:last-child{margin-bottom:0} + +.wy-table .wy-table-cell-min{width:1%; + padding-right:0} + +.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0} + +.wy-table-secondary{color:gray; + font-size:90%} + +.wy-table-tertiary{color:gray; + font-size:80%} + +.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6} + +.wy-table-backed{background-color:#f3f6f6} + +.wy-table-bordered-all{border:1px solid #e1e4e5} + +.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5; + border-left:1px solid #e1e4e5} + +.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-bordered{border:1px solid #e1e4e5} + +.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5} + +.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0; + border-bottom:1px solid #e1e4e5} + +.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0} + +.wy-table-responsive{margin-bottom:24px; + max-width:100%; + overflow:auto} + +.wy-table-responsive table{margin-bottom:0 !important} + +.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap} +*/ + +a { + color: #2980B9; + text-decoration: none; + cursor: pointer; +} + +a:hover { color: #3091d1; } +a:visited { color: #9B59B6; } + +a.headerlink, +a.headerlink:link, +a.headerlink:active, +a.headerlink:focus, +a.headerlink:visited +{ + padding-left: 4pt; + border-bottom: none; +} + +html { + height: 100%; + overflow-x: hidden; +} + +body { + font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + font-weight: normal; + color: #404040; + min-height: 100%; + overflow-x: hidden; + background: #edf0f2; +} + +/* +.wy-text-left{text-align:left} + +.wy-text-center{text-align:center} + +.wy-text-right{text-align:right} + +.wy-text-large{font-size:120%} + +.wy-text-normal{font-size:100%} + +.wy-text-small,small{font-size:80%} + +.wy-text-strike{text-decoration:line-through} + +.wy-text-warning{color:#E67E22 !important} + +a.wy-text-warning:hover{color:#eb9950 !important} + +.wy-text-info{color:#2980B9 !important} + +a.wy-text-info:hover{color:#409ad5 !important} + +.wy-text-success{color:#27AE60 !important} + +a.wy-text-success:hover{color:#36d278 !important} + +.wy-text-danger{color:#E74C3C !important} + +a.wy-text-danger:hover{color:#ed7669 !important} + +.wy-text-neutral{color:#404040 !important} + +a.wy-text-neutral:hover{color:#595959 !important} + +h1,h2,.rst-content p.caption,h3,h4,h5,h6,legend{margin-top:0; + font-weight:700; + font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif} + +p{line-height:24px; + margin:0; + font-size:16px; + margin-bottom:24px} + +h1{font-size:175%} + +h2,.rst-content p.caption{font-size:150%} + +h3{font-size:125%} + +h4{font-size:115%} + +h5{font-size:110%} + +h6{font-size:100%} + +hr{display:block; + height:1px; + border:0; + border-top:1px solid #e1e4e5; + margin:24px 0; + padding:0} + +code,.rst-content tt,.rst-content code{white-space:nowrap; + max-width:100%; + background:#fff; + border:solid 1px #e1e4e5; + font-size:75%; + padding:0 5px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + color:#E74C3C; + overflow-x:auto} + +code.code-large,.rst-content tt.code-large{font-size:90%} + +.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc; + line-height:24px; + margin-bottom:24px} + +.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc; + margin-left:24px} + +.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0} + +.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0} + +.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle} + +.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square} + +.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal} + +.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal; + line-height:24px; + margin-bottom:24px} + +.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal; + margin-left:24px} + +.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0} + +.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0} + +.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc} + +.codeblock-example{border:1px solid #e1e4e5; + border-bottom:none; + padding:24px; + padding-top:48px; + font-weight:500; + background:#fff; + position:relative} + +.codeblock-example:after{content:"Example"; + position:absolute; + top:0px; + left:0px; + background:#9B59B6; + color:#fff; + padding:6px 12px} + +.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5; + margin-bottom:24px} + +.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5; + padding:0px; + overflow-x:auto; + background:#fff; + margin:1px 0 24px 0} + +.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none; + background:none; + margin:0} + +div[class^='highlight'] td.code{width:100%} + +.linenodiv pre{border-right:solid 1px #e6e9ea; + margin:0; + padding:12px 12px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + font-size:12px; + line-height:1.5; + color:#d9d9d9} + +div[class^='highlight'] pre{white-space:pre; + margin:0; + padding:12px 12px; + font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace; + font-size:12px; + line-height:1.5; + display:block; + overflow:auto; + color:#404040} + +@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap} + +} + +.hll{background-color:#ffc; + margin:0 -12px; + padding:0 12px; + display:block} + +.c{color:#998; + font-style:italic} + +.err{color:#a61717; + background-color:#e3d2d2} + +.k{font-weight:bold} + +.o{font-weight:bold} + +.cm{color:#998; + font-style:italic} + +.cp{color:#999; + font-weight:bold} + +.c1{color:#998; + font-style:italic} + +.cs{color:#999; + font-weight:bold; + font-style:italic} + +.gd{color:#000; + background-color:#fdd} + +.gd .x{color:#000; + background-color:#faa} + +.ge{font-style:italic} + +.gr{color:#a00} + +.gh{color:#999} + +.gi{color:#000; + background-color:#dfd} + +.gi .x{color:#000; + background-color:#afa} + +.go{color:#888} + +.gp{color:#555} + +.gs{font-weight:bold} + +.gu{color:purple; + font-weight:bold} + +.gt{color:#a00} + +.kc{font-weight:bold} + +.kd{font-weight:bold} + +.kn{font-weight:bold} + +.kp{font-weight:bold} + +.kr{font-weight:bold} + +.kt{color:#458; + font-weight:bold} + +.m{color:#099} + +.s{color:#d14} + +.n{color:#333} + +.na{color:teal} + +.nb{color:#0086b3} + +.nc{color:#458; + font-weight:bold} + +.no{color:teal} + +.ni{color:purple} + +.ne{color:#900; + font-weight:bold} + +.nf{color:#900; + font-weight:bold} + +.nn{color:#555} + +.nt{color:navy} + +.nv{color:teal} + +.ow{font-weight:bold} + +.w{color:#bbb} + +.mf{color:#099} + +.mh{color:#099} + +.mi{color:#099} + +.mo{color:#099} + +.sb{color:#d14} +*/ + +/*.sc{color:#d14}*/ + +/* +.sd{color:#d14} + +.s2{color:#d14} + +.se{color:#d14} + +.sh{color:#d14} + +.si{color:#d14} + +.sx{color:#d14} + +.sr{color:#009926} + +.s1{color:#d14} + +.ss{color:#990073} + +.bp{color:#999} + +.vc{color:teal} + +.vg{color:teal} + +.vi{color:teal} + +.il{color:#099} + +.gc{color:#999; + background-color:#EAF2F5} +*/ + +ul.wy-breadcrumbs { + padding: 0pt; + margin: 0pt; + font-size: 90%; +} + +.wy-breadcrumbs li { display: inline-block; } +.wy-breadcrumbs li.wy-breadcrumbs-aside { float: right; } + +.wy-breadcrumbs li a { + display: inline-block; + padding: 5px; + border-bottom: none; +} + +.wy-breadcrumbs li a:first-child { padding-left: 0; } + +.wy-breadcrumbs-extra { + margin-bottom: 0; + color: #b3b3b3; + font-size: 80%; + display: inline-block; +} + +@media screen and (max-width: 480px) { + .wy-breadcrumbs-extra { display: none; } + .wy-breadcrumbs li.wy-breadcrumbs-aside { display: none; } +} + +@media print { + .wy-breadcrumbs li.wy-breadcrumbs-aside { display: none; } +} + +/* +.wy-affix{position:fixed; + top:1.618em} +*/ + +.wy-menu a:hover { text-decoration: none; } + +/* +.wy-menu-horiz{*zoom:1} + +.wy-menu-horiz:before,.wy-menu-horiz:after{display:table; + content:""} + +.wy-menu-horiz:after{clear:both} + +.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block} + +.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)} + +.wy-menu-horiz li.divide-left{border-left:solid 1px #404040} + +.wy-menu-horiz li.divide-right{border-right:solid 1px #404040} + +.wy-menu-horiz a{height:32px; + display:inline-block; + line-height:32px; + padding:0 16px} +*/ + +.wy-menu-vertical header, +.wy-menu-vertical p.caption +{ + height: 32px; + display: inline-block; + line-height: 32px; + padding: 0 1.618em; + margin-bottom: 0; + display: block; + font-weight: bold; + text-transform: uppercase; + font-size: 80%; + color: #555; + white-space: nowrap; +} + +div.wy-menu-vertical ul { margin-bottom: 0; } +div.wy-menu-vertical li.divide-top { border-top: solid 1px #404040; } +div.wy-menu-vertical li.divide-bottom { border-bottom: solid 1px #404040; } +div.wy-menu-vertical li.current { background: #e3e3e3; } + +div.wy-menu-vertical li.current a { + color: black; + border-right: solid 1px #c9c9c9; + padding: 0.4045em 2.427em; +} + +div.wy-menu-vertical li.current a:hover { background:#d6d6d6; } + +div.wy-menu-vertical li code, +div.wy-menu-vertical li .rst-content tt, +.rst-content div.wy-menu-vertical li tt +{ + border: none; + background: inherit; + color: inherit; + padding-left: 0; + padding-right: 0 +} + +div.wy-menu-vertical li span.toctree-expand { + display: block; + float: left; + margin-left: -1.2em; + font-size: 0.8em; + line-height: 1.6em; + color: #4d4d4d; +} + +div.wy-menu-vertical li.on a, +div.wy-menu-vertical li.current>a +{ +/* + color: #404040; + */ + color: black; + background: #fcfcfc; + padding: 0.4045em 1.618em; + font-weight: bold; + position: relative; + border: none; + border-bottom: solid 1px #c9c9c9; + border-top: solid 1px #c9c9c9; + padding-left: 1.618em -4px; +} + +div.wy-menu-vertical li.on a:hover, +div.wy-menu-vertical li.current>a:hover +{ background: #fcfcfc; } + +div.wy-menu-vertical li.on a:hover span.toctree-expand, +div.wy-menu-vertical li.current>a:hover span.toctree-expand +{ color: gray; } + +div.wy-menu-vertical li.on a span.toctree-expand, +div.wy-menu-vertical li.current>a span.toctree-expand +{ + display: block; + font-size: 0.8em; + line-height: 1.6em; + color: #333; +} + +div.wy-menu-vertical li.toctree-l1.current li.toctree-l2>ul, +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3>ul +{ display:none; } + +div.wy-menu-vertical li.toctree-l1.current li.toctree-l2.current>ul, +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current>ul +{ display:block; } + +div.wy-menu-vertical li.toctree-l2.current>a { + background: #c9c9c9; + padding: 0.4045em 2.427em; +} + +div.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a { + display: block; + background: #c9c9c9; + padding: 0.4045em 4.045em +} + +div.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand { color: gray; } +div.wy-menu-vertical li.toctree-l2 span.toctree-expand { color: #a3a3a3; } + +div.wy-menu-vertical li.toctree-l3 {font-size: 0.9em; } + +div.wy-menu-vertical li.toctree-l3.current>a { + background: #bdbdbd; + padding: 0.4045em 4.045em; +} + +div.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a { + display: block; + background: #bdbdbd; + padding: 0.4045em 5.663em; + border-top: none; + border-bottom: none; +} + +div.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand { color: gray; } +div.wy-menu-vertical li.toctree-l3 span.toctree-expand { color: #969696; } +div.wy-menu-vertical li.toctree-l4 { font-size: 0.9em; } +div.wy-menu-vertical li.current ul { display: block; } + +div.wy-menu-vertical li ul { + margin-bottom: 0; + display: none; +} + +div.wy-menu-vertical .local-toc li ul { display: block; } + +div.wy-menu-vertical li ul li a { + margin-bottom: 0; + color: #b3b3b3; + font-weight: normal; +} + +div.wy-menu-vertical a { + display: inline-block; + line-height: 18px; + padding: 0.4045em 1.618em; + border-bottom: none; + display: block; + position: relative; + font-size: 90%; + color: #b3b3b3; +} + +div.wy-menu-vertical a:hover { + background-color: #4e4a4a; + cursor: pointer; + border-bottom: none; +} + +div.wy-menu-vertical a:hover span.toctree-expand { color: #b3b3b3; } + +div.wy-menu-vertical a:active { + background-color: #2980B9; + cursor: pointer; + color: #fff; +} + +div.wy-menu-vertical a:active span.toctree-expand { color: #fff; } + +.wy-side-nav-search { + z-index: 200; +/*background-color: #2980B9;*/ + background-color: #7aa2f3; + text-align: center; + padding: 0.809em; + display: block; + color: #fcfcfc; + margin-bottom: 0.809em; +} + +.wy-side-nav-search input[type=text] { + width: 80%; + border-radius: 50px; + padding: 6px 12px; + border-color: #2472a4; + font-size: 90%; +} + +.wy-side-nav-search img { + display: block; + margin: auto auto 0.809em auto; + height: 45px; + width: 45px; + background-color: #2980B9; + padding: 5px; + border-radius: 100%; +} + +div.wy-side-nav-search>a, +div.wy-side-nav-search .wy-dropdown>a +{ + color: #fcfcfc; + font-size: 120%; + font-weight: bold; + display: inline-block; + padding: 4px 6px; + margin-bottom: 0.809em; + border-bottom: none; + outline: 0; +} + +/* +.wy-side-nav-search>a:hover, +.wy-side-nav-search .wy-dropdown>a:hover { + background: rgba(255,255,255,0.1); +} +*/ + +.wy-side-nav-search>a img.logo, +.wy-side-nav-search .wy-dropdown>a img.logo +{ + display: block; + margin: 0 auto; + height: auto; + width: auto; + border-radius: 0; + max-width: 100%; + background: transparent; +} + +.wy-side-nav-search>a.icon img.logo, +.wy-side-nav-search .wy-dropdown>a.icon img.logo +{ + margin-top: 0.85em; +} + +.wy-nav .wy-menu-vertical header { color: #2980B9; } +.wy-nav .wy-menu-vertical a { color: #b3b3b3; } + +.wy-nav .wy-menu-vertical a:hover { + background-color: #2980B9; + color: #fff; +} + +/* +[data-menu-wrap]{-webkit-transition:all 0.2s ease-in; + -moz-transition:all 0.2s ease-in; + transition:all 0.2s ease-in; + position:absolute; + opacity:1; + width:100%; + opacity:0} + +[data-menu-wrap].move-center{left:0; + right:auto; + opacity:1} + +[data-menu-wrap].move-left{right:auto; + left:-100%; + opacity:0} + +[data-menu-wrap].move-right{right:-100%; + left:auto; + opacity:0} +*/ + +.wy-body-for-nav { + background: left repeat-y #dddddd; +/* + background: left repeat-y #fcfcfc; + background-image: url(data:image/png; + base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC); + background-size: 300px 1px; + */ +} + +.wy-grid-for-nav { + position: absolute; + width: 80%; + height: 100%; +} + +.wy-nav-side { + position: fixed; + top: 0; + bottom: 0; + left: 0; + padding-bottom: 2em; + width: 300px; + overflow-x: hidden; + overflow-y: auto; + min-height: 100%; + background: #343131; + z-index: 200; +} + +.wy-nav-top{display:none; + background:#2980B9; + color:#fff; + padding:0.4045em 0.809em; + position:relative; + line-height:50px; + text-align:center; + font-size:100%; + *zoom:1} + +/* +.wy-nav-top:before,.wy-nav-top:after{display:table; + content:""} + +.wy-nav-top:after{clear:both} +*/ + +.wy-nav-top a { + color: #fff; + font-weight: bold; +} + +/* +.wy-nav-top img{margin-right:12px; + height:45px; + width:45px; + background-color:#2980B9; + padding:5px; + border-radius:100%} + +.wy-nav-top i{font-size:30px; + float:left; + cursor:pointer} + +.wy-nav-content-wrap { + margin-left: 300px; + background: #fcfcfc; + min-height: 100%; +} +*/ + +.wy-nav-content { + padding: 1.618em 3.236em; + height: 100%; + max-width: 900px; +/*margin: auto;*/ +} + +/* +.wy-body-mask{position:fixed; + width:100%; + height:100%; + background:rgba(0,0,0,0.2); + display:none; + z-index:499} + +.wy-body-mask.on{display:block} + +footer{color:#999} +*/ + +footer { font-size: 90%; } + +/* + +footer p{margin-bottom:12px} + +.rst-footer-buttons{*zoom:1} + +.rst-footer-buttons:before,.rst-footer-buttons:after{display:table; + content:""} + +.rst-footer-buttons:after{clear:both} + +#search-results .search li{margin-bottom:24px; + border-bottom:solid 1px #e1e4e5; + padding-bottom:24px} + +#search-results .search li:first-child{border-top:solid 1px #e1e4e5; + padding-top:24px} + +#search-results .search li a{font-size:120%; + margin-bottom:12px; + display:inline-block} + +#search-results .context{color:gray; + font-size:90%} + +@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc} + +.wy-nav-top{display:block} + +.wy-nav-side{left:-300px} + +.wy-nav-side.shift{width:85%; + left:0} + +.wy-nav-content-wrap { + margin-left: 0pt; + margin-bottom: 0pt; +} + +.wy-nav-content-wrap .wy-nav-content{padding:1.618em} + +.wy-nav-content-wrap.shift{position:fixed; + min-width:100%; + left:85%; + top:0; + height:100%; + overflow:hidden} + +} + +@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)} + +*/ +.wy-nav-content { + margin: 0px 0px 0px 300px; + background: white; +} + +.wy-nav-content-wrap { + font-size: 95%; + margin: 0px; + padding: 0px; +} +/* + +} + +@media print{.rst-versions,footer,.wy-nav-side{display:none} + +.wy-nav-content-wrap{margin-left:0} + +} + +.rst-versions{position:fixed; + bottom:0; + left:0; + width:300px; + color:#fcfcfc; + background:#1f1d1d; + border-top:solid 10px #343131; + font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; + z-index:400} + +.rst-versions a{color:#2980B9; + text-decoration:none} + +.rst-versions .rst-badge-small{display:none} + +.rst-versions .rst-current-version{padding:12px; + background-color:#272525; + display:block; + text-align:right; + font-size:90%; + cursor:pointer; + color:#27AE60; + *zoom:1} + +.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table; + content:""} + +.rst-versions .rst-current-version:after{clear:both} +*/ + +.rst-versions .rst-current-version .fa, +.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand, +.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand, +.rst-versions .rst-current-version .rst-content .admonition-title, +.rst-content .rst-versions .rst-current-version .admonition-title, +.rst-versions .rst-current-version .rst-content h1 .headerlink, +.rst-content h1 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h2 .headerlink, +.rst-content h2 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content p.caption .headerlink, +.rst-content p.caption .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h3 .headerlink, +.rst-content h3 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h4 .headerlink, +.rst-content h4 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h5 .headerlink, +.rst-content h5 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content h6 .headerlink, +.rst-content h6 .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content dl dt .headerlink, +.rst-content dl dt .rst-versions .rst-current-version .headerlink, +.rst-versions .rst-current-version .rst-content tt.download span:first-child, +.rst-content tt.download .rst-versions .rst-current-version span:first-child, +.rst-versions .rst-current-version .rst-content code.download span:first-child, +.rst-content code.download .rst-versions .rst-current-version span:first-child, +.rst-versions .rst-current-version .icon +{ + color: #fcfcfc +} + +/* +.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left} + +.rst-versions .rst-current-version .icon-book{float:left} + +.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C; + color:#fff} + +.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F; + color:#000} + +.rst-versions.shift-up .rst-other-versions{display:block} + +.rst-versions .rst-other-versions{font-size:90%; + padding:12px; + color:gray; + display:none} + +.rst-versions .rst-other-versions hr{display:block; + height:1px; + border:0; + margin:20px 0; + padding:0; + border-top:solid 1px #413d3d} + +.rst-versions .rst-other-versions dd{display:inline-block; + margin:0} + +.rst-versions .rst-other-versions dd a{display:inline-block; + padding:6px; + color:#fcfcfc} + +.rst-versions.rst-badge{width:auto; + bottom:20px; + right:20px; + left:auto; + border:none; + max-width:300px} + +.rst-versions.rst-badge .icon-book{float:none} + +.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none} + +.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right} + +.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left} + +.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left} + +.rst-versions.rst-badge .rst-current-version{width:auto; + height:30px; + line-height:30px; + padding:0 6px; + display:block; + text-align:center} + +@media screen and (max-width: 768px){.rst-versions{width:85%; + display:none} + +.rst-versions.shift{display:block} + +img{width:100%; + height:auto} + +} +*/ + +/* +.rst-content img{max-width:100%; + height:auto !important} + +.rst-content div.figure{margin-bottom:24px} + +.rst-content div.figure.align-center{text-align:center} + +.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px} + +.rst-content blockquote{margin-left:24px; + line-height:24px; + margin-bottom:24px} + +.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0} + +.rst-content .admonition-title:before{margin-right:4px} + +.rst-content .admonition table{border-color:rgba(0,0,0,0.1)} + +.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important; + border-color:rgba(0,0,0,0.1) !important} + +.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha} + +.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha} + +.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px} + +.rst-content .line-block{margin-left:24px} + +.rst-content .topic-title{font-weight:bold; + margin-bottom:12px} + +.rst-content .toc-backref{color:#404040} + +.rst-content .align-right{float:right; + margin:0px 0px 24px 24px} + +.rst-content .align-left{float:left; + margin:0px 24px 24px 0px} + +.rst-content .align-center{margin:auto; + display:block} + +.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content p.caption .headerlink{display:none; + visibility:hidden; + font-size:14px} + +.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content p.caption .headerlink:after{visibility:visible; + content:""; + font-family:FontAwesome; + display:inline-block} + +.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content p.caption:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink,.rst-content p.caption:hover .headerlink{display:inline-block} + +.rst-content .sidebar{float:right; + width:40%; + display:block; + margin:0 0 24px 24px; + padding:24px; + background:#f3f6f6; + border:solid 1px #e1e4e5} + +.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%} + +.rst-content .sidebar .last{margin-bottom:0} + +.rst-content .sidebar .sidebar-title{display:block; + font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif; + font-weight:bold; + background:#e1e4e5; + padding:6px 12px; + margin:-24px; + margin-bottom:24px; + font-size:100%} + +.rst-content .highlighted{background:#F1C40F; + display:inline-block; + font-weight:bold; + padding:0 6px} + +.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super; + font-size:90%} + +.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none; + border:none; + color:#999} + +.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none; + background-color:transparent !important; + white-space:normal} + +.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0; + padding-right:0; + vertical-align:top} + +.rst-content table.field-list{border:none} + +.rst-content table.field-list td{border:none; + padding-top:5px} + +.rst-content table.field-list td>strong{display:inline-block; + margin-top:3px} + +.rst-content table.field-list .field-name{padding-right:10px; + text-align:left; + white-space:nowrap} + +.rst-content table.field-list .field-body{text-align:left; + padding-left:0} + +.rst-content tt,.rst-content tt,.rst-content code{color:#000} + +.rst-content tt big,.rst-content tt em,.rst-content tt big,.rst-content code big,.rst-content tt em,.rst-content code em{font-size:100% !important; + line-height:normal} + +.rst-content tt .xref,a .rst-content tt,.rst-content tt .xref,.rst-content code .xref,a .rst-content tt,a .rst-content code{font-weight:bold} + +.rst-content a tt,.rst-content a tt,.rst-content a code{color:#2980B9} + +.rst-content dl{margin-bottom:24px} + +.rst-content dl dt{font-weight:bold} + +.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important} + +.rst-content dl dd{margin:0 0 12px 24px} + +.rst-content dl:not(.docutils){margin-bottom:24px} + +.rst-content dl:not(.docutils) dt{display:inline-block; + margin:6px 0; + font-size:90%; + line-height:normal; + background:#e7f2fa; + color:#2980B9; + border-top:solid 3px #6ab0de; + padding:6px; + position:relative} + +.rst-content dl:not(.docutils) dt:before{color:#6ab0de} + +.rst-content dl:not(.docutils) dt .headerlink{color:#404040; + font-size:100% !important} + +.rst-content dl:not(.docutils) dl dt{margin-bottom:6px; + border:none; + border-left:solid 3px #ccc; + background:#f0f0f0; + color:gray} + +.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040; + font-size:100% !important} + +.rst-content dl:not(.docutils) dt:first-child{margin-top:0} + +.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) tt,.rst-content dl:not(.docutils) code{font-weight:bold} + +.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname,.rst-content dl:not(.docutils) tt.descclassname,.rst-content dl:not(.docutils) code.descclassname{background-color:transparent; + border:none; + padding:0; + font-size:100% !important} + +.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) code.descname{font-weight:bold} + +.rst-content dl:not(.docutils) .optional{display:inline-block; + padding:0 4px; + color:#000; + font-weight:bold} + +.rst-content dl:not(.docutils) .property{display:inline-block; + padding-right:8px} + +.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block; + color:#27AE60; + font-size:80%; + padding-left:24px} + +.rst-content .viewcode-back{display:block; + float:right} + +.rst-content p.rubric{margin-bottom:12px; + font-weight:bold} + +.rst-content tt.download,.rst-content code.download{background:inherit; + padding:inherit; + font-family:inherit; + font-size:inherit; + color:inherit; + border:inherit; + white-space:inherit} + +.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before{margin-right:4px} + +@media screen and (max-width: 480px){.rst-content .sidebar{width:100%} +*/ + +} + +/* +span[id*='MathJax-Span']{color:#404040} + +.math{text-align:center} + +@font-face{font-family:"Inconsolata"; + font-style:normal; + font-weight:400; + src:local("Inconsolata"),url(../fonts/Inconsolata.ttf) format("truetype")} + +@font-face{font-family:"Inconsolata"; + font-style:normal; + font-weight:700; + src:local("Inconsolata Bold"),local("Inconsolata-Bold"),url(../fonts/Inconsolata-Bold.ttf) format("truetype")} + +@font-face{font-family:"Lato"; + font-style:normal; + font-weight:400; + src:local("Lato Regular"),local("Lato-Regular"),url(../fonts/Lato-Regular.ttf) format("truetype")} + +@font-face{font-family:"Lato"; + font-style:normal; + font-weight:700; + src:local("Lato Bold"),local("Lato-Bold"),url(../fonts/Lato-Bold.ttf) format("truetype")} + +@font-face{font-family:"Roboto Slab"; + font-style:normal; + font-weight:400; + src:local("Roboto Slab Regular"),local("RobotoSlab-Regular"),url(../fonts/RobotoSlab-Regular.ttf) format("truetype")} + +@font-face{font-family:"Roboto Slab"; + font-style:normal; + font-weight:700; + src:local("Roboto Slab Bold"),local("RobotoSlab-Bold"),url(../fonts/RobotoSlab-Bold.ttf) format("truetype")} +*/ + + +/*# sourceMappingURL=theme.css.map */ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf new file mode 100644 index 00000000..360a232d Binary files /dev/null and b/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf differ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata.ttf new file mode 100644 index 00000000..4b8a36d2 Binary files /dev/null and b/documentation/_themes/sphinx_rtd_theme/static/fonts/Inconsolata.ttf differ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Bold.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Bold.ttf new file mode 120000 index 00000000..0c624a1d --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Bold.ttf @@ -0,0 +1 @@ +/usr/share/fonts/lato/Lato-Bold.ttf \ No newline at end of file diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Regular.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Regular.ttf new file mode 120000 index 00000000..48f88579 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/fonts/Lato-Regular.ttf @@ -0,0 +1 @@ +/usr/share/fonts/lato/Lato-Regular.ttf \ No newline at end of file diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf new file mode 100644 index 00000000..e6ed0de5 Binary files /dev/null and b/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf differ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.ttf new file mode 100644 index 00000000..141d6c08 Binary files /dev/null and b/documentation/_themes/sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.ttf differ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..7c79c6a6 Binary files /dev/null and b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot differ diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg new file mode 120000 index 00000000..8ced2d86 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg @@ -0,0 +1 @@ +/usr/share/fonts/fontawesome/fontawesome-webfont.svg \ No newline at end of file diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf new file mode 120000 index 00000000..23e62513 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf @@ -0,0 +1 @@ +/usr/share/fonts/fontawesome/fontawesome-webfont.ttf \ No newline at end of file diff --git a/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff new file mode 120000 index 00000000..20873d14 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff @@ -0,0 +1 @@ +/usr/share/fonts/fontawesome/fontawesome-webfont.woff \ No newline at end of file diff --git a/documentation/_themes/sphinx_rtd_theme/static/js/modernizr.min.js b/documentation/_themes/sphinx_rtd_theme/static/js/modernizr.min.js new file mode 100644 index 00000000..f65d4797 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/static/js/modernizr.min.js @@ -0,0 +1,4 @@ +/* Modernizr 2.6.2 (Custom Build) | MIT & BSD + * Build: http://modernizr.com/download/#-fontface-backgroundsize-borderimage-borderradius-boxshadow-flexbox-hsla-multiplebgs-opacity-rgba-textshadow-cssanimations-csscolumns-generatedcontent-cssgradients-cssreflections-csstransforms-csstransforms3d-csstransitions-applicationcache-canvas-canvastext-draganddrop-hashchange-history-audio-video-indexeddb-input-inputtypes-localstorage-postmessage-sessionstorage-websockets-websqldatabase-webworkers-geolocation-inlinesvg-smil-svg-svgclippaths-touch-webgl-shiv-mq-cssclasses-addtest-prefixed-teststyles-testprop-testallprops-hasevent-prefixes-domprefixes-load + */ +;window.Modernizr=function(a,b,c){function D(a){j.cssText=a}function E(a,b){return D(n.join(a+";")+(b||""))}function F(a,b){return typeof a===b}function G(a,b){return!!~(""+a).indexOf(b)}function H(a,b){for(var d in a){var e=a[d];if(!G(e,"-")&&j[e]!==c)return b=="pfx"?e:!0}return!1}function I(a,b,d){for(var e in a){var f=b[a[e]];if(f!==c)return d===!1?a[e]:F(f,"function")?f.bind(d||b):f}return!1}function J(a,b,c){var d=a.charAt(0).toUpperCase()+a.slice(1),e=(a+" "+p.join(d+" ")+d).split(" ");return F(b,"string")||F(b,"undefined")?H(e,b):(e=(a+" "+q.join(d+" ")+d).split(" "),I(e,b,c))}function K(){e.input=function(c){for(var d=0,e=c.length;d',a,""].join(""),l.id=h,(m?l:n).innerHTML+=f,n.appendChild(l),m||(n.style.background="",n.style.overflow="hidden",k=g.style.overflow,g.style.overflow="hidden",g.appendChild(n)),i=c(l,a),m?l.parentNode.removeChild(l):(n.parentNode.removeChild(n),g.style.overflow=k),!!i},z=function(b){var c=a.matchMedia||a.msMatchMedia;if(c)return c(b).matches;var d;return y("@media "+b+" { #"+h+" { position: absolute; } }",function(b){d=(a.getComputedStyle?getComputedStyle(b,null):b.currentStyle)["position"]=="absolute"}),d},A=function(){function d(d,e){e=e||b.createElement(a[d]||"div"),d="on"+d;var f=d in e;return f||(e.setAttribute||(e=b.createElement("div")),e.setAttribute&&e.removeAttribute&&(e.setAttribute(d,""),f=F(e[d],"function"),F(e[d],"undefined")||(e[d]=c),e.removeAttribute(d))),e=null,f}var a={select:"input",change:"input",submit:"form",reset:"form",error:"img",load:"img",abort:"img"};return d}(),B={}.hasOwnProperty,C;!F(B,"undefined")&&!F(B.call,"undefined")?C=function(a,b){return B.call(a,b)}:C=function(a,b){return b in a&&F(a.constructor.prototype[b],"undefined")},Function.prototype.bind||(Function.prototype.bind=function(b){var c=this;if(typeof c!="function")throw new TypeError;var d=w.call(arguments,1),e=function(){if(this instanceof e){var a=function(){};a.prototype=c.prototype;var f=new a,g=c.apply(f,d.concat(w.call(arguments)));return Object(g)===g?g:f}return c.apply(b,d.concat(w.call(arguments)))};return e}),s.flexbox=function(){return J("flexWrap")},s.canvas=function(){var a=b.createElement("canvas");return!!a.getContext&&!!a.getContext("2d")},s.canvastext=function(){return!!e.canvas&&!!F(b.createElement("canvas").getContext("2d").fillText,"function")},s.webgl=function(){return!!a.WebGLRenderingContext},s.touch=function(){var c;return"ontouchstart"in a||a.DocumentTouch&&b instanceof DocumentTouch?c=!0:y(["@media (",n.join("touch-enabled),("),h,")","{#modernizr{top:9px;position:absolute}}"].join(""),function(a){c=a.offsetTop===9}),c},s.geolocation=function(){return"geolocation"in navigator},s.postmessage=function(){return!!a.postMessage},s.websqldatabase=function(){return!!a.openDatabase},s.indexedDB=function(){return!!J("indexedDB",a)},s.hashchange=function(){return A("hashchange",a)&&(b.documentMode===c||b.documentMode>7)},s.history=function(){return!!a.history&&!!history.pushState},s.draganddrop=function(){var a=b.createElement("div");return"draggable"in a||"ondragstart"in a&&"ondrop"in a},s.websockets=function(){return"WebSocket"in a||"MozWebSocket"in a},s.rgba=function(){return D("background-color:rgba(150,255,150,.5)"),G(j.backgroundColor,"rgba")},s.hsla=function(){return D("background-color:hsla(120,40%,100%,.5)"),G(j.backgroundColor,"rgba")||G(j.backgroundColor,"hsla")},s.multiplebgs=function(){return D("background:url(https://),url(https://),red url(https://)"),/(url\s*\(.*?){3}/.test(j.background)},s.backgroundsize=function(){return J("backgroundSize")},s.borderimage=function(){return J("borderImage")},s.borderradius=function(){return J("borderRadius")},s.boxshadow=function(){return J("boxShadow")},s.textshadow=function(){return b.createElement("div").style.textShadow===""},s.opacity=function(){return E("opacity:.55"),/^0.55$/.test(j.opacity)},s.cssanimations=function(){return J("animationName")},s.csscolumns=function(){return J("columnCount")},s.cssgradients=function(){var a="background-image:",b="gradient(linear,left top,right bottom,from(#9f9),to(white));",c="linear-gradient(left top,#9f9, white);";return D((a+"-webkit- ".split(" ").join(b+a)+n.join(c+a)).slice(0,-a.length)),G(j.backgroundImage,"gradient")},s.cssreflections=function(){return J("boxReflect")},s.csstransforms=function(){return!!J("transform")},s.csstransforms3d=function(){var a=!!J("perspective");return a&&"webkitPerspective"in g.style&&y("@media (transform-3d),(-webkit-transform-3d){#modernizr{left:9px;position:absolute;height:3px;}}",function(b,c){a=b.offsetLeft===9&&b.offsetHeight===3}),a},s.csstransitions=function(){return J("transition")},s.fontface=function(){var a;return y('@font-face {font-family:"font";src:url("https://")}',function(c,d){var e=b.getElementById("smodernizr"),f=e.sheet||e.styleSheet,g=f?f.cssRules&&f.cssRules[0]?f.cssRules[0].cssText:f.cssText||"":"";a=/src/i.test(g)&&g.indexOf(d.split(" ")[0])===0}),a},s.generatedcontent=function(){var a;return y(["#",h,"{font:0/0 a}#",h,':after{content:"',l,'";visibility:hidden;font:3px/1 a}'].join(""),function(b){a=b.offsetHeight>=3}),a},s.video=function(){var a=b.createElement("video"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('video/ogg; codecs="theora"').replace(/^no$/,""),c.h264=a.canPlayType('video/mp4; codecs="avc1.42E01E"').replace(/^no$/,""),c.webm=a.canPlayType('video/webm; codecs="vp8, vorbis"').replace(/^no$/,"")}catch(d){}return c},s.audio=function(){var a=b.createElement("audio"),c=!1;try{if(c=!!a.canPlayType)c=new Boolean(c),c.ogg=a.canPlayType('audio/ogg; codecs="vorbis"').replace(/^no$/,""),c.mp3=a.canPlayType("audio/mpeg;").replace(/^no$/,""),c.wav=a.canPlayType('audio/wav; codecs="1"').replace(/^no$/,""),c.m4a=(a.canPlayType("audio/x-m4a;")||a.canPlayType("audio/aac;")).replace(/^no$/,"")}catch(d){}return c},s.localstorage=function(){try{return localStorage.setItem(h,h),localStorage.removeItem(h),!0}catch(a){return!1}},s.sessionstorage=function(){try{return sessionStorage.setItem(h,h),sessionStorage.removeItem(h),!0}catch(a){return!1}},s.webworkers=function(){return!!a.Worker},s.applicationcache=function(){return!!a.applicationCache},s.svg=function(){return!!b.createElementNS&&!!b.createElementNS(r.svg,"svg").createSVGRect},s.inlinesvg=function(){var a=b.createElement("div");return a.innerHTML="",(a.firstChild&&a.firstChild.namespaceURI)==r.svg},s.smil=function(){return!!b.createElementNS&&/SVGAnimate/.test(m.call(b.createElementNS(r.svg,"animate")))},s.svgclippaths=function(){return!!b.createElementNS&&/SVGClipPath/.test(m.call(b.createElementNS(r.svg,"clipPath")))};for(var L in s)C(s,L)&&(x=L.toLowerCase(),e[x]=s[L](),v.push((e[x]?"":"no-")+x));return e.input||K(),e.addTest=function(a,b){if(typeof a=="object")for(var d in a)C(a,d)&&e.addTest(d,a[d]);else{a=a.toLowerCase();if(e[a]!==c)return e;b=typeof b=="function"?b():b,typeof f!="undefined"&&f&&(g.className+=" "+(b?"":"no-")+a),e[a]=b}return e},D(""),i=k=null,function(a,b){function k(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function l(){var a=r.elements;return typeof a=="string"?a.split(" "):a}function m(a){var b=i[a[g]];return b||(b={},h++,a[g]=h,i[h]=b),b}function n(a,c,f){c||(c=b);if(j)return c.createElement(a);f||(f=m(c));var g;return f.cache[a]?g=f.cache[a].cloneNode():e.test(a)?g=(f.cache[a]=f.createElem(a)).cloneNode():g=f.createElem(a),g.canHaveChildren&&!d.test(a)?f.frag.appendChild(g):g}function o(a,c){a||(a=b);if(j)return a.createDocumentFragment();c=c||m(a);var d=c.frag.cloneNode(),e=0,f=l(),g=f.length;for(;e",f="hidden"in a,j=a.childNodes.length==1||function(){b.createElement("a");var a=b.createDocumentFragment();return typeof a.cloneNode=="undefined"||typeof a.createDocumentFragment=="undefined"||typeof a.createElement=="undefined"}()}catch(c){f=!0,j=!0}})();var r={elements:c.elements||"abbr article aside audio bdi canvas data datalist details figcaption figure footer header hgroup mark meter nav output progress section summary time video",shivCSS:c.shivCSS!==!1,supportsUnknownElements:j,shivMethods:c.shivMethods!==!1,type:"default",shivDocument:q,createElement:n,createDocumentFragment:o};a.html5=r,q(b)}(this,b),e._version=d,e._prefixes=n,e._domPrefixes=q,e._cssomPrefixes=p,e.mq=z,e.hasEvent=A,e.testProp=function(a){return H([a])},e.testAllProps=J,e.testStyles=y,e.prefixed=function(a,b,c){return b?J(a,b,c):J(a,"pfx")},g.className=g.className.replace(/(^|\s)no-js(\s|$)/,"$1$2")+(f?" js "+v.join(" "):""),e}(this,this.document),function(a,b,c){function d(a){return"[object Function]"==o.call(a)}function e(a){return"string"==typeof a}function f(){}function g(a){return!a||"loaded"==a||"complete"==a||"uninitialized"==a}function h(){var a=p.shift();q=1,a?a.t?m(function(){("c"==a.t?B.injectCss:B.injectJs)(a.s,0,a.a,a.x,a.e,1)},0):(a(),h()):q=0}function i(a,c,d,e,f,i,j){function k(b){if(!o&&g(l.readyState)&&(u.r=o=1,!q&&h(),l.onload=l.onreadystatechange=null,b)){"img"!=a&&m(function(){t.removeChild(l)},50);for(var d in y[c])y[c].hasOwnProperty(d)&&y[c][d].onload()}}var j=j||B.errorTimeout,l=b.createElement(a),o=0,r=0,u={t:d,s:c,e:f,a:i,x:j};1===y[c]&&(r=1,y[c]=[]),"object"==a?l.data=c:(l.src=c,l.type=a),l.width=l.height="0",l.onerror=l.onload=l.onreadystatechange=function(){k.call(this,r)},p.splice(e,0,u),"img"!=a&&(r||2===y[c]?(t.insertBefore(l,s?null:n),m(k,j)):y[c].push(l))}function j(a,b,c,d,f){return q=0,b=b||"j",e(a)?i("c"==b?v:u,a,b,this.i++,c,d,f):(p.splice(this.i++,0,a),1==p.length&&h()),this}function k(){var a=B;return a.loader={load:j,i:0},a}var l=b.documentElement,m=a.setTimeout,n=b.getElementsByTagName("script")[0],o={}.toString,p=[],q=0,r="MozAppearance"in l.style,s=r&&!!b.createRange().compareNode,t=s?l:n.parentNode,l=a.opera&&"[object Opera]"==o.call(a.opera),l=!!b.attachEvent&&!l,u=r?"object":l?"script":"img",v=l?"script":u,w=Array.isArray||function(a){return"[object Array]"==o.call(a)},x=[],y={},z={timeout:function(a,b){return b.length&&(a.timeout=b[0]),a}},A,B;B=function(a){function b(a){var a=a.split("!"),b=x.length,c=a.pop(),d=a.length,c={url:c,origUrl:c,prefixes:a},e,f,g;for(f=0;f ul li.current').removeClass('current'); + parent_li.toggleClass('current'); +} + +$(document).ready(function() { + // Shift nav in mobile when clicking the menu. + $(document).on('click', "[data-toggle='wy-nav-top']", function() { + $("[data-toggle='wy-nav-shift']").toggleClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + }); + // Nav menu link click operations + $(document).on('click', ".wy-menu-vertical .current ul li a", function() { + var target = $(this); + // Close menu when you click a link. + $("[data-toggle='wy-nav-shift']").removeClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + // Handle dynamic display of l3 and l4 nav lists + toggleCurrent(target); + if (typeof(window.SphinxRtdTheme) != 'undefined') { + window.SphinxRtdTheme.StickyNav.hashChange(); + } + }); + $(document).on('click', "[data-toggle='rst-current-version']", function() { + $("[data-toggle='rst-versions']").toggleClass("shift-up"); + }); + // Make tables responsive + $("table.docutils:not(.field-list)").wrap("
        "); + + // Add expand links to all parents of nested ul + $('.wy-menu-vertical ul').siblings('a').each(function () { + var link = $(this); + expand = $(''); + expand.on('click', function (ev) { + toggleCurrent(link); + ev.stopPropagation(); + return false; + }); + link.prepend(expand); + }); +}); + +// Sphinx theme state +window.SphinxRtdTheme = (function (jquery) { + var stickyNav = (function () { + var navBar, + win, + winScroll = false, + linkScroll = false, + winPosition = 0, + enable = function () { + init(); + reset(); + win.on('hashchange', reset); + + // Set scrolling + win.on('scroll', function () { + if (!linkScroll) { + winScroll = true; + } + }); + setInterval(function () { + if (winScroll) { + winScroll = false; + var newWinPosition = win.scrollTop(), + navPosition = navBar.scrollTop(), + newNavPosition = navPosition + (newWinPosition - winPosition); + navBar.scrollTop(newNavPosition); + winPosition = newWinPosition; + } + }, 25); + }, + init = function () { + navBar = jquery('nav.wy-nav-side:first'); + win = jquery(window); + }, + reset = function () { + // Get anchor from URL and open up nested nav + var anchor = encodeURI(window.location.hash); + if (anchor) { + try { + var link = $('.wy-menu-vertical') + .find('[href="' + anchor + '"]'); + $('.wy-menu-vertical li.toctree-l1 li.current') + .removeClass('current'); + link.closest('li.toctree-l2').addClass('current'); + link.closest('li.toctree-l3').addClass('current'); + link.closest('li.toctree-l4').addClass('current'); + } + catch (err) { + console.log("Error expanding nav for anchor", err); + } + } + }, + hashChange = function () { + linkScroll = true; + win.one('hashchange', function () { + linkScroll = false; + }); + }; + jquery(init); + return { + enable: enable, + hashChange: hashChange + }; + }()); + return { + StickyNav: stickyNav + }; +}($)); diff --git a/documentation/_themes/sphinx_rtd_theme/theme.conf b/documentation/_themes/sphinx_rtd_theme/theme.conf new file mode 100644 index 00000000..b71548b2 --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/theme.conf @@ -0,0 +1,9 @@ +[theme] +inherit = basic +stylesheet = css/theme.css + +[options] +typekit_id = hiw1hhg +analytics_id = +sticky_navigation = False +logo_only = diff --git a/documentation/_themes/sphinx_rtd_theme/versions.html b/documentation/_themes/sphinx_rtd_theme/versions.html new file mode 100644 index 00000000..8b3eb79d --- /dev/null +++ b/documentation/_themes/sphinx_rtd_theme/versions.html @@ -0,0 +1,37 @@ +{% if READTHEDOCS %} +{# Add rst-badge after rst-versions for small badge style. #} +
        + + Read the Docs + v: {{ current_version }} + + +
        +
        +
        Versions
        + {% for slug, url in versions %} +
        {{ slug }}
        + {% endfor %} +
        +
        +
        Downloads
        + {% for type, url in downloads %} +
        {{ type }}
        + {% endfor %} +
        +
        +
        On Read the Docs
        +
        + Project Home +
        +
        + Builds +
        +
        +
        + Free document hosting provided by Read the Docs. + +
        +
        +{% endif %} + diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 00000000..39712140 --- /dev/null +++ b/documentation/conf.py @@ -0,0 +1,286 @@ +# -*- coding: utf-8 -*- +# +# Coriolis documentation build configuration file, created by +# sphinx-quickstart on Mon Jul 10 15:08:36 2017. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Coriolis' +copyright = u'2000-2017, UPMC' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2' +# The full version, including alpha/beta/rc tags. +release = '2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build', 'UsersGuide/UsersGuide.rst', 'UsersGuide/pdfHeader.rst' + , 'PythonCpp/PythonCpp.rst' , 'PythonCpp/pdfHeader.rst' + , 'RDS/RDS.rst' , 'RDS/pdfHeader.rst' ] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'sphinx_rtd_theme' +html_style = 'SoC.css' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = [ '_themes' ] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +html_additional_pages = { 'index' : 'indexcontent.html' } + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Coriolisdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Coriolis.tex', u'Coriolis Documentation', u'UPMC', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'coriolis', u'Coriolis Documentation', [u'UPMC'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Coriolis', u'Coriolis Documentation', + u'UPMC/LIP6/SoC', 'Coriolis', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Coriolis' +epub_author = u'UPMC' +epub_publisher = u'UPMC' +epub_copyright = u'2000-2017, UPMC' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/documentation/etc/CMakeLists.txt b/documentation/etc/CMakeLists.txt deleted file mode 100644 index ed7a27a8..00000000 --- a/documentation/etc/CMakeLists.txt +++ /dev/null @@ -1,8 +0,0 @@ - - set ( htmlInstallDir share/doc/coriolis2/en/html/etc ) - - install ( FILES Pygments.css SoC.css SoC-ReST.css - DESTINATION ${htmlInstallDir} ) - install ( DIRECTORY images/ - DESTINATION ${htmlInstallDir}/images - FILES_MATCHING PATTERN "*.png" ) diff --git a/documentation/etc/Pygments.css b/documentation/etc/Pygments.css deleted file mode 100644 index de3dc8fe..00000000 --- a/documentation/etc/Pygments.css +++ /dev/null @@ -1,41 +0,0 @@ -div.codeblock { font-size: 90%; - margin: 10pt; - padding: 5pt; - border: dashed; - border-width: thin; - background-color: #ffffcc; - border-color: #fc8676; - } -.codeblock * .hll { background-color: #ffffcc } -.codeblock * .c { color: #008000 } /* Comment */ -.codeblock * .err { border: 1px solid #FF0000 } /* Error */ -.codeblock * .k { color: #0000ff } /* Keyword */ -.codeblock * .cm { color: #008000 } /* Comment.Multiline */ -.codeblock * .cp { color: #0000ff } /* Comment.Preproc */ -.codeblock * .c1 { color: #008000 } /* Comment.Single */ -.codeblock * .cs { color: #008000 } /* Comment.Special */ -.codeblock * .ge { font-style: italic } /* Generic.Emph */ -.codeblock * .gh { font-weight: bold } /* Generic.Heading */ -.codeblock * .gp { font-weight: bold } /* Generic.Prompt */ -.codeblock * .gs { font-weight: bold } /* Generic.Strong */ -.codeblock * .gu { font-weight: bold } /* Generic.Subheading */ -.codeblock * .kc { color: #0000ff } /* Keyword.Constant */ -.codeblock * .kd { color: #0000ff } /* Keyword.Declaration */ -.codeblock * .kn { color: #0000ff } /* Keyword.Namespace */ -.codeblock * .kp { color: #0000ff } /* Keyword.Pseudo */ -.codeblock * .kr { color: #0000ff } /* Keyword.Reserved */ -.codeblock * .kt { color: #2b91af } /* Keyword.Type */ -.codeblock * .s { color: #a31515 } /* Literal.String */ -.codeblock * .nc { color: #2b91af } /* Name.Class */ -.codeblock * .ow { color: #0000ff } /* Operator.Word */ -.codeblock * .sb { color: #a31515 } /* Literal.String.Backtick */ -.codeblock * .sc { color: #a31515 } /* Literal.String.Char */ -.codeblock * .sd { color: #a31515 } /* Literal.String.Doc */ -.codeblock * .s2 { color: #a31515 } /* Literal.String.Double */ -.codeblock * .se { color: #a31515 } /* Literal.String.Escape */ -.codeblock * .sh { color: #a31515 } /* Literal.String.Heredoc */ -.codeblock * .si { color: #a31515 } /* Literal.String.Interpol */ -.codeblock * .sx { color: #a31515 } /* Literal.String.Other */ -.codeblock * .sr { color: #a31515 } /* Literal.String.Regex */ -.codeblock * .s1 { color: #a31515 } /* Literal.String.Single */ -.codeblock * .ss { color: #a31515 } /* Literal.String.Symbol */ diff --git a/documentation/etc/definitions.rst b/documentation/etc/definitions.rst index e303a4c3..ab364f9b 100644 --- a/documentation/etc/definitions.rst +++ b/documentation/etc/definitions.rst @@ -1,4 +1,4 @@ -.. -*- Mode: rst -*- +.. -*- Mode: rst; explicit-buffer-name: "definition.rst" -*- .. role:: raw-html(raw) @@ -19,6 +19,9 @@ .. |linebreak| replace:: :raw-latex:`\smallskip` .. |noindent| replace:: :raw-latex:`\noindent` :raw-html:`

        ` .. |dotfill| replace:: :raw-html:`  ` +.. |bcenter| replace:: :raw-latex:`\begin{center}` +.. |ecenter| replace:: :raw-latex:`\end{center}` +.. |pagestylefancy| replace:: :raw-latex:`\thispagestyle{fancy}` .. Acronyms & names. @@ -139,6 +142,8 @@ .. |CTRL_Right| replace:: :fboxtt:`CTRL+Right` .. URLs +.. _Doxygen: http://www.stack.nl/~dimitri/doxygen/ +.. _LaTeX2HTML: http://www.latex2html.org/ .. _FGR: http://vlsicad.eecs.umich.edu/BK/FGR/ .. _Box Router: http://www.cerc.utexas.edu/~thyeros/boxrouter/boxrouter.htm .. _hMETIS: http://glaros.dtc.umn.edu/gkhome/views/metis @@ -162,6 +167,7 @@ .. |LOFIG| replace:: :cb:`Lofig` .. |PHFIG| replace:: :cb:`Phfig` .. |SxLib| replace:: :sc:`SxLib` +.. |RDS| replace:: :sc:`rds` .. Hurricane Concepts. .. |hypernet| replace:: *hypernet* diff --git a/documentation/etc/doPdf.sh b/documentation/etc/doPdf.sh new file mode 100755 index 00000000..de56cbf6 --- /dev/null +++ b/documentation/etc/doPdf.sh @@ -0,0 +1,34 @@ +#!/bin/sh + + + document=`basename -s .rst ${@:$#}` + sources=${@:1:$(($# -1))} + +#echo "Args: $*" + echo "Document: ${document}.rst" + echo "Sources: ${sources}" + + rm -f ${document}.rst + for source in ${sources}; do + source=`basename ${source}` + if [ "${source}" != "pdfHeader.rst" ]; then + tail -n +4 ${source} | \ + sed 's,:ref:`\([^`]*\)`,`\1`_,' \ + >> ${document}.rst + else + cat ${source} >> ${document}.rst + fi + done + export TEXINPUTS=../etc/images//:./images//: + rst2latex --use-latex-toc --stylesheet=../etc/SoC-ReST.tex ${document}.rst ${document}-raw.tex + sed 's, \\& \\\\multicolumn{2}{l|}{, \\& \\\\multicolumn{2}{p{0.6\\\\DUtablewidth}|}{,' ${document}-raw.tex > ${document}.tex + pdflatex ${document} + pdflatex ${document} + + rm -f ${document}.rst \ + ${document}-raw.tex \ + ${document}.tex \ + ${document}.log \ + ${document}.out \ + ${document}.aux \ + ${document}.toc diff --git a/documentation/etc/socstyle.tex b/documentation/etc/socstyle.tex deleted file mode 100644 index 5cf8f487..00000000 --- a/documentation/etc/socstyle.tex +++ /dev/null @@ -1,89 +0,0 @@ - - \usepackage[default,osfigures,scale=0.95]{opensans} - \usepackage{xspace} - \usepackage{fancyhdr} -%\usepackage[dvipdfm]{graphicx} - \usepackage{graphicx} - \usepackage{enumitem} - \usepackage[sf,bf]{titlesec} - \usepackage{titletoc} - \usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue,dvipdfm]{hyperref} - \usepackage[paper=a4paper,headheight=30pt,tmargin=1.5in,bmargin=1in]{geometry} -%\usepackage{layouts} - - \urlstyle{tt} % normal text font (alternatives: same, tt, rm, sf) - \renewlist{itemize}{itemize}{9} - \setlist[itemize]{label=\textbullet} - -% The LaTeX Companion -- p. 204. -% Miniature display of the page layout. -%\newcommand{\showpage}{% -% \setlayoutscale{0.65}\setlabelfont{\tiny}% -% \printheadingsfalse\printparametersfalse% -% \currentpage\pagedesign% -%} - - \titlecontents{section}[0pc] - {\sffamily\bfseries} % above code. - {\contentslabel{1pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsection}[0pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - \titlecontents{subsubsection}[1pc] - {\sffamily} % above code. - {\contentslabel{2pc}} % numbered entry format. - {} % numberless entry format. - {\titlerule*[8pt]{.}\textsc{\textbf{{\contentspage}}}} % page format. - - \newcommand{\key}[1]{\raisebox{-0.5\baselineskip}{\rule{0pt}{1.5\baselineskip}}\fbox{\textsf{#1}}} - - \newcommand{\DUroleul}[1]{\underline{#1}\xspace} - \newcommand{\DUrolesc}[1]{\textsc{#1}\xspace} - \newcommand{\DUrolecb}[1]{\textbf{\texttt{#1}}\xspace} - \newcommand{\DUrolefboxtt}[1]{\fbox{\texttt{#1}}\xspace} - - \newcommand{\DUtitlenote}[1]{\noindent\textbf{#1}\smallskip} - - \newcommand{\DUadmonitionnote}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5,natwidth=48,natheight=48]{./images/clipboard.pdf}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\DUtitleerror}[1]{\noindent\textbf{\color{red}#1}\smallskip} - - \newcommand{\DUadmonitionerror}[1]{% - \begin{center} - \sffamily - \begin{array}[t]{m{1cm}!{\vrule width 1pt}m{.90\textwidth}} - \raisebox{0.0cm}{\includegraphics[scale=0.5,natwidth=48,natheight=48]{./images/i-core.pdf}} & - \begin{minipage}[t]{.85\textwidth} #1 - \end{minipage} \\ - \end{array} - \end{center} - } - - \newcommand{\UPMC} {\textsc{upmc}\xspace} - \newcommand{\LIP} {\textsc{lip6}\xspace} - \newcommand{\SoC} {\textsc{S}o\textsc{C}\xspace} - - \renewcommand{\headrulewidth}{0.2mm} - \renewcommand{\footrulewidth}{0.2mm} - \renewcommand{\sectionmark}[1]{\markboth{\thesection\ #1}{\thesection\ #1}} - \renewcommand{\subsectionmark}[1]{} - \lhead[]{Documentation \SoC} - \rhead[]{March 2015} - \lfoot[]{\UPMC/\LIP/\SoC} - \rfoot[]{\thepage} - \cfoot[]{} - - \pagestyle{fancy} diff --git a/documentation/examples/code/engine/smurf/CMakeLists.txt b/documentation/examples/code/engine/smurf/CMakeLists.txt index 4fc2951c..7859337e 100644 --- a/documentation/examples/code/engine/smurf/CMakeLists.txt +++ b/documentation/examples/code/engine/smurf/CMakeLists.txt @@ -16,7 +16,7 @@ setup_qt() find_package(LibXml2 REQUIRED) - find_package(PythonLibs 2.7 EXACT REQUIRED) + find_package(PythonLibs 2 REQUIRED) find_package(PythonSitePackages REQUIRED) find_package(AXEP REQUIRED) find_package(VLSISAPD REQUIRED) diff --git a/documentation/general-index.html b/documentation/general-index.html deleted file mode 100644 index 47bcf1a6..00000000 --- a/documentation/general-index.html +++ /dev/null @@ -1,73 +0,0 @@ - - - - Coriolis 2 Documentation - - - - - -

        Coriolis 2 Documentation

        - - - - - - - - - - - - - - - - - - - - - -
        - - - -
        -
        • Stratus
          - Netlist Capture Language (Python) -
        -         		- -
        -
        • DpGen
          - Stratus Extension for Data-Pathes -
        -         		-
        • CrlCore
          - Coriolis Core, Interface Documentation -
        -
        -
        • Patterns
          - Stratus Extension for Pattern generation -
        -         		-
        • Unicorn
          - Coriolis Main Application -
        -
        - - -
        - - - diff --git a/documentation/index.rst b/documentation/index.rst new file mode 100644 index 00000000..09bf0f90 --- /dev/null +++ b/documentation/index.rst @@ -0,0 +1,36 @@ +.. -*- mode: rst; explicit-buffer-name: "index.rst" -*- + +.. Coriolis documentation master file, created by + sphinx-quickstart on Mon Jul 10 15:08:36 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Coriolis's documentation! +==================================== + +Contents: + +.. toctree:: + + UsersGuide/index.rst + Stratus/Stratus.rst + DpGen/DpGen.rst + Patterns/Patterns.rst + Hurricane/Hurricane.rst + Viewer/Viewer.rst + CrlCore/CrlCore.rst + Katabatic/Katabatic.rst + Kite/Kite.rst + Unicorn/Unicorn.rst + PythonCpp/index.rst + RDS/index.rst + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/hurricane/doc/hurricane/ASIM-bigfonts.css b/hurricane/doc/hurricane/ASIM-bigfonts.css deleted file mode 100644 index f8ec6823..00000000 --- a/hurricane/doc/hurricane/ASIM-bigfonts.css +++ /dev/null @@ -1,353 +0,0 @@ - - -/* - * x-----------------------------------------------------------------x - * | HTML Standart Tags | - * x-----------------------------------------------------------------x - */ - - html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 100%; - font-family: verdana, sans-serif; - } - - body { - color: black; - background: white; - background-color: white; - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin-top: 2em; - margin-right: 10%; - margin-left: 10%; - } - - hr { - height: 1px; - border: 0; - color: #004400; - background-color: #004400; - } - - - h1, h2, h3, h4, h5, h6 { - font-family: verdana, sans-serif; - } - - h1 { text-align: center; } - h2, h3, h4, h5, h6 { text-align: left; - padding-top: 2em; - } - h1, h2, h3 { font-family: "Trebuchet MS", sans-serif; - color: #09550B; - } - h1 { font-weight: bold; font-size: 170%; } - h2 { font-weight: bold; font-size: 140%; } - h3 { font-weight: bold; font-size: 118%; } - h4 { font-weight: bold; font-size: 100%; } - h5 { font-style: italic; font-size: 100%; } - h6 { font-variant: small-caps; font-size: 100%; } - - .hide { - display: none; - color: white; - } - - - p { - margin-top: 0.6em; - margin-bottom: 0.6em; - margin-left: 0.0em; - margin-right: 0.0em; - } - - - address { - text-align: right; - font-weight: bold; - font-style: italic; - font-size: 80%; - } - - - caption { font-weight: bold } - - - blockquote { - margin-left: 4em; - margin-right: 4em; - margin-top: 0.8em; - margin-bottom: 0.8em; - font-style: italic; - color: #003300; - } - - blockquote p { - margin-bottom: 0; - } - - blockquote address { - margin: 0; - } - - - table { - border-collapse: collapse; - } - - dt, dd { margin-top: 0; margin-bottom: 0; } - dt { font-weight: bold; } - - - pre, tt, code { - font-family: "andale mono", monospace; - font-size: 100%; - white-space: pre; - } - - pre { - font-size: 80%; - border: solid; - border-width: thin; - border-color: #003300; - background-color: #EEEEEE; - padding: 0.5em; - margin-left: 2em; - margin-right: 2em - } - - tt { color: green; } - em { font-style: italic; font-weight: bold; } - strong { font-weight: bold; } - - span.textit { font-style: italic; } - span.textbf { font-weight: bold; } - - .small { font-size: 90%; } - .white { color: #FFFFFF; } - - - ul.toc { - list-style: disc; - list-style: none; - } - - - a:link img, a:visited img { border-style: none; } - a img { color: white; } - - a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; - } - - a:hover, a:focus { - color: #FF9900; - text-decoration: underline; - } - - - - -/* - * x-----------------------------------------------------------------x - * | Doxygen Specific Classes | - * x-----------------------------------------------------------------x - */ - - -/* ------------------------------------------------------------------- - * Header & Footer Classes (customized top page navigation bar). - */ - - table.header { - width: 100%; - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - h1.header { - font-family: times, verdana, sans-serif; - } - - td.header { - /*width: 14%;*/ - text-align: center; - font-weight: bold; - font-family: verdana, sans-serif; - } - - table.footer { - width: 100%; - } - - td.leftFoot1, td.leftFoot2 { - text-align: left; - } - - td.rightFoot1, td.rightFoot2 { - text-align: right; - } - - td.leftFoot2 { - font-family: time; - font-weight: bold; - } - - td.rightFoot2 { - font-weight: bold; - } - - div.ah { - font-family: time; - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Quick Index Class (top page navigation bar). - */ - - div.qindex, div.nav { - width: 100%; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - border: 1px solid #003300; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; - } - - a.qindex, a.qindex:visited, a.qindex:hover, a.qindexHL, a.el, a.elRef { - text-decoration: none; - font-weight: bold; - } - - a.qindex, a.qindex:visited { - color: #09550B; - } - - a.qindex:hover { - background-color: #ddddff; - } - - a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { - background-color: #0c780c; - color: #ffffff; - border: 1px double #9295C2; - } - - a.code:link, a.code:visited, a.codeRef:link, a.codeRef:visited { - text-decoration: none; - font-weight: normal; - color: #0000ff; - } - - .indexkey { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey, .indexvalue { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey { - width: 40%; - } - - .indexvalue { - width: 80%; - } - - -/* ------------------------------------------------------------------- - * Verbatim Source Code / Examples. - */ - - pre.fragment { background-color: #EEEEEE; } - - span.keyword { color: #008000 } - span.keywordtype { color: #604020 } - span.keywordflow { color: #e08000 } - span.comment { color: #800000 } - span.preprocessor { color: #806020 } - span.stringliteral { color: #002080 } - span.charliteral { color: #008080 } - - -/* ------------------------------------------------------------------- - * Attributes Listing. - */ - - .mdTable { - /*border: 1px solid #868686;*/ - /*background-color: #DADAEF;*/ - /*background-color: #F4F4FB;*/ - border: 1px none #868686; - /*background-color: #B8E6B8;*/ - background-color: #CCE6CA; - margin-top: 25px; - } - - .mdRow { - padding: 5px 10px; - } - - /* This Mozilla/Firefox bug has been corrected from v1.5. - * .mdname1 { - * padding: 3px 0px 0px 0px; - * } - */ - - .mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - font-size: 12px; - font-style: italic; - /*background-color: #FAFAFA;*/ - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; - } - - .memItemLeft, .memItemRight, .memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #0c0c0c; - border-right-color: #0c0c0c; - border-bottom-color: #0c0c0c; - border-left-color: #0c0c0c; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - .memItemLeft { font-size: 12px; } - .memItemRight { font-size: 13px; } - .memTemplItemLeft { font-size: 12px; } - .memTemplItemRight { font-size: 13px; } - - .memTemplParams { - color: #606060; - background-color: #DADAEF; - font-size: 12px; - } - diff --git a/hurricane/doc/hurricane/ASIM.css b/hurricane/doc/hurricane/ASIM.css deleted file mode 100644 index 3b99772e..00000000 --- a/hurricane/doc/hurricane/ASIM.css +++ /dev/null @@ -1,554 +0,0 @@ - - -/* - * +-----------------------------------------------------------------+ - * | HTML Standart Tags | - * +-----------------------------------------------------------------+ - */ - - html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 11pt; - /* The Open Sans font family is supplied by TexLive. */ - font-family: "Open Sans", Verdana, sans-serif;; - } - - body { - color: black; - background: white; - background-color: white; - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin-top: 2em; - width: 550pt; - margin-right: auto; - margin-left: auto; - /* - margin-right: 12%; - margin-left: 12%; - */ - } - - hr { - height: 1px; - border: 0; - color: #004400; - background-color: #004400; - } - - - h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ - } - - h1 { text-align: center; } - h2, h3, h4, h5, h6 { text-align: left; - padding-top: 11pt; - } - h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ - /*color: #09550B;*/ - } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } - h4 { font-weight: bold; font-size: 100%; } - h5 { font-style: italic; font-size: 100%; } - h6 { font-variant: small-caps; font-size: 100%; } - - h2.classHierarchy { - /*border: 1px none #008500;*/ - border: 1px none #000000; - border-top-width: 1px; - border-top-style: dotted; - padding-top: 1em; - } - - - .hide { - display: none; - color: white; - } - - - p { - margin-top: 0.6em; - margin-bottom: 0.6em; - margin-left: 0.0em; - margin-right: 0.0em; - } - - - address { - text-align: right; - font-weight: bold; - font-style: italic; - font-size: 80%; - } - - - caption { font-weight: bold } - - - blockquote { - margin-left: 4em; - margin-right: 4em; - margin-top: 0.8em; - margin-bottom: 0.8em; - font-style: italic; - color: #003300; - } - - blockquote p { - margin-bottom: 0; - } - - blockquote address { - margin: 0; - } - - - table { - border-collapse: collapse; - } - - dt, dd { margin-top: 0; margin-bottom: 0; } - dt { font-weight: bold; } - - - pre, tt, code { - /*font-family: "andale mono", monospace;*/ - font-size: 100%; - white-space: pre; - } - - pre { - font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; - /* - background-color: #EEEEEE; - */ - background-color: #FCFCE1; - padding: 0.5em; - margin-left: 2em; - margin-right: 2em - } - - tt { color: green; } - em { font-style: italic; - font-weight: normal; } - strong { font-weight: bold; } - - span.textit { font-style: italic; } - span.textbf { font-weight: bold; } - - .small { font-size: 90%; } - .white { color: #FFFFFF; } - - - ul.toc { - list-style: disc; - list-style: none; - } - - - a:link img, a:visited img { border-style: none; } - a img { color: white; } - - a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; - } - - a:hover, a:focus { - color: #FF9900; - text-decoration: underline; - } - - -/* - * +-----------------------------------------------------------------+ - * | Doxygen Specific Classes | - * +-----------------------------------------------------------------+ - */ - - -/* ------------------------------------------------------------------- - * Header & Footer Classes (customized top page navigation bar). - */ - - h1.header { - font-size: 200%; - /*font-family: times, verdana, sans-serif;*/ - } - - center.header { - background-color: #CCE6CA; - } - - table.header { - /*width: 100%;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - table.header td { - padding: 2px 14px; - text-align: center; - font-weight: bold; - /*font-family: verdana, sans-serif;*/ - font-size: 110%; - } - - table.DoxUser td, table.DoxUser th { - padding: 0px 5px; - border: 0px; - } - - table.DoxUser th { - background-color: #CCE6CA; - } - - table.footer1, table.footer2 { width: 100%; } - td.LFooter { text-align: left; } - td.RFooter { text-align: right; } - td.CFooter { text-align: center;} - table.footer2 td.RFooter { font-weight: bold; width: 35% } - table.footer2 td.CFooter { width: 30% } - table.footer2 td.LFooter { font-weight: bold; width: 35%; /*font-family: time;*/ } - - table.classHierarchy { - border-collapse: separate; - border-spacing: 5px; - font-size: 110%; - } - - table.classHierarchy tr { - border: 1px solid blue; - } - - table.classHierarchy td.normal { - border: 1px solid #CCE6CA; - width: 140pt; - text-align: center; - font-weight: bold; - background-color: #CCE6CA; - } - - table.classHierarchy td.virtual { - border: 1px solid black; - width: 140pt; - text-align: center; - font-weight: bold; - } - - table.classHierarchy td.wnormal { - border: 1px solid #CCE6CA; - width: 240pt; - text-align: center; - font-weight: bold; - background-color: #CCE6CA; - } - - table.classHierarchy td.wvirtual { - border: 1px solid black; - width: 240pt; - text-align: center; - font-weight: bold; - } - - div.ah { - /*font-family: time;*/ - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Quick Index Class (top page navigation bar). - */ - - div.qindex, div.nav { - width: 100%-4px; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - border: 0px solid #003300; - text-align: center; - margin: 0px; - padding: 2px; - line-height: 140%; - } - - a.qindex, a.qindex:visited, a.qindex:hover, a.qindexHL, a.el, a.elRef { - text-decoration: none; - /*font-family: Courier;*/ - font-weight: normal; - /*font-size: 110%;*/ - } - - a.qindex, a.qindex:visited { - color: #09550B; - } - - a.qindex:hover { - background-color: #ddddff; - } - - a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { - background-color: #0c780c; - color: #ffffff; - border: 1px double #9295C2; - } - - a.code:link, a.code:visited, a.codeRef:link, a.codeRef:visited { - text-decoration: none; - font-weight: normal; - color: #0000ff; - } - - .indexkey { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey, .indexvalue { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey { - width: 40%; - } - - .indexvalue { - width: 80%; - } - - h3 a[name="index__"], - h3 a[name="index_a"], - h3 a[name="index_b"], - h3 a[name="index_c"], - h3 a[name="index_d"], - h3 a[name="index_e"], - h3 a[name="index_f"], - h3 a[name="index_g"], - h3 a[name="index_h"], - h3 a[name="index_i"], - h3 a[name="index_j"], - h3 a[name="index_k"], - h3 a[name="index_l"], - h3 a[name="index_m"], - h3 a[name="index_n"], - h3 a[name="index_o"], - h3 a[name="index_p"], - h3 a[name="index_q"], - h3 a[name="index_r"], - h3 a[name="index_s"], - h3 a[name="index_t"], - h3 a[name="index_u"], - h3 a[name="index_v"], - h3 a[name="index_w"], - h3 a[name="index_x"], - h3 a[name="index_y"], - h3 a[name="index_z"], - h3 a[name="index_0"], - h3 a[name="index_1"], - h3 a[name="index_2"], - h3 a[name="index_3"], - h3 a[name="index_4"], - h3 a[name="index_5"], - h3 a[name="index_6"], - h3 a[name="index_7"], - h3 a[name="index_8"], - h3 a[name="index_9"] - h3 a[id="index__"], - h3 a#index_a, - h3 a#index_b, - h3 a#index_c, - h3 a#index_d, - h3 a#index_e, - h3 a#index_f, - h3 a#index_g, - h3 a#index_h, - h3 a#index_i, - h3 a#index_j, - h3 a#index_k, - h3 a#index_l, - h3 a#index_m, - h3 a#index_n, - h3 a#index_o, - h3 a#index_p, - h3 a#index_q, - h3 a#index_r, - h3 a#index_s, - h3 a#index_t, - h3 a#index_u, - h3 a#index_v, - h3 a#index_w, - h3 a#index_x, - h3 a#index_y, - h3 a#index_z, - h3 a#index_0, - h3 a#index_1, - h3 a#index_2, - h3 a#index_3, - h3 a#index_4, - h3 a#index_5, - h3 a#index_6, - h3 a#index_7, - h3 a#index_8, - h3 a#index_9, - h3 a#index_0x7e - { - font-family: time; - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Verbatim Source Code / Examples. - */ - - /* pre.fragment { background-color: #EEEEEE; } */ - - span.keyword { color: #008000 } - span.keywordtype { color: #604020 } - span.keywordflow { color: #e08000 } - span.comment { color: #800000 } - span.preprocessor { color: #806020 } - span.stringliteral { color: #002080 } - span.charliteral { color: #008080 } - span.red { color: red } - - -/* ------------------------------------------------------------------- - * Attributes Listing. - */ - -p.formulaDsp { - text-align: center; -} - - .mdTable { - /*border: 1px solid #868686;*/ - /*background-color: #DADAEF;*/ - /*background-color: #F4F4FB;*/ - border: 1px none #008500; - border-left-width: 1px; - border-left-style: solid; - /*background-color: #B8E6B8;*/ - /*background-color: #CCE6CA;*/ - margin-top: 25px; - font-size: 105%; - } - - .mdRow { - padding: 5px 10px; - } - - /* This Mozilla/Firefox bug has been corrected from v1.5. - * .mdname1 { - * padding: 3px 0px 0px 0px; - * } - */ - - .mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - font-size: 11px; - font-style: italic; - /*background-color: #FAFAFA;*/ - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; - } - - .memitem { - margin-bottom: 30px; - border: 1px none #008500; - } - - .memproto { - background-color: #CCE6CA; - border-left-width: 4px; - border-left-style: solid; - border-color: #008500; - } - - .memname { - white-space: nowrap; - padding-left: 5px; - font-size: 105%; - } - - - .memdoc{ - padding-left: 5px; - /*margin-top: -8px;*/ - border-left-width: 1px; - border-left-style: solid; - border-color: #008500; - } - - div.contents * table tr { - padding: 3px 3px 3px 8px; - } - - .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight { - /*padding: 1px 0px 0px 8px;*/ - padding: 3px 3px 3px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - /* - border-top-color: #0c0c0c; - border-right-color: #0c0c0c; - border-bottom-color: #0c0c0c; - border-left-color: #0c0c0c; - */ - border-top-style: none; - border-right-style: none; - border-bottom-style: dotted; - border-left-style: none; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - /*background-color: #CCE6CA;*/ - } - - .memTemplItemLeft, .memTemplItemRight { - border-bottom-width: 2px; - border-bottom-style: solid; - font-weight: bold; - } - - .memItemLeft { font-size: 11px; } - .memItemRight { font-size: 12px; } - .memTemplItemLeft { font-size: 11px; } - .memTemplItemRight { font-size: 12px; } - - .memTemplParams { - color: #FFFFFF; - background-color: #000000; - font-size: 11px; - font-weight: bold; - } - - .groupText, .groupHeader { - color: #09550B; - font-size: 130%; - font-weight: bold; - margin-top: 15px; - } - - .groupHeader { - margin-bottom: -30pt; - } - diff --git a/hurricane/doc/hurricane/SoC.css b/hurricane/doc/hurricane/SoC.css index cbb67dce..71136369 100644 --- a/hurricane/doc/hurricane/SoC.css +++ b/hurricane/doc/hurricane/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -303,7 +317,7 @@ border: 2px solid black; } - div.center { + div.center, div.image { text-align: center; } @@ -361,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -374,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -422,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -439,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -556,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -566,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -595,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -640,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -662,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr { diff --git a/hurricane/doc/viewer/ASIM-bigfonts.css b/hurricane/doc/viewer/ASIM-bigfonts.css deleted file mode 100644 index f8ec6823..00000000 --- a/hurricane/doc/viewer/ASIM-bigfonts.css +++ /dev/null @@ -1,353 +0,0 @@ - - -/* - * x-----------------------------------------------------------------x - * | HTML Standart Tags | - * x-----------------------------------------------------------------x - */ - - html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 100%; - font-family: verdana, sans-serif; - } - - body { - color: black; - background: white; - background-color: white; - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin-top: 2em; - margin-right: 10%; - margin-left: 10%; - } - - hr { - height: 1px; - border: 0; - color: #004400; - background-color: #004400; - } - - - h1, h2, h3, h4, h5, h6 { - font-family: verdana, sans-serif; - } - - h1 { text-align: center; } - h2, h3, h4, h5, h6 { text-align: left; - padding-top: 2em; - } - h1, h2, h3 { font-family: "Trebuchet MS", sans-serif; - color: #09550B; - } - h1 { font-weight: bold; font-size: 170%; } - h2 { font-weight: bold; font-size: 140%; } - h3 { font-weight: bold; font-size: 118%; } - h4 { font-weight: bold; font-size: 100%; } - h5 { font-style: italic; font-size: 100%; } - h6 { font-variant: small-caps; font-size: 100%; } - - .hide { - display: none; - color: white; - } - - - p { - margin-top: 0.6em; - margin-bottom: 0.6em; - margin-left: 0.0em; - margin-right: 0.0em; - } - - - address { - text-align: right; - font-weight: bold; - font-style: italic; - font-size: 80%; - } - - - caption { font-weight: bold } - - - blockquote { - margin-left: 4em; - margin-right: 4em; - margin-top: 0.8em; - margin-bottom: 0.8em; - font-style: italic; - color: #003300; - } - - blockquote p { - margin-bottom: 0; - } - - blockquote address { - margin: 0; - } - - - table { - border-collapse: collapse; - } - - dt, dd { margin-top: 0; margin-bottom: 0; } - dt { font-weight: bold; } - - - pre, tt, code { - font-family: "andale mono", monospace; - font-size: 100%; - white-space: pre; - } - - pre { - font-size: 80%; - border: solid; - border-width: thin; - border-color: #003300; - background-color: #EEEEEE; - padding: 0.5em; - margin-left: 2em; - margin-right: 2em - } - - tt { color: green; } - em { font-style: italic; font-weight: bold; } - strong { font-weight: bold; } - - span.textit { font-style: italic; } - span.textbf { font-weight: bold; } - - .small { font-size: 90%; } - .white { color: #FFFFFF; } - - - ul.toc { - list-style: disc; - list-style: none; - } - - - a:link img, a:visited img { border-style: none; } - a img { color: white; } - - a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; - } - - a:hover, a:focus { - color: #FF9900; - text-decoration: underline; - } - - - - -/* - * x-----------------------------------------------------------------x - * | Doxygen Specific Classes | - * x-----------------------------------------------------------------x - */ - - -/* ------------------------------------------------------------------- - * Header & Footer Classes (customized top page navigation bar). - */ - - table.header { - width: 100%; - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - h1.header { - font-family: times, verdana, sans-serif; - } - - td.header { - /*width: 14%;*/ - text-align: center; - font-weight: bold; - font-family: verdana, sans-serif; - } - - table.footer { - width: 100%; - } - - td.leftFoot1, td.leftFoot2 { - text-align: left; - } - - td.rightFoot1, td.rightFoot2 { - text-align: right; - } - - td.leftFoot2 { - font-family: time; - font-weight: bold; - } - - td.rightFoot2 { - font-weight: bold; - } - - div.ah { - font-family: time; - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Quick Index Class (top page navigation bar). - */ - - div.qindex, div.nav { - width: 100%; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - border: 1px solid #003300; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; - } - - a.qindex, a.qindex:visited, a.qindex:hover, a.qindexHL, a.el, a.elRef { - text-decoration: none; - font-weight: bold; - } - - a.qindex, a.qindex:visited { - color: #09550B; - } - - a.qindex:hover { - background-color: #ddddff; - } - - a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { - background-color: #0c780c; - color: #ffffff; - border: 1px double #9295C2; - } - - a.code:link, a.code:visited, a.codeRef:link, a.codeRef:visited { - text-decoration: none; - font-weight: normal; - color: #0000ff; - } - - .indexkey { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey, .indexvalue { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey { - width: 40%; - } - - .indexvalue { - width: 80%; - } - - -/* ------------------------------------------------------------------- - * Verbatim Source Code / Examples. - */ - - pre.fragment { background-color: #EEEEEE; } - - span.keyword { color: #008000 } - span.keywordtype { color: #604020 } - span.keywordflow { color: #e08000 } - span.comment { color: #800000 } - span.preprocessor { color: #806020 } - span.stringliteral { color: #002080 } - span.charliteral { color: #008080 } - - -/* ------------------------------------------------------------------- - * Attributes Listing. - */ - - .mdTable { - /*border: 1px solid #868686;*/ - /*background-color: #DADAEF;*/ - /*background-color: #F4F4FB;*/ - border: 1px none #868686; - /*background-color: #B8E6B8;*/ - background-color: #CCE6CA; - margin-top: 25px; - } - - .mdRow { - padding: 5px 10px; - } - - /* This Mozilla/Firefox bug has been corrected from v1.5. - * .mdname1 { - * padding: 3px 0px 0px 0px; - * } - */ - - .mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - font-size: 12px; - font-style: italic; - /*background-color: #FAFAFA;*/ - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; - } - - .memItemLeft, .memItemRight, .memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #0c0c0c; - border-right-color: #0c0c0c; - border-bottom-color: #0c0c0c; - border-left-color: #0c0c0c; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - .memItemLeft { font-size: 12px; } - .memItemRight { font-size: 13px; } - .memTemplItemLeft { font-size: 12px; } - .memTemplItemRight { font-size: 13px; } - - .memTemplParams { - color: #606060; - background-color: #DADAEF; - font-size: 12px; - } - diff --git a/hurricane/doc/viewer/ASIM.css b/hurricane/doc/viewer/ASIM.css deleted file mode 100644 index 3b99772e..00000000 --- a/hurricane/doc/viewer/ASIM.css +++ /dev/null @@ -1,554 +0,0 @@ - - -/* - * +-----------------------------------------------------------------+ - * | HTML Standart Tags | - * +-----------------------------------------------------------------+ - */ - - html, body, th, td, tr, p, li, h1, h2, h3, h4, h5, h6 { - font-size: 11pt; - /* The Open Sans font family is supplied by TexLive. */ - font-family: "Open Sans", Verdana, sans-serif;; - } - - body { - color: black; - background: white; - background-color: white; - background-position: top left; - background-attachment: fixed; - background-repeat: no-repeat; - margin-top: 2em; - width: 550pt; - margin-right: auto; - margin-left: auto; - /* - margin-right: 12%; - margin-left: 12%; - */ - } - - hr { - height: 1px; - border: 0; - color: #004400; - background-color: #004400; - } - - - h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ - } - - h1 { text-align: center; } - h2, h3, h4, h5, h6 { text-align: left; - padding-top: 11pt; - } - h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ - /*color: #09550B;*/ - } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } - h4 { font-weight: bold; font-size: 100%; } - h5 { font-style: italic; font-size: 100%; } - h6 { font-variant: small-caps; font-size: 100%; } - - h2.classHierarchy { - /*border: 1px none #008500;*/ - border: 1px none #000000; - border-top-width: 1px; - border-top-style: dotted; - padding-top: 1em; - } - - - .hide { - display: none; - color: white; - } - - - p { - margin-top: 0.6em; - margin-bottom: 0.6em; - margin-left: 0.0em; - margin-right: 0.0em; - } - - - address { - text-align: right; - font-weight: bold; - font-style: italic; - font-size: 80%; - } - - - caption { font-weight: bold } - - - blockquote { - margin-left: 4em; - margin-right: 4em; - margin-top: 0.8em; - margin-bottom: 0.8em; - font-style: italic; - color: #003300; - } - - blockquote p { - margin-bottom: 0; - } - - blockquote address { - margin: 0; - } - - - table { - border-collapse: collapse; - } - - dt, dd { margin-top: 0; margin-bottom: 0; } - dt { font-weight: bold; } - - - pre, tt, code { - /*font-family: "andale mono", monospace;*/ - font-size: 100%; - white-space: pre; - } - - pre { - font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; - /* - background-color: #EEEEEE; - */ - background-color: #FCFCE1; - padding: 0.5em; - margin-left: 2em; - margin-right: 2em - } - - tt { color: green; } - em { font-style: italic; - font-weight: normal; } - strong { font-weight: bold; } - - span.textit { font-style: italic; } - span.textbf { font-weight: bold; } - - .small { font-size: 90%; } - .white { color: #FFFFFF; } - - - ul.toc { - list-style: disc; - list-style: none; - } - - - a:link img, a:visited img { border-style: none; } - a img { color: white; } - - a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; - } - - a:hover, a:focus { - color: #FF9900; - text-decoration: underline; - } - - -/* - * +-----------------------------------------------------------------+ - * | Doxygen Specific Classes | - * +-----------------------------------------------------------------+ - */ - - -/* ------------------------------------------------------------------- - * Header & Footer Classes (customized top page navigation bar). - */ - - h1.header { - font-size: 200%; - /*font-family: times, verdana, sans-serif;*/ - } - - center.header { - background-color: #CCE6CA; - } - - table.header { - /*width: 100%;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - } - - table.header td { - padding: 2px 14px; - text-align: center; - font-weight: bold; - /*font-family: verdana, sans-serif;*/ - font-size: 110%; - } - - table.DoxUser td, table.DoxUser th { - padding: 0px 5px; - border: 0px; - } - - table.DoxUser th { - background-color: #CCE6CA; - } - - table.footer1, table.footer2 { width: 100%; } - td.LFooter { text-align: left; } - td.RFooter { text-align: right; } - td.CFooter { text-align: center;} - table.footer2 td.RFooter { font-weight: bold; width: 35% } - table.footer2 td.CFooter { width: 30% } - table.footer2 td.LFooter { font-weight: bold; width: 35%; /*font-family: time;*/ } - - table.classHierarchy { - border-collapse: separate; - border-spacing: 5px; - font-size: 110%; - } - - table.classHierarchy tr { - border: 1px solid blue; - } - - table.classHierarchy td.normal { - border: 1px solid #CCE6CA; - width: 140pt; - text-align: center; - font-weight: bold; - background-color: #CCE6CA; - } - - table.classHierarchy td.virtual { - border: 1px solid black; - width: 140pt; - text-align: center; - font-weight: bold; - } - - table.classHierarchy td.wnormal { - border: 1px solid #CCE6CA; - width: 240pt; - text-align: center; - font-weight: bold; - background-color: #CCE6CA; - } - - table.classHierarchy td.wvirtual { - border: 1px solid black; - width: 240pt; - text-align: center; - font-weight: bold; - } - - div.ah { - /*font-family: time;*/ - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Quick Index Class (top page navigation bar). - */ - - div.qindex, div.nav { - width: 100%-4px; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; - border: 0px solid #003300; - text-align: center; - margin: 0px; - padding: 2px; - line-height: 140%; - } - - a.qindex, a.qindex:visited, a.qindex:hover, a.qindexHL, a.el, a.elRef { - text-decoration: none; - /*font-family: Courier;*/ - font-weight: normal; - /*font-size: 110%;*/ - } - - a.qindex, a.qindex:visited { - color: #09550B; - } - - a.qindex:hover { - background-color: #ddddff; - } - - a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { - background-color: #0c780c; - color: #ffffff; - border: 1px double #9295C2; - } - - a.code:link, a.code:visited, a.codeRef:link, a.codeRef:visited { - text-decoration: none; - font-weight: normal; - color: #0000ff; - } - - .indexkey { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey, .indexvalue { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - padding: 2px 15px; - } - - .indexkey { - width: 40%; - } - - .indexvalue { - width: 80%; - } - - h3 a[name="index__"], - h3 a[name="index_a"], - h3 a[name="index_b"], - h3 a[name="index_c"], - h3 a[name="index_d"], - h3 a[name="index_e"], - h3 a[name="index_f"], - h3 a[name="index_g"], - h3 a[name="index_h"], - h3 a[name="index_i"], - h3 a[name="index_j"], - h3 a[name="index_k"], - h3 a[name="index_l"], - h3 a[name="index_m"], - h3 a[name="index_n"], - h3 a[name="index_o"], - h3 a[name="index_p"], - h3 a[name="index_q"], - h3 a[name="index_r"], - h3 a[name="index_s"], - h3 a[name="index_t"], - h3 a[name="index_u"], - h3 a[name="index_v"], - h3 a[name="index_w"], - h3 a[name="index_x"], - h3 a[name="index_y"], - h3 a[name="index_z"], - h3 a[name="index_0"], - h3 a[name="index_1"], - h3 a[name="index_2"], - h3 a[name="index_3"], - h3 a[name="index_4"], - h3 a[name="index_5"], - h3 a[name="index_6"], - h3 a[name="index_7"], - h3 a[name="index_8"], - h3 a[name="index_9"] - h3 a[id="index__"], - h3 a#index_a, - h3 a#index_b, - h3 a#index_c, - h3 a#index_d, - h3 a#index_e, - h3 a#index_f, - h3 a#index_g, - h3 a#index_h, - h3 a#index_i, - h3 a#index_j, - h3 a#index_k, - h3 a#index_l, - h3 a#index_m, - h3 a#index_n, - h3 a#index_o, - h3 a#index_p, - h3 a#index_q, - h3 a#index_r, - h3 a#index_s, - h3 a#index_t, - h3 a#index_u, - h3 a#index_v, - h3 a#index_w, - h3 a#index_x, - h3 a#index_y, - h3 a#index_z, - h3 a#index_0, - h3 a#index_1, - h3 a#index_2, - h3 a#index_3, - h3 a#index_4, - h3 a#index_5, - h3 a#index_6, - h3 a#index_7, - h3 a#index_8, - h3 a#index_9, - h3 a#index_0x7e - { - font-family: time; - font-size: 250%; - } - - -/* ------------------------------------------------------------------- - * Verbatim Source Code / Examples. - */ - - /* pre.fragment { background-color: #EEEEEE; } */ - - span.keyword { color: #008000 } - span.keywordtype { color: #604020 } - span.keywordflow { color: #e08000 } - span.comment { color: #800000 } - span.preprocessor { color: #806020 } - span.stringliteral { color: #002080 } - span.charliteral { color: #008080 } - span.red { color: red } - - -/* ------------------------------------------------------------------- - * Attributes Listing. - */ - -p.formulaDsp { - text-align: center; -} - - .mdTable { - /*border: 1px solid #868686;*/ - /*background-color: #DADAEF;*/ - /*background-color: #F4F4FB;*/ - border: 1px none #008500; - border-left-width: 1px; - border-left-style: solid; - /*background-color: #B8E6B8;*/ - /*background-color: #CCE6CA;*/ - margin-top: 25px; - font-size: 105%; - } - - .mdRow { - padding: 5px 10px; - } - - /* This Mozilla/Firefox bug has been corrected from v1.5. - * .mdname1 { - * padding: 3px 0px 0px 0px; - * } - */ - - .mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - font-size: 11px; - font-style: italic; - /*background-color: #FAFAFA;*/ - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; - } - - .memitem { - margin-bottom: 30px; - border: 1px none #008500; - } - - .memproto { - background-color: #CCE6CA; - border-left-width: 4px; - border-left-style: solid; - border-color: #008500; - } - - .memname { - white-space: nowrap; - padding-left: 5px; - font-size: 105%; - } - - - .memdoc{ - padding-left: 5px; - /*margin-top: -8px;*/ - border-left-width: 1px; - border-left-style: solid; - border-color: #008500; - } - - div.contents * table tr { - padding: 3px 3px 3px 8px; - } - - .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight { - /*padding: 1px 0px 0px 8px;*/ - padding: 3px 3px 3px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - /* - border-top-color: #0c0c0c; - border-right-color: #0c0c0c; - border-bottom-color: #0c0c0c; - border-left-color: #0c0c0c; - */ - border-top-style: none; - border-right-style: none; - border-bottom-style: dotted; - border-left-style: none; - /*background-color: #DADAEF;*/ - /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - /*background-color: #CCE6CA;*/ - } - - .memTemplItemLeft, .memTemplItemRight { - border-bottom-width: 2px; - border-bottom-style: solid; - font-weight: bold; - } - - .memItemLeft { font-size: 11px; } - .memItemRight { font-size: 12px; } - .memTemplItemLeft { font-size: 11px; } - .memTemplItemRight { font-size: 12px; } - - .memTemplParams { - color: #FFFFFF; - background-color: #000000; - font-size: 11px; - font-weight: bold; - } - - .groupText, .groupHeader { - color: #09550B; - font-size: 130%; - font-weight: bold; - margin-top: 15px; - } - - .groupHeader { - margin-bottom: -30pt; - } - diff --git a/hurricane/doc/viewer/SoC.css b/hurricane/doc/viewer/SoC.css index 9f833e18..90b66894 100644 --- a/hurricane/doc/viewer/SoC.css +++ b/hurricane/doc/viewer/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -220,6 +234,18 @@ font-size: 110%; } + table.UserDefined { + border: 1px solid; + } + + table.UserDefined th { + border: 1px solid; + } + + table.UserDefined td { + padding: 0px 5px; + } + table.DoxUser td, table.DoxUser th { padding: 0px 5px; border: 0px; @@ -349,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -362,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -410,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -427,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -544,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -554,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -583,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -628,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -650,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr { diff --git a/katabatic/doc/SoC.css b/katabatic/doc/SoC.css index 9f833e18..71136369 100644 --- a/katabatic/doc/SoC.css +++ b/katabatic/doc/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -220,6 +234,18 @@ font-size: 110%; } + table.UserDefined { + border: 1px solid; + } + + table.UserDefined th { + border: 1px solid; + } + + table.UserDefined td { + padding: 0px 5px; + } + table.DoxUser td, table.DoxUser th { padding: 0px 5px; border: 0px; @@ -291,7 +317,7 @@ border: 2px solid black; } - div.center { + div.center, div.image { text-align: center; } @@ -349,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -362,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -410,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -427,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -544,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -554,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -583,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -628,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -650,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr { diff --git a/kite/doc/SoC.css b/kite/doc/SoC.css index 9f833e18..71136369 100644 --- a/kite/doc/SoC.css +++ b/kite/doc/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -220,6 +234,18 @@ font-size: 110%; } + table.UserDefined { + border: 1px solid; + } + + table.UserDefined th { + border: 1px solid; + } + + table.UserDefined td { + padding: 0px 5px; + } + table.DoxUser td, table.DoxUser th { padding: 0px 5px; border: 0px; @@ -291,7 +317,7 @@ border: 2px solid black; } - div.center { + div.center, div.image { text-align: center; } @@ -349,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -362,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -410,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -427,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -544,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -554,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -583,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -628,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -650,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr { diff --git a/unicorn/doc/unicorn/SoC.css b/unicorn/doc/unicorn/SoC.css index 9f833e18..90b66894 100644 --- a/unicorn/doc/unicorn/SoC.css +++ b/unicorn/doc/unicorn/SoC.css @@ -12,6 +12,10 @@ font-family: "Open Sans", Verdana, sans-serif;; } + html { + background: #dddddd; + } + body { color: black; background: white; @@ -20,9 +24,10 @@ background-attachment: fixed; background-repeat: no-repeat; margin-top: 2em; - width: 550pt; + width: 600pt; margin-right: auto; margin-left: auto; + padding: 30pt; /* margin-right: 12%; margin-left: 12%; @@ -38,19 +43,21 @@ h1, h2, h3, h4, h5, h6 { - /*font-family: "Liberation Serif", sans-serif;*/ + /*font-family: "URW Bookman L", "Liberation Serif", sans-serif;*/ + font-family: "URW Bookman L"; } - h1 { text-align: center; } + h1.header { text-align: center; } + h1 { text-align: left; } h2, h3, h4, h5, h6 { text-align: left; padding-top: 11pt; } h1, h2, h3 { /*font-family: "Liberation Serif", sans-serif; */ /*color: #09550B;*/ } - h1 { font-weight:normal; font-size: 170%; letter-spacing:0.2em; word-spacing:0.4em; } - h2 { font-weight:normal; font-size: 140%; letter-spacing:0.2em; word-spacing:0.4em; } - h3 { font-weight: bold; font-size: 118%; letter-spacing:0.2em; word-spacing:0.4em; } + h1 { font-weight: bold; font-size: 170%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h2 { font-weight: bold; font-size: 140%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } + h3 { font-weight: bold; font-size: 118%; /*letter-spacing:0.2em; word-spacing:0.4em;*/ } h4 { font-weight: bold; font-size: 100%; } h5 { font-style: italic; font-size: 100%; } h6 { font-variant: small-caps; font-size: 100%; } @@ -156,14 +163,20 @@ a:link img, a:visited img { border-style: none; } a img { color: white; } + a { + color: black; + border-bottom: 1px solid black; + text-decoration: none; + } + a:link, a:active, a:visited { - color: #09550B; - text-decoration: none; + /*color: #09550B;*/ + /*text-decoration: none;*/ } a:hover, a:focus { - color: #FF9900; - text-decoration: underline; + /*color: #FF9900; */ + border-bottom: 2px solid black; } @@ -210,6 +223,7 @@ padding: 2px 0px; text-align: center; background-color: black; + border-bottom: none; } table.header td { @@ -220,6 +234,18 @@ font-size: 110%; } + table.UserDefined { + border: 1px solid; + } + + table.UserDefined th { + border: 1px solid; + } + + table.UserDefined td { + padding: 0px 5px; + } + table.DoxUser td, table.DoxUser th { padding: 0px 5px; border: 0px; @@ -349,7 +375,7 @@ display: table-cell; text-align: center; padding: 2pt; - width: 10%; + width: 5%; } ul.tablist li:hover { @@ -362,7 +388,9 @@ color: white; } - ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; } + ul.tablist * a { border-bottom: none; } + + ul.tablist * a:link img, ul.tablist * a:visited img { border-style: none; border-bottom: none; } ul.tablist * a:link, ul.tablist * a:visited { color: black; @@ -410,8 +438,8 @@ width: 100%-4px; /*background-color: #DADAEF;*/ /*background-color: #eeeeff;*/ - /*background-color: #EEEEEE;*/ - background-color: #CCE6CA; + background-color: #cccccc; + /*background-color: #CCE6CA;*/ border: 0px solid #003300; text-align: center; margin: 0px; @@ -427,11 +455,18 @@ } a.qindex, a.qindex:visited { - color: #09550B; + /*color: #09550B;*/ + color: black; + border: 2px solid #cccccc; + padding: 2px 2px; + border-bottom: none; } a.qindex:hover { - background-color: #ddddff; + /*background-color: #ddddff;*/ + font-weight: bold; + padding: 2px 2px; + border: 2px solid black; } a.qindexHL, a.qindexHL:hover, a.qindexHL:visited { @@ -544,6 +579,7 @@ { font-family: time; font-size: 250%; + text-align: center; } @@ -554,9 +590,10 @@ div.fragment { font-family: "Monospace"; font-size: 80%; - border: dashed; - border-width: thin; - border-color: #003300; + border: none; + /*border-width: thin; */ + /*border-color: #003300;*/ + /*background-color: #FCFCE1;*/ background-color: #FCFCE1; padding: 0.5em; margin-left: 5%; @@ -583,9 +620,17 @@ * Attributes Listing. */ -p.formulaDsp { - text-align: center; -} + a.el, a.elRef { + font-family: Courier; + font-weight: bold; + font-size: 110%; + color: black; + border-bottom: none; + } + + p.formulaDsp { + text-align: center; + } .mdTable { /*border: 1px solid #868686;*/ @@ -628,10 +673,12 @@ p.formulaDsp { } .memproto { - background-color: #CCE6CA; + /*background-color: #CCE6CA;*/ + background-color: #cccccc; border-left-width: 4px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } .memname { @@ -650,7 +697,8 @@ p.formulaDsp { /*margin-top: -8px;*/ border-left-width: 1px; border-left-style: solid; - border-color: #008500; + /*border-color: #008500;*/ + border-color: black; } div.contents * table tr {