htesp.ifermi_plot

Module to generate command for ifermi.

FIX(23): ifermi itself is an optional extra and is NOT imported here – this module only assembles the ifermi ... command line from ifermi.json. check_ifermi() looks the executable up at the point of use and says how to install it when it is missing, so importing this module never requires the package.

Functions

check_ifermi()	Raise a clear message when the optional ifermi tool is absent.
ifermi(command[, input_file])	Construct a command string for the ifermi command based on the provided command and parameters from a JSON file.
main([command, input_file, argv])	Print the assembled ifermi command line.

htesp.ifermi_plot.ifermi(command, input_file='ifermi.json')

Construct a command string for the ifermi command based on the provided command and parameters from a JSON file.

Parameters: - command (str): The command to execute (either ‘info’ or ‘plot’).

Returns: - str: The constructed command string.

If the ‘ifermi.json’ file exists, it reads the parameters from the file corresponding to the given command. If the parameter is a boolean value (True or False), it treats it as a boolean flag without a value in the command string. If the ‘ifermi.json’ file does not exist, it prints a message indicating the absence of the file.

htesp.ifermi_plot.check_ifermi()

Raise a clear message when the optional ifermi tool is absent.

FIX(23).

htesp.ifermi_plot.main(command=None, input_file='ifermi.json', argv=None)

Print the assembled ifermi command line.

FIX(21): a callable top-level entry point, so the module can be driven the same way as every other helper in this package.