pestifer.subcommands.mdplot module

The mdplot subcommand. This subcommand exposes the mdplot task standalone interface for generating plots of data extracted from NAMD log and xst files.

class pestifer.subcommands.mdplot.MDPlotSubcommand(name: str = 'mdplot', aliases: list = <factory>, log_file: str = 'mdplot.log', short_help: str = 'generate plots from MD simulation data', long_help: str = 'Generates plots from all combined MD simulations', func_returns_type: type = <class 'pestifer.core.artifacts.FileArtifactList'>, parser: argparse.ArgumentParser = None)

Bases: Subcommand

add_subparser(subparsers)

Adds the subcommand parser to the given subparsers. Subclasses declare arguments here, after a super().add_subparser() call.

static func(args: Namespace, **kwargs)

the function that executes the subcommand. Subclasses must implement this method.

func_returns_type

alias of FileArtifactList

log_file: str = 'mdplot.log'

default log file for this subcommand

long_help: str = 'Generates plots from all combined MD simulations'

description

name: str = 'mdplot'

subcommand name

short_help: str = 'generate plots from MD simulation data'

help string