Skip to content

Conversation

@jthorton
Copy link
Collaborator

@jthorton jthorton commented Jan 24, 2025

Fixes #1063 by adding more docs on setting up the parallel execution file structure, and how to gather the results.

Checklist

  • Added a news entry

Developers certificate of origin

@codecov
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.90%. Comparing base (e45b34e) to head (7081d12).
Report is 167 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1092      +/-   ##
==========================================
- Coverage   94.62%   92.90%   -1.73%     
==========================================
  Files         136      136              
  Lines       10087    10087              
==========================================
- Hits         9545     9371     -174     
- Misses        542      716     +174     
Flag Coverage Δ
fast-tests 92.90% <ø> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@atravitz atravitz left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up! Looks great, just a couple of edits.

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Only had a brief look but aside from the one typo and @atravitz's suggestions, this looks good to me thanks!


Serial execution of multiple repeats of a transformation can be inefficient when working with a HPC, in this case higher
throughput can be achieved by running one repeat per HPC job allowing for parallel execution. Most protocols are setup to
run ``three repeats in seral`` by default, however, this can be changed either via the protocol setting ``protocol_repeats``, see the
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
run ``three repeats in seral`` by default, however, this can be changed either via the protocol setting ``protocol_repeats``, see the
run ``three repeats in serial`` by default, however, this can be changed either via the protocol setting ``protocol_repeats``, see the

jthorton and others added 5 commits January 29, 2025 11:10
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
Co-authored-by: Alyssa Travitz <31974495+atravitz@users.noreply.github.com>
@github-actions
Copy link

No API break detected ✅

@jthorton jthorton merged commit ccc28db into main Jan 29, 2025
12 checks passed
@jthorton jthorton deleted the parallel_runs_docs branch January 29, 2025 16:41
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.

add documentation for gather's supported directory structure

4 participants