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

Add instructions for pip installation to the docs #690

Merged
merged 6 commits into from
Jan 28, 2025

Conversation

WeirAE
Copy link
Contributor

@WeirAE WeirAE commented Jan 28, 2025

Synopsis

Land-DA and JEDI users have requested the ability to install UW into their environments . @maddenp-noaa kindly wrote this pip installation that I have converted to text for the user installation guide.

Type

  • Bug fix (corrects a known issue)
  • Code maintenance (refactoring, etc. without behavior change)
  • Documentation
  • Enhancement (adds new functionality)
  • Tooling (CI, code-quality, packaging, revision-control, etc.)

Impact

  • This is a breaking change (changes existing functionality)
  • This is a non-breaking change (existing functionality continues to work as expected)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.

docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
docs/sections/user_guide/installation.rst Outdated Show resolved Hide resolved
@maddenp-noaa
Copy link
Collaborator

That format-check failure in CI is not your fault. I made a change to condev recently to conform to Python-community preferred style for package specs, which uses == for pinning to a specific package version instead of =. You can either revert the change to recipe/meta.json in your PR/branch, or just leave this as-is and I'll force-merge the PR for you when it's approved.

@WeirAE
Copy link
Contributor Author

WeirAE commented Jan 28, 2025

Ah thanks, I was trying to track that one down - I'm inclined to leave it as-is if you can do the force

Copy link
Collaborator

@maddenp-noaa maddenp-noaa left a comment

Choose a reason for hiding this comment

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

I said in Conversation chain that I can merge this for you even with the formatting-check failure in CI, but you should probably revert the changes to recipe/meta.json so that those pass. I'll fix this for everybody today.

@maddenp-noaa
Copy link
Collaborator

Ugh, now you're hitting the issue with the gnu.org HTTP failure in the docs. Also not your fault, and nothing to can do to fix it. I'll go ahead and merge this PR and if there's anything left to fix, I'll do it in a branch I'm about to merge.

Thanks for adding this to the docs!

@maddenp-noaa maddenp-noaa merged commit e6e91f4 into ufs-community:main Jan 28, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants