Skip to content

Remove old banksim/faithsim workflows add documentation/tests for new ones - #5392

Open
spxiwh wants to merge 10 commits into
gwastro:masterfrom
spxiwh:pr_update_xxsims
Open

Remove old banksim/faithsim workflows add documentation/tests for new ones#5392
spxiwh wants to merge 10 commits into
gwastro:masterfrom
spxiwh:pr_update_xxsims

Conversation

@spxiwh

@spxiwh spxiwh commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

It's time for pycbc_make_banksim and pycbc_make_faithsim to be retired. They've been greatly useful over the years (evolving from earlier codes pre-PyCBC) but they're now redundant with modern PyCBC-pegasus workflow based generators.

This patch:

  • Removes the old workflow generators (which are now practically unusable as they need deprecated glue)
  • Does some quality-of-life improvements to the new workflow generators (HDF files!!)
  • Updates documentation to show the new versions
  • Adds a new unittest to run both faithsim and banksim workflows

Standard information about the request

This is a: Removal of old code

This change affects: the banksim/faithsim suite

This change changes: scientific output

This change: has appropriate unit tests, follows style guidelines (See e.g. PEP8), has been proposed using the contribution guidelines

This change will: break current functionality

Motivation

It's time to get rid of our old workflows (which basically don't work now) and make the new ones front-and-centre on our documentation. We also need to ensure that users can easily use the new codes, so these documentation pages needed updating.

Contents

  • REmove old workflows
  • Quality of life improvements for current codes
  • Update documentation to new codes (now 3 pages, one for faithsim, one for banksim executable and one for the banksim workflow. Considered merging the last 2, but proposing as separate pages for now ... Documentation drawn from example to avoid duplication
  • Update examples to have a clean banksim and a clean faithsim example. Both can run the workflow or just run the primary executable on pregenerated inputs.
  • Add new CI workflow to run the new example workflows (should be much quicker than other CI workflows!)

Links to any issues or associated PRs

Fixes #4931

Testing performed

Have tested all the examples on CIT and locally using Claude to convert a dax to things we can run on my mac which doesn't have condor.

Additional notes

Thanks Claude!

  • The author of this pull request confirms they will adhere to the code of conduct

@spxiwh
spxiwh force-pushed the pr_update_xxsims branch from c283b56 to 5b300f8 Compare July 31, 2026 16:49
@spxiwh

spxiwh commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

The CI test is taking too long. I'll need to reduce the work being done there.

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.

Things to improve in the bank verifier

1 participant