pestifer.subcommands.setup_vmd module

The setup-vmd subcommand. Generates ~/.pestifer/vmd_init.tcl with a hardcoded PESTIFER_TCLROOT and appends a one-line source hook to ~/.vmdrc.

class pestifer.subcommands.setup_vmd.SetupVMDSubcommand(name: str = 'setup-vmd', aliases: list = <factory>, log_file: str = 'pestifer_diagnostics.log', short_help: str = "install pestifer's Tcl library into your VMD startup environment", long_help: str = "Generates ~/.pestifer/vmd_init.tcl with the absolute path to pestifer's Tcl root and appends a one-line source hook to ~/.vmdrc.  Re-run after upgrading pestifer or switching conda environments.", func_returns_type: type = <class 'bool'>, 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.

long_help: str = "Generates ~/.pestifer/vmd_init.tcl with the absolute path to pestifer's Tcl root and appends a one-line source hook to ~/.vmdrc.  Re-run after upgrading pestifer or switching conda environments."

description

name: str = 'setup-vmd'

subcommand name

short_help: str = "install pestifer's Tcl library into your VMD startup environment"

help string