.. IDPET documentation master file, created by
   sphinx-quickstart on Thu Oct 10 12:10:37 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to IDPET's documentation!
=================================

*Last updated: June 2024*

**IDPET** (**I**\ntrinsically **D**\isordered **P**\rotein **E**\nsemble **T**\ools) is a Python package for comprehensively analyzing of the conformational ensembles of disordered proteins. It is built upon the mdtraj library for reading the ensemble files in various formats. 
**IDPET** provides informative visualizations based on multiple global and local features of the flexible regions of proteins. Additionally, it integrates various dimensionality reduction and statistical methods to facilitate the analysis of conformational ensembles.


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   overview
   installation
   demo
   ensemble_analysis
   ensemble
   visualization
   comparison

.. automodule:: dpet
   :members:
   :undoc-members:
   :show-inheritance:



Changelog
==========
*Last updated: June 2024*

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

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