Skip to content

Conversation

shermanjasonaf
Copy link
Contributor

@shermanjasonaf shermanjasonaf commented Sep 23, 2025

Summary/Motivation:

This PR restructures the PyROS online documentation and adds a new tutorial to the documentation.

Changes proposed in this PR:

  • Reorganize the PyROS online documentation and split it into multiple webpages
  • Add a new, extensive tutorial to the PyROS online documentation
  • Replace the original quickstart example problem with a problem that is smaller, easier to write down, and less sensitive to the subsolver(s) used (see this comment of #3649)
  • Add the mathematical definition of each pre-implemented PyROS UncertaintySet class to the class's docstring

TODO (after #3732 merged)

  • Account for changes to the logging system in the restructured online docs
  • Remove original PyROS doc ReST file; rename new PyROS doc folder as "pyros" (to preserve original PyROS docs URL)
  • Update version number, changelog

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@shermanjasonaf
Copy link
Contributor Author

Comment on lines +346 to +347
And finally, a function to build the model and
and initialize the variable values:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
And finally, a function to build the model and
and initialize the variable values:
And finally, a function to build the model and
initialize the variable values:



For convenience, we also write a function to initialize the model's
variables values:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
variables values:
variable values:

the nominal uncertain parameter realization
* If ``objective_focus`` is set to
:attr:`~pyomo.contrib.pyros.util.ObjectiveType.worst_case`,
then the objective is evaluated subject
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
then the objective is evaluated subject
then the objective is evaluated subject to

the progress and final result are reported through a highly
configurable logging system.
See the :ref:`Solver Output Log documentation <pyros_solver_log>`
documentation for more information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
documentation for more information.
for more information.

@mrmundt
Copy link
Contributor

mrmundt commented Oct 7, 2025

@shermanjasonaf - Please resolve the merge conflicts.

@mrmundt mrmundt moved this from Todo to Review In Progress in Pyomo 6.9.5 Release Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review In Progress
Development

Successfully merging this pull request may close these issues.

2 participants