Update and move SWAN-specific instructions #254
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 commandpip install --user hepdata_lib
does not work to upgradehepdata_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 theGetting_started.ipynb
notebook to a new "Using SWAN" section indocs/setup.rst
. I also printed thehepdata_lib
version at the top of theGetting_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 upgradehepdata_lib
on their own CERNBox, given that the procedure is not completely straightforward. @clelange : when you make a newhepdata_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 thehepdata_lib
release procedure.📚 Documentation preview 📚: https://hepdata-lib--254.org.readthedocs.build/en/254/