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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions batch/hpc_init.sh → batch/hpc_init
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#!/usr/bin/env bash

# Generic setup
set -e

Expand Down Expand Up @@ -140,3 +142,6 @@ Otherwise make sure this diagnostic info looks correct before continuing:
EOM

set +e

# Launch subshell with modified environment
eval "$SHELL -l"
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,5 @@ R -e "library(inference); inference::install_cli()"

# Done
echo "> Done installing/updating flepiMoP."
echo "> To activate the environment, run '$FLEPI_PATH/batch/hpc_init $1'."
set +e
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ Resolving deltas: 100% (59/59), done.
Updating files: 100% (411/411), done.
```

Run the `hpc_install_or_update.sh` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`. This script will prompt the user asking for the location to place the `flepiMoP` clone and the name of the conda environment that it will create. If this is your first time using this script accepting the defaults is the quickest way to get started. Also, expect this script to take a while the first time that you run it.
Run the `hpc_install_or_update` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`. This script will prompt the user asking for the location to place the `flepiMoP` clone and the name of the conda environment that it will create. If this is your first time using this script accepting the defaults is the quickest way to get started. Also, expect this script to take a while the first time that you run it.

```
$ ./flepiMoP/build/hpc_install_or_update.sh <cluster-name>
$ ./flepiMoP/build/hpc_install_or_update <cluster-name>
```

Remove the temporary clone of the `flepiMoP` repository created before. This step is not required, but does help alleviate confusion later.
Expand All @@ -46,23 +46,23 @@ $ rm -rf flepiMoP/

## Updating `flepiMoP`

Updating `flepiMoP` is designed to work just the same as installing `flepiMoP`. Make sure that your clone of the `flepiMoP` repository is set to the branch your working with (if doing development or operations work) and then run the `hpc_install_or_update.sh` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`.
Updating `flepiMoP` is designed to work just the same as installing `flepiMoP`. Make sure that your clone of the `flepiMoP` repository is set to the branch your working with (if doing development or operations work) and then run the `hpc_install_or_update` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`.

```
$ ./flepiMoP/build/hpc_install_or_update.sh <cluster-name>
$ ./flepiMoP/build/hpc_install_or_update <cluster-name>
```

## Initialize The Created `flepiMoP` Environment

These steps to initialize the environment need to run on a per run or as needed basis.

Change directory to where a full clone of the `flepiMoP` repository was placed (it will state the location in the output of the script above). And then run the `hpc_init.sh` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`. This script will assume the same defaults as the script before for where the `flepiMoP` clone is and the name of the conda environment. This script will also ask about a project directory and config, if this is your first time initializing `flepiMoP` it might be helpful to clone [the `flepimop_sample` GitHub repository](https://github.com/HopkinsIDD/flepimop\_sample) to the same directory to use as a test.
Change directory to where a full clone of the `flepiMoP` repository was placed (it will state the location in the output of the script above). And then run the `hpc_init` script, substituting `<cluster-name>` with either `rockfish` or `longleaf`. This script will assume the same defaults as the script before for where the `flepiMoP` clone is and the name of the conda environment. This script will also ask about a project directory and config, if this is your first time initializing `flepiMoP` it might be helpful to clone [the `flepimop_sample` GitHub repository](https://github.com/HopkinsIDD/flepimop\_sample) to the same directory to use as a test. This script will finish by outputting a summary of the environment changes and launching a subshell with this modified environment.

```
$ source batch/hpc_init.sh <cluster-name>
$ ./batch/hpc_init <cluster-name>
```

Upon completing this script it will output a sample set of commands to run to quickly test if the installation/initialization has gone okay.&#x20;
Upon completing this script it will output a sample set of commands to run to quickly test if the installation/initialization has gone okay.

## Submitting A Batch Inference Job To Slurm

Expand Down
Loading