Update Getting Started Documentation #1507
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adam-a-a
approved these changes
Oct 9, 2024
There was a problem hiding this comment.
Thanks for opening this @MarcusHolly. Two changes I'd suggest:
- Use Python 3.11 instead of 3.9: mostly because it's the newest version that's tested to fully work with Pyomo/IDAES/WaterTAP. We'll still be testing 3.9 in CI for compatibility but I don't think there's a strong reason not to have a newer version as the default
- Remove the version constraint on
pipinstalled through Conda: I vaguely remember this being necessary in the past because of some issue/bug, but I don't think it's needed anymore
Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
lbianchi-lbl
approved these changes
Oct 10, 2024
lbianchi-lbl
pushed a commit
that referenced
this pull request
Oct 10, 2024
* Replaces instances of python 3.8 with 3.9 * Update docs/getting_started.rst Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> * Update docs/getting_started.rst Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> * Update docs/getting_started.rst Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> --------- Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> (cherry picked from commit c012a8a)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary/Motivation:
The Getting Started documentation still recommends python 3.8, which is no longer compatible with IDAES 2.6
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: