galore.cli.galore module

galore.cli.galore.get_parser()[source]

Parse command-line arguments. Function is used to build the CLI docs.

galore.cli.galore.main()[source]
galore.cli.galore.pdos_from_files(return_plt=False, **kwargs)[source]

Read input data, process for PDOS before plotting and/or writing

Parameters
  • return_plt (bool) – If True, return the pyplot object instead of writing or displaying plot output.

  • **kwargs – See command reference for full argument list

galore.cli.galore.run(**kwargs)[source]
galore.cli.galore.simple_dos_from_files(return_plt=False, **kwargs)[source]

Generate a spectrum or DOS over one data series

kwargs[‘input’] can be a string or a list containing one string. In addition to main kwargs documented for CLI

Parameters
  • return_plt (bool) – If True, return the pyplot object instead of writing or displaying plot output.

  • **kwargs – See command reference for full argument list