gaudi.cli¶

This package holds all the CLI scripts and wrappers provided by GAUDI.

gaudi.cli.gaudi_cli¶

gaudi.cli.gaudi_cli is the CLI entry point for all GaudiMM scripts.

Available commands:

run

view

prepare

gaudi.cli.gaudi_cli.echo_banner()¶

gaudi.cli.gaudi_cli.load_chimera(nogui=True)¶

gaudi.cli.gaudi_cli.test_import(command, module)¶

gaudi.cli.gaudi_cli.timeit(func, *args, **kwargs)¶

gaudi.cli.gaudi_run¶

gaudi.cli.gaudi_run is the main hub for launching GAUDI jobs.

It sets up the configuration environment needed by DEAP (responsible for the GA) and ties it up to the GAUDI custom classes that shape up the invididuals and objectives. All in a loosely-coupled approach based on Python modules called on-demand.

Usage. Simply, type:

gaudi run /path/to/job.gaudi-input

gaudi.cli.gaudi_run.enable_logging(path=None, name=None, debug=False)¶: Register loggers and handlers for both stdout and file

gaudi.cli.gaudi_run.launch(cfg)¶

Runs a GAUDI job

Parameters:	cfg (gaudi.parse.Settings) – Parsed YAML dict with attribute-like access

gaudi.cli.gaudi_run.main(cfg, debug=False)¶

Starts a GAUDI job

Parameters:	cfg (str or gaudi.parse.Settings) – Path to YAML input file or an already parsed YAML file via gaudi.parse.Settings class debug (bool, optional, default=False) – Whether to enable verbose logging or not.

gaudi.cli.gaudi_run.unbuffer_stdout()¶