Conversation
* Update and move from Getting_started.ipynb to setup.rst.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #254 +/- ##
==========================================
+ Coverage 87.70% 87.99% +0.28%
==========================================
Files 5 5
Lines 1082 1083 +1
Branches 231 231
==========================================
+ Hits 949 953 +4
+ Misses 93 91 -2
+ Partials 40 39 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Thanks for the updated documentation @GraemeWatt -- would you mind adding to the development docs that the JIRA issue should be created (after the PyPI upload)? I've created a JIRA issue just now for the release from a few days ago: https://its.cern.ch/jira/browse/SPI-2507 |
Now added: https://hepdata-lib--254.org.readthedocs.build/en/254/dev.html#making-a-release |
The "SWAN-specific instructions" at the top of Getting_started.ipynb are misleading as they imply that
hepdata_libneeds to be installed. Moreover, the given commandpip install --user hepdata_libdoes not work to upgradehepdata_libwithout setting a$PYTHONPATHvariable in a startup script. See an email I sent in response to a user query on 22nd January 2024. I updated the "SWAN-specific instructions" and moved them from theGetting_started.ipynbnotebook to a new "Using SWAN" section indocs/setup.rst. I also printed thehepdata_libversion at the top of theGetting_started.ipynbnotebook so that users can more easily see which version is installed.If we make sure that the LCG Releases are updated regularly with new
hepdata_libreleases, it should not be necessary for users to upgradehepdata_libon their own CERNBox, given that the procedure is not completely straightforward. @clelange : when you make a newhepdata_librelease, could you please also open a JIRA ticket (https://its.cern.ch/jira/projects/SPI/) to request that the new version be included in the next LCG release? I can do this if you prefer, but it would make sense to do it as part of thehepdata_librelease procedure.📚 Documentation preview 📚: https://hepdata-lib--254.org.readthedocs.build/en/254/