From 2d837576a97cc80878931a6b9a8e7090c815d7e0 Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Sun, 22 Sep 2024 22:27:21 -0700 Subject: [PATCH 1/2] fix read_results doc --- docs/convert.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/convert.rst b/docs/convert.rst index 2333d976..53443f80 100644 --- a/docs/convert.rst +++ b/docs/convert.rst @@ -34,11 +34,11 @@ See :func:`otoole.convert.convert_results` for more details Reading solver results into a dict of Pandas DataFrames ------------------------------------------------------- -The ``read_results`` function reads a CBC_, CLP_, -Gurobi_ or CPLEX_ solution file into memory:: +The ``read_results`` function reads a CBC_, CLP_, Gurobi_ or CPLEX_ solution file into to a Python object. +This allows you to then use all the features offered by Python to manipulate the data. >>> from otoole import read_results ->>> read_results('my_model.yaml', 'cbc', 'csv', 'my_model.sol', 'my_model_csvs', 'datafile', 'my_model.dat') +>>> data, defaults = read_results('my_model.yaml', 'cbc', 'my_model.sol', 'datafile', 'my_model.dat') See :func:`otoole.convert.read_results` for more details From f711902ff5681e21df923d3784aa645cbea99a20 Mon Sep 17 00:00:00 2001 From: trevorb1 Date: Sun, 22 Sep 2024 22:30:10 -0700 Subject: [PATCH 2/2] fix typo --- docs/convert.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/convert.rst b/docs/convert.rst index 53443f80..673a8790 100644 --- a/docs/convert.rst +++ b/docs/convert.rst @@ -34,7 +34,7 @@ See :func:`otoole.convert.convert_results` for more details Reading solver results into a dict of Pandas DataFrames ------------------------------------------------------- -The ``read_results`` function reads a CBC_, CLP_, Gurobi_ or CPLEX_ solution file into to a Python object. +The ``read_results`` function reads a CBC_, CLP_, Gurobi_ or CPLEX_ solution file to a Python object. This allows you to then use all the features offered by Python to manipulate the data. >>> from otoole import read_results