The OSVVM Simulator Script Library
##################################

The *OSVVM Simulator Script Library* provides a simple way to compile designs, run simulations, and use libraries.

This scripting approach provides:

* Scripts as simple as a list of files
* Scripts that run on any simulator
* Simple path management – everything is relative to the script location
* Simple usage of libraries





.. _CONTRIBUTORS:

Contributors
************

* `Jim Lewis <https://GitHub.com/JimLewis>`__ (Maintainer)
* `Patrick Lehmann <https://GitHub.com/Paebbels>`__
* `and more... <https://GitHub.com/OSVVM/OSVVM-Scripts/graphs/contributors>`__


.. _LICENSE:

License
*******

.. only:: html

   The ``::osvvm`` TCL namespace (source code) is licensed under `Apache License 2.0 <Code-License.html>`__. |br|
   The accompanying documentation is licensed under `Creative Commons - Attribution 4.0 (CC-BY 4.0) <Doc-License.html>`__.

.. only:: latex

   This ``::osvvm`` TCL namespace (source code) is licensed under **Apache License 2.0**. |br|
   The accompanying documentation is licensed under **Creative Commons - Attribution 4.0 (CC-BY 4.0)**.


.. toctree::
   :caption: Overview
   :hidden:

   Installation
   QuickStartGuide

.. raw:: latex

   \part{Main Documentation}

.. toctree::
   :caption: User Guide
   :hidden:

   UserGuide/index
   Reports/index

.. raw:: latex

   \part{References and Reports}

.. toctree::
   :caption: References and Reports
   :hidden:

   TCL Command Reference <osvvm-scripts/osvvm>
   YAML/index

.. raw:: latex

   \part{Appendix}

.. toctree::
   :caption: Appendix
   :hidden:

   License
   Doc-License
   Glossary
   genindex
   TODO