Skip to content
voiage

voiage.cli.calculate_heterogeneity_value

calculate_heterogeneity_value

Section titled “calculate_heterogeneity_value”
calculate_heterogeneity_value([positional or keyword] specification_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to a heterogeneity-value decomposition v1 specification'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save the heterogeneity-value result')) -> None

Evaluate experimental exact finite static/dynamic heterogeneity value.

Parameters:

  • specification_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to a heterogeneity-value decomposition v1 specification'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save the heterogeneity-value result'))

Returns: None