maxwelllink.cli.mxl_hpc module

Manage persistent MaxwellLink HPC profile settings.

This module provides the implementation behind mxl hpc and mxl hpc set.

maxwelllink.cli.mxl_hpc.ensure_default_hpc_profile()

Ensure the default global HPC profile exists.

Returns:

(profile_path, created) where created is True only when a new profile was copied from the MaxwellLink payload.

Return type:

tuple[pathlib.Path, bool]

maxwelllink.cli.mxl_hpc.mxl_hpc_main(argv=None)

Run the mxl hpc CLI command family.

Parameters:

argv (list of str or None, default=None) – Optional command-line arguments. When None, uses sys.argv.

Returns:

0 on success, otherwise non-zero on failure.

Return type:

int

maxwelllink.cli.mxl_hpc.set_hpc_profile(source_file, destination_file=None)

Install a persistent global HPC profile.

Parameters:

• source_file (pathlib.Path) – User-provided JSON profile.

• destination_file (pathlib.Path or None, default=None) – Install destination. When None, uses ~/.maxwelllink/HPC_PROFILE.json.

Returns:

Installed destination path.

Return type:

pathlib.Path