HEPData / hepdata_lib

Library for getting your data into HEPData
https://hepdata-lib.readthedocs.io
MIT License
15 stars 37 forks source link

Update and move SWAN-specific instructions #254

Closed GraemeWatt closed 5 months ago

GraemeWatt commented 5 months ago

The "SWAN-specific instructions" at the top of Getting_started.ipynb are misleading as they imply that hepdata_lib needs to be installed. Moreover, the given command pip install --user hepdata_lib does not work to upgrade hepdata_lib without setting a $PYTHONPATH variable 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 the Getting_started.ipynb notebook to a new "Using SWAN" section in docs/setup.rst. I also printed the hepdata_lib version at the top of the Getting_started.ipynb notebook 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_lib releases, it should not be necessary for users to upgrade hepdata_lib on their own CERNBox, given that the procedure is not completely straightforward. @clelange : when you make a new hepdata_lib release, 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 the hepdata_lib release procedure.


📚 Documentation preview 📚: https://hepdata-lib--254.org.readthedocs.build/en/254/

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2287c18) 87.70% compared to head (ead9f77) 87.99%. Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ 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 ``` | [Flag](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | Coverage Δ | | |---|---|---| | [unittests-3.10](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.99% <ø> (+0.28%)` | :arrow_up: | | [unittests-3.6](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.68% <ø> (+0.29%)` | :arrow_up: | | [unittests-3.7](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.68% <ø> (+0.29%)` | :arrow_up: | | [unittests-3.8](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.81% <ø> (+0.28%)` | :arrow_up: | | [unittests-3.9](https://app.codecov.io/gh/HEPData/hepdata_lib/pull/254/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData) | `87.81% <ø> (+0.28%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=HEPData#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

clelange commented 5 months ago

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

GraemeWatt commented 5 months ago

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