Skip to content

A Python package to manage protein design workflows on computing clusters and local machines. Documentation can be found here: https://protflow.readthedocs.io/en/latest/

License

Notifications You must be signed in to change notification settings

mabr3112/ProtFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ProtFlow

A Python package for running protein design tools on SLURM clusters.

Installation

First, clone the repository

git clone https://github.com/mabr3112/ProtFlow.git

Create a conda environment for ProtFlow:

conda create -n protflow python=3.11

Then, install in development mode (Package currently under development and changes a lot.) Install in the protflow environment to limit interference with other systems.

cd ProtFlow
conda activate protflow
pip install -e .

The Configuration File

You will need to link protflow's runners to the individual python environments you have set up on your system. By Default, ProtFlow looks for environment paths in the file 'config.py'. Add the paths of your tool's python evironments and their scripts into this file how it is described in the module's docstring.

Overview

protflow_organigramm drawio (1)

Documentation

ProtFlow is documented with read-the-docs and sphinx. The documentation can be found here: https://protflow.readthedocs.io/en/latest/

About

A Python package to manage protein design workflows on computing clusters and local machines. Documentation can be found here: https://protflow.readthedocs.io/en/latest/

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages