Metadata-Version: 2.4
Name: ensemblify
Version: 1.0.0
Summary: A Python package for generating ensembles of intrinsically disordered regions of AlphaFold or user defined models.
Author-email: "Nuno P. Fernandes" <nmpfernandes@itqb.unl.pt>
Project-URL: Repository, https://github.com/npfernandes/ensemblify
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: biopython==1.81
Requires-Dist: MDAnalysis==2.6.1
Requires-Dist: mdtraj==1.9.9
Requires-Dist: numpy==1.26.4
Requires-Dist: pandas==2.2.2
Requires-Dist: plotly==5.23.0
Requires-Dist: pyarrow==13.0.0
Requires-Dist: pyyaml==6.0.1
Requires-Dist: ray==2.33.0
Requires-Dist: scikit-learn==1.4.2
Requires-Dist: scipy==1.12.0
Requires-Dist: tqdm==4.66.2
Dynamic: license-file

# Ensemblify: A Python package for generating ensembles of intrinsically disordered regions of AlphaFold or user defined models

<img src="docs/assets/ensemblify_presentation.svg" width="100%"/>

<div align="justify">

### 💡 What is Ensemblify?

**Ensemblify** is a Python package that can generate protein conformational ensembles by sampling dihedral angle values from a three-residue fragment database and inserting them into flexible regions of a protein of interest (*e.g.* intrinsically disordered regions (IDRs)).

It supports both user-defined models and AlphaFold<sup>[[1]](https://doi.org/10.1038/s41586-021-03819-2)</sup> predictions, using the predicted Local Distance Difference Test (pLDDT) and Predicted Aligned Error (PAE) confidence metrics to guide conformational sampling. Designed to enhance the study of IDRs, it allows flexible customization of sampling parameters and works with single or multi-chain proteins, offering a powerful tool for protein structure research. Ensemble analysis and reweighting with experimental data is also available through interactive graphical dashboards.

### 🧰 How do I install Ensemblify?
Step-by-step instructions for installing Ensemblify are available in the [Documentation](https://ensemblify.readthedocs.io/latest/installation.html).

### 💻 How can I use Ensemblify?
Ensemblify can be used either as a Command Line Interface (CLI):

    conda activate ensemblify_env
    (ensemblify_env) $ ensemblify [options]

or as a Python library inside a script or Jupyter notebook:

    import ensemblify as ey
    ey.show_config()

Check the [Documentation](https://ensemblify.readthedocs.io/latest/usage.html) for more details.

### 🔎 How does Ensemblify work?
A general overview of Ensemblify, descriptions of employed methods and applications can be found in the Ensemblify [pre-print](https://www.biorxiv.org/content/10.1101/2025.08.26.672300v1) and accompanying support information.

## 🗃 Tripeptide Database

Ensemblify provides a three-residue fragment (tripeptide) database from which to sample dihedral angle values.

This database is provided separately from the Ensemblify source-code.

You can get it [here](https://zenodo.org/records/16948909) and more about its creation in the [Documentation](https://ensemblify.readthedocs.io/latest/database.html).

## 📚 Accessing Documentation

Ensemblify's documentation is available together with an API reference at https://ensemblify.readthedocs.io.
Alternatively, the source-code contains docstrings with relevant information. 

## 🗨️ Citation and Publications

If you use Ensemblify, please cite its original paper:

    @article {ensemblify2025,
	title = {Ensemblify: a user-friendly tool for generating ensembles of intrinsically disordered regions of AlphaFold and user-defined models},
    author = {Fernandes, Nuno and Gomes, Tiago Lopes and Cordeiro, Tiago N},
    journal = {bioRxiv}
	year = {2025},
	publisher = {Cold Spring Harbor Laboratory},
    doi = {10.1101/2025.08.26.672300},
	URL = {https://www.biorxiv.org/content/early/2025/08/30/2025.08.26.672300},
    }


## 🤝 Acknowledgements

We would like to thank the DeepMind team for developing AlphaFold.

We would also like to thank the team at the Juan Cortés lab in the LAAS-CNRS institute for creating the tripeptide database used in the development of this tool. Check out their work at https://moma.laas.fr/.

## ✍️ Authors

**Nuno P. Fernandes** (Main Developer) [[GitHub]](https://github.com/npfernandes?tab=repositories)

**Tiago Lopes Gomes** (Initial prototyping, Supervisor) [[GitHub]](https://github.com/TiagoLopesGomes?tab=repositories)

**Tiago N. Cordeiro** (Supervisor) [[GitHub]](https://github.com/CordeiroLab?tab=repositories)

</div>
