Skip to content
voiage

voiage.cli.calculate_distributional_equity

calculate_distributional_equity

Section titled “calculate_distributional_equity”
calculate_distributional_equity([positional or keyword] input_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON input with net_benefit, subgroups, and equity weights'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save Value of Distributional Equity result')) -> None

Calculate Value of Distributional Equity from a JSON input file.

Parameters:

  • input_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON input with net_benefit, subgroups, and equity weights'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save Value of Distributional Equity result'))

Returns: None