Repository navigation
V05release - #188
V05release#188
Conversation
Fixies: - the link to BFRESCOX - the version number - the link to software (so that it tracks the correct branch) - nuclear physics
Fixed some links and version.
Adding three READMEs to the list of places that now contain a version number!
Fixed version number and some links.
Moved jitr to software consistently
Initial add of LCGP as submodule
Bringing in latest develop
Approving pull request of merge of reorganization of Examples directory into develop.
It looks like v1.1.0 was still here
Update README.md
Jitr version update
Fixing URL typo that the CI action caught
Addressing some new stoplist words
Updated lower bound for release date for version 0.5.0.
Adding a new notebook for BAND Camp 2021
Update BAND Camp 21 nbs by cloning BAND v0.2
|
DanielRPhillips
left a comment
There was a problem hiding this comment.
Thanks for the fixes @asemposki and @ozgesurer. @asemposki, can you please check that the revised Bfrescox notebooks now run in Google colab?
I have:
- updated the README file in the directory where the notebooks sit to clarify the distinction between Bfrescox_GPR.ipynb and Bfrescox_GPR_v05.ipynb.
- added a known issue to CHANGELOG.rst that states our BRICK MacOS & Windows compatibility issues.
There was a problem hiding this comment.
@wildsm I have verified several, but not all, of the following items on your list:
-
Release notes for this version are complete and represent changes through the CHANGELOG.rst </CHANGELOG.rst>_ file.
-
Ensure that links and references have been updated (e.g., no occurrences of privateband). Consider checking that the url checking action is reviewing a sufficiently rich set of files where spelling should be checked.
I checked and found no occurences of privateband. I checked several links and, after our efforts of the past few days, found no failures. I also checked that all links in CONTRIBUTING.rst and CHANGELOG.rst.
- Version number is update-to-date wherever it appears and +dev suffix is removed
(currently: 4 in README.md </README.md>, 1 in AUTHORS , 1 in bandsdk.md </resources/sdkpolicies/bandsdk.md>, 1 in examples </examples/README.md>, 1 in software </software/README.md>, 1 in BANDsoftware_uses </BANDsoftware_uses/README.md>, and possibly in CHANGELOG.rst </CHANGELOG.rst>_).
Note for future reference that I found one more occurrence of version number in README.md
-
Check README.md </README.md>_ Citing bandframework for correctness (e.g., ensure that author list matches AUTHORS _, year and version are correct).
-
Check bandsdk.md </resources/sdkpolicies/bandsdk.md>_ Citing bandframework for correctness (authors, year, version). Ensure that SDK version listed is the same as in the provided template </resources/sdkpolicies/template.md>_.
-
Check sdkpolicies README </resources/sdkpolicies/README.md>_ for correctness (e.g., ensure that each software in the release has a working link for its SDK compliance, also note any differences in the version of the SDK that each package lists versus the version at bandsdk.md </resources/sdkpolicies/bandsdk.md>_).
All links work and all packages are working with v0.2 (the current version) of the SDK
- Please state whether you have verified successful execution of the notebooks linked in BRICK </examples/BRICK/tutorial>_ and Bfrescox use </BANDsoftware_uses/BFRESCOX>_ . Successful completion of this PR should include verification across the union of reviewers.
I have not executed BRICK notebooks, but have added issues with doing so as a "Known issue" in CHANGELOG.rst
-
Tests are run with source to be released (this may iterate):
Online CI (GitHub Actions) tests must pass.
Documentation must build and display correctly wherever hosted.
Adding/removing some commas to the README
Update BFRESCOX --> Bfrescox in the README
Update PUQ readme for bfrescox path
beykyle
left a comment
There was a problem hiding this comment.
I checked the links and didn't find any issues.
One question: The notebooks linked in https://github.com/bandframework/bandframework/blob/v05release/BANDsoftware_uses/Bfrescox/Tutorial_I/BANDCamp21.rst now open directly to the git blob for the ipynb files, rather than opening in google collab, is that intentional? @ozgesurer
This should maintain the link valid even after `develop` is eventually updated. The BRICK notebook link is already set to the release branch.
DanielRPhillips
left a comment
There was a problem hiding this comment.
I have completed my review. The only outstanding issue pertains to the notebooks.
|
Review performed at (clean) commit
Additionally
|
The tutorial notebooks can no longer hosted on the original Colab-compatible site. Make this clear in the notes and provide some hints for how to update the notebooks for local execution.
|
I updated the Bfrescox+surmise tutorial README to address potential notebook issues/questions raised by both Daniel and Kyle. |
We decided to keep the files themselves so that we do not lose access to the links in case of any reason. Please also see the commit |
jared321
left a comment
There was a problem hiding this comment.
Please see my review checklist in the PR notes.
|
Many thanks to all of the reviewers! We have come to consensus that @asemposki 's notes were addressed and are proceeding with next steps since she is likely logged off for the year. I will continue following the flow at #178 |
This address issue #178
It will follow the release process
https://github.com/bandframework/bandframework/blob/develop/resources/dev_guide/release-proc.rst