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.

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

Documentation updates #684

Merged
merged 15 commits into from
Oct 8, 2024
Merged

Documentation updates #684

merged 15 commits into from
Oct 8, 2024

Conversation

k1nshuk
Copy link
Collaborator

@k1nshuk k1nshuk commented Sep 19, 2024

The following PR updates the documentation and makes the following changes

  1. Update existing PLEXOS and Gurobi documentation to remove mentions of Eagle.
  2. Add documentation for Xpress solver.
  3. Add preliminary documentation for IDAES solvers to reflect the addition of new modules on Kestrel

@k1nshuk k1nshuk self-assigned this Sep 19, 2024
docs/Documentation/Applications/gurobi.md Show resolved Hide resolved
docs/Documentation/Applications/xpressmp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/xpressmp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/xpressmp.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/IDAES_Solvers/index.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/IDAES_Solvers/index.md Outdated Show resolved Hide resolved
@@ -0,0 +1,21 @@
# IPOPT + HSL
Copy link
Collaborator

Choose a reason for hiding this comment

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

Olivia wrote some documentation for IPOPT and HSL in the Libraries section (https://nrel.github.io/HPC/Documentation/Development/Libraries/). Should that be combined with this or moved?

docs/Documentation/Applications/IDAES_Solvers/bonmin.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
docs/Documentation/Applications/IDAES_Solvers/ipopt.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/IDAES_Solvers/bonmin.md Outdated Show resolved Hide resolved

```bash
module load netlib-lapack
module load idaes_solvers/3.4.0-netlib-lapack
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably change this to cray-libsci? Might be good to have a recommendation here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I agree. I can run some tests and update with recommendations in a subsequent PR.

mkdocs.yml Show resolved Hide resolved
mkdocs.yml Outdated
Comment on lines 91 to 95
- Bonmin : Documentation/Applications/IDAES_Solvers/bonmin.md
- CBC : Documentation/Applications/IDAES_Solvers/cbc.md
- CLP : Documentation/Applications/IDAES_Solvers/clp.md
- Couenne : Documentation/Applications/IDAES_Solvers/couenne.md
- IPOPT : Documentation/Applications/IDAES_Solvers/ipopt.md
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should consolidate these all to the same page, but then we can link to the individual sections here.

That way users know about the individual solvers available, but we don't have stub pages.

k1nshuk and others added 9 commits September 26, 2024 09:56
Co-authored-by: Haley Yandt <46908710+yandthj@users.noreply.github.com>
Co-authored-by: Haley Yandt <46908710+yandthj@users.noreply.github.com>
Co-authored-by: Haley Yandt <46908710+yandthj@users.noreply.github.com>
Co-authored-by: Haley Yandt <46908710+yandthj@users.noreply.github.com>
Co-authored-by: Haley Yandt <46908710+yandthj@users.noreply.github.com>
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Development/Libraries/hsl.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/ipopt.md Outdated Show resolved Hide resolved
docs/Documentation/Applications/ipopt.md Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@yandthj yandthj merged commit 1442d55 into NREL:gh-pages Oct 8, 2024
@k1nshuk k1nshuk deleted the updates branch November 13, 2024 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants