diff options
author | Tomodachi94 <tomodachi94@protonmail.com> | 2024-09-13 23:18:10 -0700 |
---|---|---|
committer | Tomodachi94 <tomodachi94@protonmail.com> | 2024-09-13 23:18:10 -0700 |
commit | 1e71925b95df3240216753c6aec6efa4316343f5 (patch) | |
tree | 6df80aca1902fec6d9f2fc9a6def6fd61dfcd459 /doc | |
parent | 518750b2cb3e1982ac8bbaa89dcdc87268c55544 (diff) |
doc/packages/lhapdf: add documentation
This documents: * The existence of the `lhapdf` package (not particularly important) * The existence of the `lhapdf.pdf_sets` attrset (important) * The setup hook used in all of the entries in `lhapdf.pdf_sets` (slightly important) Part of #341479.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/packages/index.md | 1 | ||||
-rw-r--r-- | doc/packages/lhapdf.section.md | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/packages/index.md b/doc/packages/index.md index d6c62770b3813..89d7e477e76fc 100644 --- a/doc/packages/index.md +++ b/doc/packages/index.md @@ -17,6 +17,7 @@ ibus.section.md kakoune.section.md krita.section.md linux.section.md +lhapdf.section.md locales.section.md etc-files.section.md nginx.section.md diff --git a/doc/packages/lhapdf.section.md b/doc/packages/lhapdf.section.md new file mode 100644 index 0000000000000..af07d4edd42ab --- /dev/null +++ b/doc/packages/lhapdf.section.md @@ -0,0 +1,11 @@ +# LHAPDF {#lhapdf} + +[LHAPDF](https://lhapdf.hepforge.org/) is a tool for evaluating parton distribution functions (PDFs) in high-energy physics. LHAPDF is available in the `lhapdf` package. + +## PDF sets {#lhapdf-sets} + +All of [the PDF sets made available by the LHAPDF project](https://lhapdf.hepforge.org/pdfsets.html) are available through the `lhapdf.pdf_sets` attrset. + +### Setup hook {#lhapdf-sets-hook} + +Each package provided in the `lhapdf.pdf_sets` attrset contains a setup hook which adds itself to [the `LHAPDF_DATA_PATH` environment variable](https://lhapdf.hepforge.org/#sets). |