.. _api_python_pyrogue:

=======
pyrogue
=======

The ``pyrogue`` namespace contains the tree object model, pure-Python helper
classes, and higher-level wrappers built on top of Rogue runtime services.


Core objects
============

.. toctree::
   :maxdepth: 1
   :titlesonly:

   node
   root
   pollqueue
   device
   localblock
   process
   runcontrol
   datareceiver
   datawriter

Commands
========

.. toctree::
   :maxdepth: 1
   :titlesonly:

   basecommand
   remotecommand

Variables
=========

.. toctree::
   :maxdepth: 1
   :titlesonly:

   basevariable
   remotevariable
   localvariable
   linkvariable

Models
======

.. toctree::
   :maxdepth: 1
   :titlesonly:

   model
   uint
   int
   bool
   string
   float
   double
   fixed
   ufixed

Helpers
=======

.. toctree::
   :maxdepth: 1
   :titlesonly:

   wordcount
   bytecount
   reversebits
   twoscomplement
   pydm_runpydm

PyDM
====

.. toctree::
   :maxdepth: 1
   :titlesonly:

   pydm_widgets/index

Subpackages
===========

.. toctree::
   :maxdepth: 1
   :titlesonly:

   interfaces/index
   protocols/index
   utilities/index


.. rubric:: Related Topics

- :doc:`/pyrogue_tree/index`
- :doc:`/pyrogue_tree/core/index`
- :doc:`/pyrogue_tree/builtin_devices/index`