Update theory documentation
@ecole41 is already working on this.
Since Feb 28, 2025.
Assessment
This issue has not been assessed yet.
Description
We need to update the theory documentation:
- index.rst
- FastInterface.rst
- PTevol.rst
- theoryindex.rst
- theoryparamsdefinitions.rst
- theoryparamsinfo.rst
FastInterface.rst
We should replace the old documentation here https://docs.nnpdf.science/theory/FastInterface.html as it is outdated.
Instead the page should contain the updated way:
- to calculate FK tables we need two (main) programs: pinefarm + pineko
- the mathematical concept of FK tables (with updated notation) is here: https://pineko.readthedocs.io/en/latest/theory/fktables.html
- the actual computation is a two step process:
- generate a (process-dependent) grid with pinefarm
- transform the grid into an FK table
- for 1.
- for 2: point to https://pineko.readthedocs.io/en/latest/index.html
- Dominant language
- Python
- Stars
- 44
- Forks
- 15
- Avg merge
- 8d 12h
- Merged PRs (30d)
- 7
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NNPDF/nnpdf
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
validphys
Difficulty 1/5 Under an hour Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Invalidate cached resourcesPossibly taken @felixhekhorn claimed this today. Open
-
Extend FK table hash computationPossibly taken @jekoorn claimed this today. Open
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
mozilla-ai/cq#601 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
intcomma returns exponential notation for large floatsPossibly taken @Omarinho12345 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
python-humanize/humanize#521 ·
Maintainers usually reply within 1 day
-
LUCJ pass manager raises NoEdgeBetweenNodes when an edge is bad for two two-qubit gatesPossibly taken @hat-im claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
opensubtitlescom: provider rejects pt-PT even though its own converter maps itPossibly taken @paulo-0308 claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Diaoul/subliminal#1405 ·