Metadata-Version: 2.3
Name: idpet
Version: 0.1.4
Summary: A Python package for analysis of conformational ensembles of intrinsically disordered proteins
Project-URL: Homepage, https://github.com/BioComputingUP/EnsembleTools
Project-URL: Repository, https://github.com/BioComputingUP/EnsembleTools
Author-email: Hamidreza Ghafouri <Hamidreza.ghafouri@studenti.unipd.it>
License: MIT License
        
        Copyright (c) [2025] [BioComputing  UP]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Requires-Python: >=3.7
Requires-Dist: matplotlib
Requires-Dist: mdtraj
Requires-Dist: nbformat
Requires-Dist: numba
Requires-Dist: numpy>=1.20
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: requests
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: umap-learn
Description-Content-Type: text/markdown

# IDPEnsembleTools

<img src="https://raw.githubusercontent.com/BioComputingUP/EnsembleTools/main/images/idpet_logo_1.png" alt="IDPEnsembleTools Logo" width="180" height="70" />

[![PyPI](https://img.shields.io/pypi/v/idpet.svg)](https://pypi.org/project/idpet/)
<!-- [![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.1234567-blue)](https://doi.org/10.5281/zenodo.1234567) -->

---

## IDPEnsembleTools: An Open-Source Library for Analysis of Conformational Ensembles of Disordered Proteins

IDPEnsembleTools is a Python package designed to facilitate the **loading, analysis, and comparison** of multiple conformational ensembles of intrinsically disordered proteins (IDPs).

It supports various input formats such as `.pdb`, `.xtc`, and `.dcd`, and enables users to extract both **global** and **local** structural features, perform dimensionality reduction, and compute similarity scores between ensembles.

<img src="https://raw.githubusercontent.com/BioComputingUP/EnsembleTools/main/images/pipline_example.jpeg" alt="Pipeline Example" width="600" />

---

## 🔧 Features

With **IDPEnsembleTools**, you can:

- **Extract global features** of structural ensembles:
  - Radius of gyration (Rg)
  - Asphericity
  - Prolateness
  - End-to-end distance

- **Extract local features**:
  - Interatomic distances
  - Phi–psi angles
  - Alpha-helix content

- **Perform dimensionality reduction** on ensemble features:
  - PCA
  - UMAP
  - t-SNE

- **Compare structural ensembles** using:
  - Jensen-Shannon (JS) divergence
  - Visualize similarity matrices

---

## 📦 Installation

### Using `pip`

Install the latest release from PyPI:

```bash
pip install idpet
```
## 📄 License

This project is licensed under the [MIT License](LICENSE).
