Skip to content

Clarify install docs #4121

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

Merged
merged 14 commits into from
Apr 10, 2025
Merged

Clarify install docs #4121

merged 14 commits into from
Apr 10, 2025

Conversation

connorjward
Copy link
Contributor

@connorjward connorjward commented Mar 17, 2025

Description

  • Removes some references to firedrake-install
  • Makes pip cache remove petsc4py a main instruction so it isn't missed
  • Moves complex bits about customisation to the bottom of the install instructions
  • Included explicit information about installing SLEPc and other optional dependencies

Fixes #4097 and #4098

Note that the docs link check is expected to fail because it references a link that doesn't yet exist.

TODOs

Copy link

github-actions bot commented Mar 17, 2025

TestsPassed ✅Skipped ⏭️Failed ❌
Firedrake complex8234 ran6590 passed1644 skipped0 failed

Copy link

github-actions bot commented Mar 17, 2025

TestsPassed ✅Skipped ⏭️Failed ❌
Firedrake default8275 ran7573 passed702 skipped0 failed

@connorjward connorjward changed the title Connorjward/clarify install docs Clarify install docs Mar 17, 2025
@connorjward connorjward marked this pull request as ready for review March 19, 2025 14:49
Copy link
Member

@JHopeCollins JHopeCollins left a comment

Choose a reason for hiding this comment

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

All good improvements. I just have a few suggestions for the PETSc installation details

Copy link
Contributor

@rckirby rckirby left a comment

Choose a reason for hiding this comment

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

While clarifying install docs, perhaps we should add git+https to the suggested cloning commands for developer-mode install. Currently, it is http-only and one can't go over ssh/is prompted to supply GitHub credentials if one has followed the commands too slavishly.

Copy link
Contributor

@rckirby rckirby left a comment

Choose a reason for hiding this comment

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

We need to make sure downstream packages installed in developer mode get installed via git

@connorjward
Copy link
Contributor Author

We need to make sure downstream packages installed in developer mode get installed via git

@rckirby I'm not quite sure what you mean by this?

@connorjward connorjward mentioned this pull request Apr 3, 2025
10 tasks
@connorjward connorjward marked this pull request as draft April 3, 2025 08:16
@connorjward connorjward marked this pull request as ready for review April 9, 2025 06:53
rckirby
rckirby previously approved these changes Apr 9, 2025
Copy link
Contributor

@rckirby rckirby left a comment

Choose a reason for hiding this comment

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

But please delete the petsc/slepc version changes

@connorjward connorjward requested a review from JHopeCollins April 9, 2025 18:28
@connorjward
Copy link
Contributor Author

Forcing this through as it was previously approved and is holding up other PRs.

@connorjward connorjward merged commit 6789e9d into master Apr 10, 2025
8 of 9 checks passed
@connorjward connorjward deleted the connorjward/clarify-install-docs branch April 10, 2025 08:16
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.

DOCS: slepc installation is undocumented
3 participants