Initial Tasks Layout

[AnirudhG07]

The issue contains the overall layout(with future edits) about the CLI for IMPROVISeD.

General Task overview

• [x] name (name BEPT)
• [ ] protein analysis
• [ ] protein building(if possible)
• [ ] cross platform testing
• [ ] docs
• [ ] publish

Protein analysis

• [ ] pdb cleanup code (TBD for all cases)

interactive gen

• [ ] pdb2pqr
• [ ] apbs

automation

• [x] pdb2pqr
• [x] apbs
• [x] potential gen
• [ ] gradient gen

Outputs

• [x] main csv file
• [x] .bept main file

  different file gens

• [ ] cube
• [ ] pot
• [x] xyz

Documentation

• [ ] explanation of how we utilise apbs, pdb2pqr
• [ ] bio explanation
• [ ] guide to use the tool
• [ ] cool docs on terminal(optional)

Protein Building

TBD

Publish

• [ ] Pypi
• [ ] homebrew
• [ ] Docker
• [ ] Source build docs

Further Exploration and Inclusions

• [ ] generation of surface maps

[AnirudhG07]

A brief idea about each of the tasks.

General Overview

These tasks will be ticked when all the sub section tasks mentioned below will be done and tested. Name will be given soon since all code will be around it. Cross-Platform Testing will be done on MacOS, Linux & WSL and probably Windows. Publishing will be done on - Pypi, Homebrew(on my Tap), hopefully Docker image.

Protein Analysis

For interactive, just like the webserver we will let the user make the command and optionally execute, same for apbs. The docs will contain everything about the input file so user can read and easily edit on his own.

the automation part is main part, running the commands with subprocess and generation of potentials, fields and gradients.

The output files will be done by pandas, a main csv and metadata file containing ALL data will be made and different files mentioned above will be made based on how they exist.

Documentation

The documentation will be written in markdown formats, explaining what is the motive, bio, engineering behind our tool. Why this was made and not use pre existing ones. Explanation of various factors like fields, force fields, dilectrics, other metrices, etc. will be explained. Docs on apbs, pdb2pqr usages and examples will be added. Detailed docs on usage and examples of this tool will also be added. Docs on protein building will also be added(if this will be done). And more docs wherever required.

Publishing

Pypi publishing with be done through pyproject.toml and requirements will be updated. Homebrew addition is a piece of cake once Pypi is done. Docker image will look good if made. so anyone can have docker daemon running and run command like one would expect.