ENH: generate particle property table from database

[shenvitor]

see the diff.

rtd preview

• Reference of markdown table, see this: https://compwa.github.io/ampform-dpd/lc2pkpi.html

[shenvitor]

by the way I suggest disabling ruff: D103 Missing docstring in public function

otherwise, I need to add words in even a small function... :(

(see https://github.com/ComPWA/gluex-nstar/pull/55/files#diff-926bf65d7b8ac9f10f92d4ba35cb6efb961aedac678bd078db398a6f1769352bR119
I need to add those in the function to pass the check...)

[redeboer]

by the way I suggest disabling ruff: D103 Missing docstring in public function

Yes good point. But only for notebooks, i.e. through the per-file-ignores table. I think there already is an entry for **.ipynb.

[redeboer]

I would try to make the table more concise, e.g. combine spin, parity, isospin etc into one row with a $J^{PC}(I^G)$ string. See also https://qrules--274.org.readthedocs.build/274/usage/visualize.html#other-state-renderings from ComPWA/qrules#274.

[shenvitor]

I would try to make the table more concise, e.g. combine spin, parity, isospin etc into one row with a JPC(IG) string. See also https://qrules--274.org.readthedocs.build/274/usage/visualize.html#other-state-renderings from ComPWA/qrules#274.

By the way, I understand that to show it in the form of $J^{PC}(I^{G})$.
And so in my original table, what about $I_3$ (We have this information from the database, maybe I keep it in another row right?)?
In the database, $J$ is not directly shown, I think I need to find a way to find/calculate it?

[redeboer]

In the database, $J$ is not directly shown, I think I need to find a way to find/calculate it?

No you can just use the existing attributes of each Particle instance. $J$ is spin, $I$ is isospin.magnitude etc. (Of course, you need to check whether these values are defined at all or None.)
It is uncommon to render $I_z$, but you can do so in another column.

[shenvitor]

In the database, J is not directly shown, I think I need to find a way to find/calculate it?

No you can just use the existing attributes of each Particle instance. J is spin, I is isospin.magnitude etc. (Of course, you need to check whether these values are defined at all or None.) It is uncommon to render Iz, but you can do so in another column.

I see... originally I was thinking about $J=L+S$, and so $L=0$ here you mean?

[redeboer]

Exactly, just have a look at what's happening in this PR (there the $J^{PC}(I^G)$ values are inserted into graphviz with unicode, but same idea for a latex table).

I would try to make the table more concise, e.g. combine spin, parity, isospin etc into one row with a JPC(IG) string. See also https://qrules--274.org.readthedocs.build/274/usage/visualize.html#other-state-renderings from ComPWA/qrules#274.

[shenvitor]

OK now it's ready for review :)
Oh wait seems like the mathjax is not working in html website but ok in notebook 🐙

[shenvitor]

Weird... Now all the math/equation/symbols of markdown/latex are not loading in the RTD website preview 🤔

[redeboer]

Yes it's an old issue with the Sphinx rendering, see e.g. jupyter-book/jupyter-book#1501. That's why I usually resort to building a custom Markdown table string and rendering it with Markdown. That also allows you to do more advanced renderings, but it is a bit more work.

[redeboer]

@shenvitor For the rendering of Markdown table in Sphinx that you implemented in 4073d24: the problem is that you need to set nb_render_markdown_format = "myst" in conf.py 🎉

[redeboer]

Awesome 🧇