.. us_vis documentation master file, created by
   sphinx-quickstart on Mon May 20 08:58:01 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to us_vis's documentation!
==================================
**US-VIS** is a Python module that helps process and visualize umbrella sampling
runs obtained through *AMBER* (https://ambermd.org/index.php) and pre-processed
by *WHAM* (http://membrane.urmc.rochester.edu/?page_id=126). It visualises the
data and gives the options to delete runs, informs about the data and allows 
merging pictures.

wokrflow.py is a script that combines all of the functions and guides the user
through the process. 

Check out the :doc:`usage` section for installation information.

Contents: 

.. toctree::
   :maxdepth: 2
      
        Installation and requirements <usage>
        Functions description <functions>


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

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