Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update PyROS Solver and Webpage Documentation #2707

Merged
merged 56 commits into from
Feb 16, 2023
Merged

Update PyROS Solver and Webpage Documentation #2707

merged 56 commits into from
Feb 16, 2023

Conversation

shermanjasonaf
Copy link
Contributor

@shermanjasonaf shermanjasonaf commented Jan 26, 2023 •
edited
Loading

Summary/Motivation:

Updates to PyROS online documentation, and docstrings for the PyROS solver and UncertaintySet subclasses.

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
Update PyROS ReadTheDocs page
17dc4ce
@shermanjasonaf
Update PyROS.solve() docstring
ed01f49
@shermanjasonaf
Tweak master objective note, uncertainty sets intro
8a35995
@shermanjasonaf
Attempt to fix uncertainty set class refs
88dfc37
@shermanjasonaf
Update uncertainty set subclass refs in table
8efe3ce
@shermanjasonaf
Update UncertaintySet and BoxSet class docstrings
7dcdc91
@shermanjasonaf
Add attribute ref to box set bounds
a3c1057
@shermanjasonaf
Update CardinalitySet class docstring
3f65d13
@shermanjasonaf
Update BudgetSet docstrings
a28f160
@shermanjasonaf
Update FactorModelSet docstrings
188136e
@shermanjasonaf
Update BudgetSet.budget_membership_mat docstring
80173a0
@shermanjasonaf
Update PolyhedralSet docstrings
099f813
@shermanjasonaf
Update AxisAlignedEllipsoidalSet docstrings
39cb909
@shermanjasonaf
Update EllipsoidalSet docstrings
e02af7d
@shermanjasonaf
Update DiscreteScenarioSet docstrings
6b4fe83
@shermanjasonaf
Update IntersectionSet docstrings
6841076
@shermanjasonaf
Update DiscreteScenarioSet.scenarios docstring
9805788
@shermanjasonaf
Update PolyhedralSet class docstring
4b3239e
@shermanjasonaf
Add show-inheritance stmts for uncertainty set types
9b6f059
@shermanjasonaf
Update intro for PyROS usage example section
a0fd5c4
@shermanjasonaf
Update PyROS usage example section
c5c2e2d
@shermanjasonaf
Fix print and append statements
e196838
@shermanjasonaf
Restore original notation for nominal realization
1afa0ed
@shermanjasonaf
Tweak a few content block references
dded925
@shermanjasonaf
Tweak formatting of NLP formulations
dc72a82
@shermanjasonaf
Fix spacing for RO counterpart formulation
4a9083d
@shermanjasonaf
Add refs to note on model constraints
27f84bc
@shermanjasonaf
Merge branch 'main' into update-read-the-docs
6529040
@shermanjasonaf
Update pyrosTerminationCondition class and attribute docs
d0598b1
@shermanjasonaf
Update notation for nominal realization
4dd7f06
jsiirola
jsiirola reviewed Feb 14, 2023
View reviewed changes
Copy link
Member

@jsiirola jsiirola left a comment

Choose a reason for hiding this comment

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

This looks good. Just a few typos / grammatical edits.

doc/OnlineDocs/contributed_packages/pyros.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/pyros.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/pyros.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/pyros.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/pyros.rst Outdated Show resolved Hide resolved
@shermanjasonaf shermanjasonaf changed the title [WIP] Update PyROS Solver and Webpage Documentation Update PyROS Solver and Webpage Documentation Feb 16, 2023
@shermanjasonaf
Copy link
Contributor Author

Ready for review.

@mrmundt mrmundt merged commit c0e5494 into Pyomo:main Feb 16, 2023
@shermanjasonaf shermanjasonaf deleted the update-read-the-docs branch June 19, 2023 00:02
@shermanjasonaf shermanjasonaf mentioned this pull request Feb 7, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsiirola jsiirola jsiirola approved these changes

@mrmundt mrmundt mrmundt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@shermanjasonaf @jsiirola @mrmundt @pyomo-autotest