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

Ops UX Improvements To Install And Init #419

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

TimothyWillard
Copy link
Contributor

Describe your changes.

This pull request:

  1. Adds to the output of the install/update command the init command so users do not have to refer to the Initialize The Created flepiMoP Environment documentation, and
  2. Changes the init script from a script sourced into the current shell to an executable that launches a subshell.

Does this pull request make any user interface changes? If so please describe.

The user interface changes are how the hpc_install_or_update & hpc_init scripts are invoked. Previously it was (assuming in flepiMoP repository):

./build/hpc_install_or_update.sh <cluster-name>
source batch/hpc_init.sh <cluster-name>

Now this is done with:

./build/hpc_install_or_update <cluster-name>
./batch/hpc_init <cluster-name>

Those are reflected in updates to the documentation in the Running On A HPC With Slurm
documentation. Edits can be seen here: https://github.com/HopkinsIDD/flepiMoP/blob/ad936917742da2db7fe633b17e5bf125e113c35d/documentation/gitbook/how-to-run/advanced-run-guides/running-on-a-hpc-with-slurm.md.

What does your pull request address? Tag relevant issues.

This pull request addresses GH-417 and #375 (comment).

Tag relevant team members.

@pearsonca, @saraloo

Removed the `.sh` extension from `hpc_init.sh` and
`hpc_install_or_update.sh` to clarify that these are executables that
should be ran directly by the user.
@TimothyWillard TimothyWillard added documentation Relating to ReadMEs / gitbook / vignettes / etc. batch Relating to batch processing. low priority Low priority. quick issue Short or easy fix. labels Dec 9, 2024
@TimothyWillard
Copy link
Contributor Author

TimothyWillard commented Dec 9, 2024

@pearsonca and @saraloo This PR is meant to address the discussion on GH-375 from this morning. I've made it a draft since I'm not sure we want to include this release cycle since this is a breaking change with Wednesday being the target deadline for merging. However if this improves ops UX and others do not object to this change we can push it forward.

@TimothyWillard TimothyWillard added the next release Marks a PR as a target to include in the next release. label Dec 16, 2024
Copy link
Collaborator

@emprzy emprzy left a comment

Choose a reason for hiding this comment

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

I'm not sure how useful this would actually be because longleaf and rockfish are so specific to their respective institutions, but does it potentially add any value to include relevant notes on how to configure those things/links to UNC/JHU based instructions for those?

@TimothyWillard
Copy link
Contributor Author

does it potentially add any value to include relevant notes on how to configure those things/links to UNC/JHU based instructions for those?

I don't quite follow, add links to what? There is a documentation page already that covers how to use these scripts: https://iddynamics.gitbook.io/flepimop/how-to-run/advanced-run-guides/running-on-a-hpc-with-slurm, so I don't think adding links to the output of the scripts would be helpful. Do you mean adding links to that documentation to get setup on those HPCs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
batch Relating to batch processing. documentation Relating to ReadMEs / gitbook / vignettes / etc. low priority Low priority. next release Marks a PR as a target to include in the next release. quick issue Short or easy fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature request]: Add Detailed Instructions To The Output Of build/hpc_install_or_update.sh
2 participants