Bfrescox

[beykyle]

Initial addition of bfrescox v0.0.1-alpha as BAND software for v0.5

[wildsm]

Is the proposal to replace the bfrescox currently at
https://github.com/bandframework/bandframework/tree/develop/BANDsoftware_uses
?

[beykyle]

Is the proposal to replace the bfrescox currently at https://github.com/bandframework/bandframework/tree/develop/BANDsoftware_uses ?

I can’t speak authoritatively on what should be done with the old bfrescox, but I imagine it should remain as a use case.

[wildsm]

I will need to talk that through with a few people, anyone please feel free to chime in here.

In the meantime, @beykyle , for adding a software piece, please also:

• Add to https://github.com/beykyle/bandframework/blob/bfrescox/CHANGELOG.rst
• Add to https://github.com/beykyle/bandframework/blob/bfrescox/software/README.md
• Link SDK file at https://github.com/beykyle/bandframework/blob/bfrescox/resources/sdkpolicies/README.md
• Above will probably cause action to fail, so probably need to append sdk file name at the end of https://github.com/beykyle/bandframework/blob/bfrescox/.github/workflows/bandframework-ci.yml

Whether BANDsoftware_uses stays or not, I think that the changelog (and possibly the bfrescox readme) probably need a sentence on how this differs from the bfrescox that was in band prior to v0.5.0. This will minimize confusion in any case.

[wildsm]

@jared321 spotted something awkward:
The release appears to be v0.0.1 (2 zeros) by the tag is https://github.com/bandframework/Bfrescox/releases/tag/v0.0.01-alpha (3 zeros).
Can this be reconciled?

[jared321]

• Python is usually capitalized and is elsewhere in this file
• Bfrescox should be capitalized as well

Not sure if you need to capitalize "bfrescox" in terms of the submodule.

Also it might be a little confusing to have two "Bfrescox" entries in the README. Should the use example be renamed or its description updated to clarify?

[DanielRPhillips]

I would like to see this BFRESCOX go into "software". It will be a bit different to the other software there, since it's not a general Bayesian tool, but it is an enabling tool for Bayesian analyses of nuclear dynamics.

As @beykyle said, the BFRESCOX at https://github.com/bandframework/bandframework/tree/develop/BANDsoftware_uses is in fact just a tutorial that shows how to employ surmise for UQ in reactions, but it assumes that the user has installed frescox locally via download and command line instructions.

This commit lowers the barrier to doing the use case because frescox no longer needs to be installed in that rather cumbersome way. But it doesn't replace the use case.

What do others think about having directories called BFRESCOX in software and in BANDsoftware_uses with the understanding that the one in BANDsoftware_uses is exactly an example of how BFRESCOX could be used for Bayesian analysis?

[wildsm]

See thread about other changes needed for new software additions

[jared321]

I don't see anything too wrong about having a software/bfrescox and a BANDsoftware_uses/BFRESCOX for the moment. The main README is potentially confusing.

For the use example in the main README.md and in the BANDsoftware_uses/BFRESCOX/README.md, could we rename the link to something like Bfrescox+surmise? Could its description be changed to something like

An example of using the Frescox scattering code with surmise to enable Bayesian parameter estimation for coupled-channels systems.

[DanielRPhillips]

@jared321: I like that plan. I will go ahead and edit the main README.md to make it so.

[wildsm]

I have reviewed the changes to the main band repo and confirm that actions are now passing.

git clone --recursive https://github.com/beykyle/bandframework.git
and switched to the correct branch

I followed the installation instructions at https://bfrescox.readthedocs.io/en/latest/get_started.html
and installed via python -m pip install .

From python, bfrescox.version
produced '0.0.0'
@beykyle - is this correct?

Provided tests were not particularly verbose, but succeeded:

bfrescox.test()
......
----------------------------------------------------------------------
Ran 6 tests in 0.610s

OK
True

I also reviewed the sdk at https://github.com/bandframework/Bfrescox/blob/e0d2b74e042d000b31d3dc8a88d121fd8eb88181/Bfrescoxbandsdk.md and confirm that things look in order.

[DanielRPhillips]

Reviewed second round of changes and they look good.