Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and move SWAN-specific instructions #254

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Update and move SWAN-specific instructions #254

merged 2 commits into from
Feb 14, 2024

Conversation

GraemeWatt
Copy link
Member

@GraemeWatt GraemeWatt commented Feb 14, 2024

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/

* Update and move from Getting_started.ipynb to setup.rst.
@GraemeWatt GraemeWatt requested a review from clelange February 14, 2024 11:42
Copy link

codecov bot commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@            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 Coverage Δ
unittests-3.10 87.99% <ø> (+0.28%) ⬆️
unittests-3.6 87.68% <ø> (+0.29%) ⬆️
unittests-3.7 87.68% <ø> (+0.29%) ⬆️
unittests-3.8 87.81% <ø> (+0.28%) ⬆️
unittests-3.9 87.81% <ø> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@clelange
Copy link
Collaborator

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
Copy link
Member Author

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

Copy link
Collaborator

@clelange clelange left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much!

@clelange clelange merged commit b8f41b3 into main Feb 14, 2024
15 checks passed
@clelange clelange deleted the update_swan branch February 14, 2024 15:30
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.

2 participants