Skip to content

voiage.cli.calculate_portfolio_voi

calculate_portfolio_voi([positional or keyword] portfolio_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON portfolio specification'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save portfolio VOI result')) -> None

Optimize a research portfolio using the portfolio VOI methods.

Optimize a portfolio from a JSON specification:

.. code-block:: bash

voiage calculate-portfolio-voi portfolio.json

Parameters:

  • portfolio_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to JSON portfolio specification'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save portfolio VOI result'))

Returns: None