Skip to content

Commit 4b05cb4

Browse files
authored
Remove README.md
Removed README.md content — merged into module docstring
1 parent d5bbac8 commit 4b05cb4

File tree

1 file changed

+0
-96
lines changed

1 file changed

+0
-96
lines changed
Lines changed: 0 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1 @@
1-
# 🧬 PPIIMoL
2-
3-
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
4-
[![Python](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org/)
5-
[![PyMOL](https://img.shields.io/badge/PyMOL-2.x-green)](https://pymol.org/)
6-
7-
## 📖 Descripción
8-
9-
**PPIIMoL** es un módulo en Python diseñado para integrarse con **PyMOL** y automatizar la detección de hélices de poliprolina II (PPII) en proteínas. Esta herramienta facilita el análisis estructural, identificando rápidamente ángulos torsionales (`phi` y `psi`) característicos, así como posibles enlaces de hidrógeno no canónicos (Cα-H···O=C).
10-
11-
Desarrollado como parte de un **Trabajo de Fin de Grado en Ingeniería Informática** en colaboración con el laboratorio de neurociencia del CSIC.
12-
13-
---
14-
15-
## 🚀 Características
16-
- 🔍 Detección automática de segmentos PPII mediante análisis de ángulos phi y psi.
17-
- 🧬 Identificación de interacciones Cα-H···O=C relevantes para la estabilidad estructural.
18-
- 📊 Exportación de resultados en CSV para análisis adicionales.
19-
- 🎨 Visualización directa en PyMOL con códigos de color personalizados.
20-
- 🖱️ Interfaz gráfica sencilla basada en Tkinter.
21-
22-
---
23-
24-
## 🛠️ Requisitos
25-
- Python >= 3.9
26-
- [PyMOL](https://pymol.org/2/) (entorno gráfico)
27-
- Tkinter (incluido en la mayoría de distribuciones de Python)
28-
29-
---
30-
31-
## 📦 Instalación
32-
33-
1. Clona este repositorio:
34-
```bash
35-
git clone https://github.com/silviaenma/PPIIMoL.git
36-
37-
Abre PyMOL y añade el módulo a la ruta de plugins o cárgalo manualmente:
38-
run PPIIMoL/PPIIMoL.py
39-
40-
🧪 Ejemplo de uso
41-
# Cargar el módulo en PyMOL
42-
run PPIIMoL/PPIIMoL.py
43-
44-
# Detectar hélices PPII en un archivo PDB
45-
load 3bog.pdb
46-
ppii_detect()
47-
48-
📂 Los resultados se exportarán automáticamente en una carpeta organizada con fecha.
49-
50-
📜 Licencia
51-
Este proyecto está bajo la licencia GNU GPLv3.
52-
53-
🌐 Description (English)
54-
PPIIMoL is a Python module designed to integrate with PyMOL for the automatic detection of polyproline II (PPII) helices in proteins. This tool simplifies structural analysis by quickly identifying characteristic torsional angles (phi and psi), as well as potential non-canonical hydrogen bonds (Cα-H···O=C).
55-
56-
Developed as part of a Bachelor's Thesis in Computer Engineering in collaboration with the CSIC neuroscience lab.
57-
58-
🚀 Features
59-
🔍 Automatic detection of PPII segments via phi/psi angle analysis.
60-
61-
🧬 Identification of Cα-H···O=C interactions relevant to structural stability.
62-
63-
📊 Export of results in CSV for further analysis.
64-
65-
🎨 Direct visualization in PyMOL with customizable color codes.
66-
67-
🖱️ Simple GUI based on Tkinter.
68-
69-
🛠️ Requirements
70-
Python >= 3.9
71-
72-
PyMOL (graphical environment)
73-
74-
Tkinter (usually included in Python distributions)
75-
76-
📦 Installation
77-
1. Clone this repository:
78-
git clone https://github.com/silviaenma/PPIIMoL.git
79-
80-
2. Open PyMOL and load the module:
81-
run PPIIMoL/PPIIMoL.py
82-
83-
🧪 Example usage
84-
python
85-
Copiar
86-
Editar
87-
# Load the module in PyMOL
88-
run PPIIMoL/PPIIMoL.py
89-
90-
# Detect PPII helices in a PDB file
91-
load 3bog.pdb
92-
ppii_detect()
93-
📂 Results are automatically exported in a dated folder.
94-
95-
📜 License
96-
This project is licensed under the GNU GPLv3.
971

0 commit comments

Comments
 (0)