Skip to content

Update docs #76

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.

Sign up for GitHub

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

Merged
Radonirinaunimi merged 2 commits into from
Sep 15, 2025
Merged

Update docs #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a4ee63
Update CLI tutorials
Radonirinaunimi Sep 15, 2025
92ce01b
Update documentations
Radonirinaunimi Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/cli-tutorials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ neopdf read num_subgrids --pdf-name NNPDF40_nnlo_as_01180
To get the knot values for a given subgrid:

```bash
neopdf read subgrid-info --pdf-name NNPDF40_nnlo_as_01180 --member 0 --subgrid-index 1
neopdf read subgrid-info --pdf-name NNPDF40_nnlo_as_01180 --member=0 --subgrid-index=1
```

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

```bash
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo_as_01180 --member 0 --pid 21 1e-3 10.0
neopdf compute xfx_q2 --pdf-name NNPDF40_nnlo_as_01180 --member=0 --pid=21 1e-3 10.0
```

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

```bash
neopdf compute alphas_q2 --pdf-name NNPDF40_nnlo_as_01180 --member 0 --q2 10
neopdf compute alphas_q2 --pdf-name NNPDF40_nnlo_as_01180 --member=0 --q2=10
```

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

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

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

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

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

```bash
> neopdf read subgrid --pdf-name NNPDF40_nnlo_as_01180.neopdf.lz4 --member 0 --subgrid-index 0 --pid 21
> neopdf read subgrid --pdf-name NNPDF40_nnlo_as_01180.neopdf.lz4 --member=0 --subgrid-index=0 --pid=21

[x | Q2] 2.72250e0 3.19494e0 3.77488e0 4.49175e0 5.38430e0 6.50400e0 7.91974e0
1.00000e-9 1.48441e-1 -1.47266e0 -3.42816e0 -5.57841e0 -7.73893e0 -9.65268e0 -1.10375e1
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ to be a modern, high-performance alternative to both [LHAPDF](https://www.lhapdf
</div>
<div class="feature-card">
<strong>🧩 Flexibility</strong>
<p>Easy support for different interpolation strategies: efficient implementation of custom interpolations.</p>
<p>Easy support for different interpolation strategies, enabling seamless/efficient implementation of new methods.</p>
</div>
<div class="feature-card">
<strong>🌐 Multi-Language Support</strong>
<p>Native Rust 🦀 API, with bindings for various programming languages such as Python 🐍, Fortran, C, and C++.</p>
<p>Native Rust 🦀 API, with bindings for various programming languages such as Python, Fortran, C, C++, Mathematica.</p>
</div>
<div class="feature-card">
<strong>📊 (Physics) Features & Extensibility</strong>
Expand Down
10 changes: 6 additions & 4 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ theme:
extra_css:
- custom.css
- assets/stylesheets/notebooks.css
- https://cdn.jsdelivr.net/gh/devicons/devicon@latest/devicon.min.css
extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
nav:
Expand All @@ -29,10 +30,11 @@ nav:
- CLI Tutorials: cli-tutorials.md
- TMDlib Interface: tmdlib.md
- Examples:
- 'Python API': 'examples/neopdf-pyapi.ipynb'
- 'C++ OOP API': 'examples/c-oop.md'
- 'C/C++ API': 'examples/c.md'
- 'Fortran API': 'examples/fortran.md'
- '<i class="devicon-python-plain colored"></i> Python API': 'examples/neopdf-pyapi.ipynb'
- '<i class="devicon-cplusplus-plain colored"></i> C++ OOP API': 'examples/c-oop.md'
- '<i class="devicon-c-plain colored"></i> C/C++ API': 'examples/c.md'
- '<i class="devicon-fortran-original colored"></i> Fortran API': 'examples/fortran.md'
- '<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'
plugins:
- search
- mermaid2
Expand Down