.. virl2_client documentation master file, created by

VIRL :sup:`2` API Client Documentation
=======================================

This is the VIRL :sup:`2` client library (`virl2_client`). It provides a Python
package to programmatically create, edit, delete and control network simulations
on a VIRL :sup:`2` controller.

.. toctree::
    :maxdepth: 2
    :caption: Content
    :glob:

    intro
    examples
    api/*

.. only:: internal

    Download
    --------

    `Download the client library (Linux/Win/macOS) </client>`_

    **Note** that the above link *only* works when the documentation is viewed
    on the VIRL :sup:`2` controller.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`