porcupineplot

PORCUPINEplot is a script developed to automate the generation of porcupine plots of PCA analysis.

https://github.com/brendaferrari/porcupineplot

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

molecular-dynamics pca-analysis plot protein-dynamics
Last synced: 4 months ago · JSON representation ·

Repository

PORCUPINEplot is a script developed to automate the generation of porcupine plots of PCA analysis.

Basic Info
  • Host: GitHub
  • Owner: brendaferrari
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 179 KB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Topics
molecular-dynamics pca-analysis plot protein-dynamics
Created over 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License Citation

README.md

🔴❗UNDER DEVELOPMENT❗🔴

Porcupine plot generation automation (PORCUPINEplot)

PORCUPINEplot is a script developed to automate the generation of porcupine plots of PCA analysis.

To use this program, first you need to calculate the Principal Components (PCs) of the protein trajectory. Feel free to check and use the PCA program I also developed over here.

To create a Porcupine plot, you are going to need the protein structure (pdb file) and the PC trajectory file (dcd file). You may also use other extensions for structure (gro) and trajectory (xtc) but you are going to need to change ln 13 of porcupineGenerator.sh to:

if ls -l *.{gro,xtc};


Instalation

Download the code and unzip it on the desirable directory. To prepare the environment use the following command:

conda env create -f environment.yml

Be aware to uncomment the sections on the environment.yml file depending on which OS you are using.


How to use

Activate the environment using:

conda activate porcupineplot

The program uses a shell script to automate the calculation of data in multiple folders. To use this feature go to the root directory and on the terminal use:

bash \porcupineGenerator.sh

If you are interested only on running one folder, you may just add your files to the porcupineGenerator directory and use:

pymol script.pml

Before running the program, be aware to do some edits to the script.pml file:

```

---------------START-------------------------------------------------

Change this filename to the name of your archive

load pc0.pdb load_traj pc0.dcd run modevectors.py

Change the 10001 to the number of frames the traectory has

split_states pc0, 1, 10001

Change the name 'pc0_0001' to the name of your filename
Here you can also format the porcupine plot

modevectors pc00001, pc010001, cutoff=.0, headlength=2, head=0.4, headrgb=(1,.2,.1) ,tailrgb=(1,.2,.1) ,notail=0 set cartoontrace,1 set cartoontuberadius, 0.3 cmd.disable('all') cmd.enable('pc00001',1) cmd.enable('modevectors',1) set rayshadow,0

Change the name of the session file
After that, you may save as PNG

save PCAporcupinepc0.pse,format=pse

----------END------------------------------------------------

```


Observations

  • This script was developed following the SK D tutorial on youtube, the PML file was developed based on its PML file. The tutorial and files can be found here.

  • The file modvectors.py was developed by Sean M. Law and its description can be found here


Authorship

Social preview original photo by Brenda Ferrari (brendaferrari)

Owner

  • Name: Brenda Ferrari
  • Login: brendaferrari
  • Kind: user

Chemistry PhD student - Python and Machine Learning student

Citation (CITATION.cff)

cff-version: 0.0.1
message: "If you use this software, please cite it as below."
authors:
- family-names: "Ferrari"
  given-names: "Brenda"
  orcid: "https://orcid.org/0000-0001-5609-0947"
title: "PORCUPINEplot"
version: 0.0.1
doi: 10.5281/zenodo.7517284
date-released: 2023-01-09
url: "https://github.com/brendaferrari/PORCUPINEplot"

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Dependencies

environment.yml conda
  • pymol 2.5.3.*
  • python 3.8.*