Skip to content

Review of progress-bars #221

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.

Sign up for GitHub

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 2 commits into from
Apr 19, 2024
Merged

Review of progress-bars #221

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8767a7
Review of progress-bars
Oct 27, 2023
0ea58e0
Update progress-bars.md
smoors Apr 19, 2024
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
6 changes: 4 additions & 2 deletions docs/progress-bars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The progress bars shown by EasyBuild are *dynamic*: they are only visible when t

Note that for most progress bars each step is treated as being equal even though the time taken for the
various steps varies. There are many factors that impact how long an individual installation step, installing
an easyconfig, or installing an extension may and this makes it very difficult to get a good estimate on how
an easyconfig, or installing an extension may take and this makes it very difficult to get a good estimate on how
much time will be needed.
The download progress bar is an exception here (as long as the size of the file to download could be determined first).

Expand Down Expand Up @@ -90,6 +90,8 @@ which shows:

## Relevant configuration options

For information about configuring EasyBuild, see [Configuring Easybuild](https://docs.easybuild.io/configuration/).

### `output-style`

The `output-style` configuration option determines the output style of the `eb` command.
Expand All @@ -100,7 +102,7 @@ This also makes `Rich` a *required* dependency for EasyBuild.
Using '`basic`' as value for `output-style` results in basic output (no progress bars).

By default `output-style` is set to '`auto`', which implies using the `Rich` Python package to produce
rich output (incl. progress bars) if is available,
rich output (incl. progress bars) if `Rich` is available,
and falling back to using the basic output style if `Rich` is not available.

### `show-progress-bar`
Expand Down