Skip to content

Commit d6308dd

Browse files
Merge pull request #76 from Radonirinaunimi/update-docs
Update docs
2 parents 3a5c2a9 + 92ce01b commit d6308dd

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

docs/cli-tutorials.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ neopdf read num_subgrids --pdf-name NNPDF40_nnlo_as_01180
6464
To get the knot values for a given subgrid:
6565

6666
```bash
67-
neopdf read subgrid-info --pdf-name NNPDF40_nnlo_as_01180 --member 0 --subgrid-index 1
67+
neopdf read subgrid-info --pdf-name NNPDF40_nnlo_as_01180 --member=0 --subgrid-index=1
6868
```
6969

7070
- `--pdf-name`: Name of the PDF set.
@@ -109,7 +109,7 @@ neopdf write metadata --path NNPDF40_nnlo_as_01180.neopdf.lz4 --key SetType --va
109109
To compute the interpolated function $xf(x, Q^2)$ for a given PDF set, member, and flavor:
110110

111111
```bash
112-
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo_as_01180 --member 0 --pid 21 1e-3 10.0
112+
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo_as_01180 --member=0 --pid=21 1e-3 10.0
113113
```
114114

115115
- `--pdf-name`: Name of the PDF set (can be a `NeoPDF` or `LHAPDF` set).
@@ -131,7 +131,7 @@ neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo_as_01180 --member 0 --pid 21 1e-3
131131
To compute the strong coupling constant $\alpha_s(Q^2)$ for a given PDF set and member:
132132

133133
```bash
134-
neopdf compute alphas_q2 --pdf-name NNPDF40_nnlo_as_01180 --member 0 --q2 10
134+
neopdf compute alphas_q2 --pdf-name NNPDF40_nnlo_as_01180 --member=0 --q2=10
135135
```
136136

137137
- `--q2`: The $Q^2$ value at which to evaluate $\alpha_s$.
@@ -197,7 +197,7 @@ This will generate a `nNNPDF30_nlo_as_0118.neopdf.lz4` PDF grid that also contai
197197
dependence. One can now check the value of $xf(A, x, Q^2)$ for the Iron $^{56}_{26}\mathrm{Fe}$:
198198

199199
```bash
200-
neopdf compute xfx_q2 --pdf-name nNNPDF30_nlo_as_0118.neopdf.lz4 --member 0 --pid 21 56 1e-3 10.0
200+
neopdf compute xfx_q2 --pdf-name nNNPDF30_nlo_as_0118.neopdf.lz4 --member=0 --pid=21 56 1e-3 10.0
201201
```
202202

203203
### Combine multiple $\alpha_s$ LHAPDF sets
@@ -225,7 +225,7 @@ Note that the names of the PDF sets can be passed via the command line using the
225225
`--pdf--name`. We can then interpolate the $\alpha_s = 0.1180$ value:
226226

227227
```bash
228-
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo.neopdf.lz4 --member 0 --pid 21 0.1180 1e-3 10.0
228+
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo.neopdf.lz4 --member=0 --pid=21 0.1180 1e-3 10.0
229229
```
230230

231231
!!! danger "Warning"
@@ -265,7 +265,7 @@ first how many subgrids a given set member contains.
265265
We can look at the contents of the first subgrid for the **gluon** PDF:
266266

267267
```bash
268-
> neopdf read subgrid --pdf-name NNPDF40_nnlo_as_01180.neopdf.lz4 --member 0 --subgrid-index 0 --pid 21
268+
> neopdf read subgrid --pdf-name NNPDF40_nnlo_as_01180.neopdf.lz4 --member=0 --subgrid-index=0 --pid=21
269269
270270
[x | Q2] 2.72250e0 3.19494e0 3.77488e0 4.49175e0 5.38430e0 6.50400e0 7.91974e0
271271
1.00000e-9 1.48441e-1 -1.47266e0 -3.42816e0 -5.57841e0 -7.73893e0 -9.65268e0 -1.10375e1

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ to be a modern, high-performance alternative to both [LHAPDF](https://www.lhapdf
2121
</div>
2222
<div class="feature-card">
2323
<strong>🧩 Flexibility</strong>
24-
<p>Easy support for different interpolation strategies: efficient implementation of custom interpolations.</p>
24+
<p>Easy support for different interpolation strategies, enabling seamless/efficient implementation of new methods.</p>
2525
</div>
2626
<div class="feature-card">
2727
<strong>🌐 Multi-Language Support</strong>
28-
<p>Native Rust 🦀 API, with bindings for various programming languages such as Python 🐍, Fortran, C, and C++.</p>
28+
<p>Native Rust 🦀 API, with bindings for various programming languages such as Python, Fortran, C, C++, Mathematica.</p>
2929
</div>
3030
<div class="feature-card">
3131
<strong>📊 (Physics) Features & Extensibility</strong>

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ theme:
1717
extra_css:
1818
- custom.css
1919
- assets/stylesheets/notebooks.css
20+
- https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css
2021
extra_javascript:
2122
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
2223
nav:
@@ -29,10 +30,11 @@ nav:
2930
- CLI Tutorials: cli-tutorials.md
3031
- TMDlib Interface: tmdlib.md
3132
- Examples:
32-
- 'Python API': 'examples/neopdf-pyapi.ipynb'
33-
- 'C++ OOP API': 'examples/c-oop.md'
34-
- 'C/C++ API': 'examples/c.md'
35-
- 'Fortran API': 'examples/fortran.md'
33+
- '<i class="devicon-python-plain colored"></i> Python API': 'examples/neopdf-pyapi.ipynb'
34+
- '<i class="devicon-cplusplus-plain colored"></i> C++ OOP API': 'examples/c-oop.md'
35+
- '<i class="devicon-c-plain colored"></i> C/C++ API': 'examples/c.md'
36+
- '<i class="devicon-fortran-original colored"></i> Fortran API': 'examples/fortran.md'
37+
- '<img src="https://cdn.simpleicons.org/wolfram/c83737" alt="Wolfram" style="height: 1em; vertical-align: -0.125em; margin-right: 0.25em;"/> Mathematica': 'examples/mathematica.md'
3638
plugins:
3739
- search
3840
- mermaid2

0 commit comments

Comments
 (0)