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

Feedback on particle module #5

Closed
eduardo-rodrigues opened this issue Jul 19, 2018 · 2 comments
Closed

Feedback on particle module #5

eduardo-rodrigues opened this issue Jul 19, 2018 · 2 comments

Comments

@eduardo-rodrigues
Copy link
Member

Non-python files in decaylanguage/particle/

I reckon it would be better to move those .txt and .csv files out of the python submodule,
similarly to what we did in https://github.com/scikit-hep/scikit-hep/tree/master/skhep/data.
At some point one might even consider a data package in Scikit-HEP, BTW ... But this move is just fine for now, I think.

I would also rename mass_width.csv to explicitly include the year, as that's relevant for a user to know that the file provided by the PDG is a decade old. So rename to mass_width_2008.csv.
This way, if we get the courage to update the file ourselves, we can give a hint in the filename.

pdgID_to_latex.txt

It would make sense to add a header with basic information, even if trivial. So, headers for the 3 columns at least, maybe also the date at which the file was created/checked.

particle.py

AmpGen is there even in methods and it it important to give some reference for it.
Also the docstring with "from an AmpGen style name" could be extended to hint at what the style is.

@henryiii
Copy link
Member

A few extra points:

  • Link to AmpGen
  • Expand docs just a bit

@eduardo-rodrigues
Copy link
Member Author

eduardo-rodrigues commented Jul 22, 2018

Dealt with in #8. Thanks.

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

No branches or pull requests

2 participants