.. include:: ../../apps-substitutions
.. include:: ../substitutions

.. _vbrood_overview:

===========================
Overview
===========================

**vBROOD** is the graphical interface that ships with **BROOD**. It gives access to all the command line
features as well as some GUI-only features, such as query editing,
and placing constraint and color atoms.  

Upon completion, **BROOD** clusters the resultant molecules.  **vBROOD** presents the cluster heads
for viewing; the full clusters can be explored in **VIDA** (see :ref:`vida-cluster`).

Most **BROOD** options can be changed from within **vBROOD**. **vBROOD** can easily run **BROOD** in multiprocessor mode; however, it cannot run **BROOD** across a cluster.

.. figure:: ../images/vbrood_home.png
   :scale: 40
   :align: center
   :alt: Task Screen

   **Figure 1.** The **vBROOD** task screen.
   
**vBROOD** offers five tasks to help run **BROOD**:

* :ref:`vbrood_build_run`: Creates a query and immediately starts a **BROOD** run.
* :ref:`vbrood_build_query`: Creates and edits a query to save and send to a **BROOD** run.
* :ref:`vbrood_run_brood`: Runs **BROOD** with a query.
* :ref:`vbrood_view_results`: Browses results and launches the **BROOD** interface in **VIDA**.

