From 059c217a72b42f3e70cb03b0075c827f5a5a6c09 Mon Sep 17 00:00:00 2001 From: John Siirola Date: Mon, 7 Jun 2021 15:31:52 -0600 Subject: [PATCH] Integrating PyROS documentation into RTD build Slightly reorganizing the contributed packages so that the TOC is a little more intuitive. Clarifying some contrib package doc page titles. --- doc/OnlineDocs/contributed_packages/index.rst | 15 +++++++++++---- doc/OnlineDocs/contributed_packages/mcpp.rst | 4 ++-- .../contributed_packages/parmest/index.rst | 6 +++--- .../contributed_packages/preprocessing.rst | 4 ++-- doc/OnlineDocs/contributed_packages/satsolver.rst | 4 ++-- 5 files changed, 20 insertions(+), 13 deletions(-) diff --git a/doc/OnlineDocs/contributed_packages/index.rst b/doc/OnlineDocs/contributed_packages/index.rst index 52e0e0c85c5..7dab0092ff9 100644 --- a/doc/OnlineDocs/contributed_packages/index.rst +++ b/doc/OnlineDocs/contributed_packages/index.rst @@ -17,17 +17,24 @@ Contributed packages distributed with Pyomo: community.rst gdpopt.rst - mcpp.rst mindtpy.rst multistart.rst - parmest/index.rst preprocessing.rst + parmest/index.rst pynumero/index.rst - satsolver.rst + pyros.rst sensitivity_toolbox.rst + +Contributed Pyomo interfaces to other packages: + +.. toctree:: + :maxdepth: 1 + mcpp.rst + satsolver.rst + Contributed packages distributed independently of Pyomo, but accessible through ``pyomo.contrib``: -* `pyomo.contrib.simplemodel `_ +* `pyomo.contrib.simplemodel `_ diff --git a/doc/OnlineDocs/contributed_packages/mcpp.rst b/doc/OnlineDocs/contributed_packages/mcpp.rst index 071df0840a6..48180707a58 100644 --- a/doc/OnlineDocs/contributed_packages/mcpp.rst +++ b/doc/OnlineDocs/contributed_packages/mcpp.rst @@ -1,5 +1,5 @@ -Pyomo Interface to MC++ -======================= +MC++ Interface +============== The Pyomo-MC++ interface allows for bounding of factorable functions using the MC++ library developed by the OMEGA research group at Imperial College London. diff --git a/doc/OnlineDocs/contributed_packages/parmest/index.rst b/doc/OnlineDocs/contributed_packages/parmest/index.rst index 1c603a65688..4c607846cc0 100644 --- a/doc/OnlineDocs/contributed_packages/parmest/index.rst +++ b/doc/OnlineDocs/contributed_packages/parmest/index.rst @@ -1,7 +1,7 @@ -parmest -======= +Parameter Estimation with `parmest` +=================================== -parmest is a Python package built on the Pyomo optimization modeling +`parmest` is a Python package built on the Pyomo optimization modeling language ([PyomoJournal]_, [PyomoBookII]_) to support parameter estimation using experimental data along with confidence regions and subsequent creation of scenarios for PySP. diff --git a/doc/OnlineDocs/contributed_packages/preprocessing.rst b/doc/OnlineDocs/contributed_packages/preprocessing.rst index d8319a978f4..e6802886468 100644 --- a/doc/OnlineDocs/contributed_packages/preprocessing.rst +++ b/doc/OnlineDocs/contributed_packages/preprocessing.rst @@ -1,5 +1,5 @@ -Pyomo Nonlinear Preprocessing -============================= +Nonlinear Preprocessing Transformations +======================================= ``pyomo.contrib.preprocessing`` is a contributed library of preprocessing transformations intended to operate upon nonlinear and mixed-integer nonlinear diff --git a/doc/OnlineDocs/contributed_packages/satsolver.rst b/doc/OnlineDocs/contributed_packages/satsolver.rst index 932b1ade36b..4cac9170b55 100644 --- a/doc/OnlineDocs/contributed_packages/satsolver.rst +++ b/doc/OnlineDocs/contributed_packages/satsolver.rst @@ -1,5 +1,5 @@ -Pyomo Interface to z3 SMT Sat Solver -==================================== +z3 SMT Sat Solver Interface +=========================== The z3 Satisfiability Solver interface can convert pyomo variables and expressions for use with the z3 Satisfiability Solver