hsf-training / hsf-training-scikit-hep-webpage

https://hsf-training.github.io/hsf-training-scikit-hep-webpage/
Other
9 stars 19 forks source link

Basic file I/O with Uproot -> Opening the file -> skhep_testdata module #48

Open JacekHoleczek opened 1 year ago

JacekHoleczek commented 1 year ago

In the "Basic file I/O with Uproot" chapter, in the "Opening the file" section, you unconditionally "import skhep_testdata". However, "standalone" users who installed the full "scikit-hep" will not have this module. I'd like to propose to add in this place a small: Note: you may need to run "conda/mamba/pip install scikit-hep-testdata" in order to have this module. Or maybe simply: import skhep_testdata # you may first need to run conda/mamba/pip install scikit-hep-testdata

jpivarski commented 1 year ago

It's included in

https://github.com/hsf-training/hsf-training-scikit-hep-webpage/blob/a98a65b108ad0f603ac9cea7c0bfef5e4f040874/requirements.txt#L12

JacekHoleczek commented 1 year ago

Sorry, I was not clear enough.

I am trying to go through the tutorial as a "newcomer" would. So, as someone who only installed either "uproot", or "scipy", or "sckit-hep". I can't rely on one finding/consulting/applying the additional tutorial's requirements.txt file from git.

In general, I expect from Python that whenever one gets a "No module named 'AddOn'" error, one needs to "conda/mamba/pip install AddOn". If that is not the case, I think it would be nice to add an explicit note in the tutorial that some magic "conda/mamba/pip install Module" provides the required "AddOn".

That's the case for "skhep_testdata" which needs "scikit-hep-testdata".

stale[bot] commented 1 year ago

This issue or pull request has been automatically marked as stale because it has not had recent activity. Please manually close it, if it is no longer relevant, or ask for help or support to help getting it unstuck. Let me bring this to the attention of @klieret @wdconinc @michmx for now.