Skip to content

Update README: analytical fits replaced Gaussian Process #23

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
shimwell merged 2 commits into from
May 1, 2026
Merged

Update README: analytical fits replaced Gaussian Process #23

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
a9036ff
Update README: analytical fits replaced Gaussian Process
shimwell May 1, 2026
fde093b
fixing docs
shimwell May 1, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The software supports single-layer and multi-layer shielding simulations, enabli
🧠 Advanced features include:

- Monte Carlo build-up factor corrections for improved accuracy
- Gaussian Process extrapolation for enhanced prediction capabilities
- Analytical fits (Shin-Ishii, Power x saturator, thin-plate-spline RBF) for build-up factor interpolation and extrapolation

These tools allow engineers and researchers to perform fast and reliable radiation shielding assessments. 🚀

Expand Down
2 changes: 1 addition & 1 deletion docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Analytical-form fit of build-up factor across a set of MC points. 1D inputs are

**Methods:**

- `interpolate(quantity=None, warn=True, **kwargs)` - returns an `InterpolationResult` at the given parameter values. If the fit has more than one available quantity (e.g. both `dose-AP` and `dose-AP-total`), `quantity=` is required to disambiguate; otherwise it defaults to the only one.
- `interpolate(quantity=None, warn=True, **kwargs)` - returns an `InterpolationResult` at the given parameter values. If the fit has more than one available quantity (e.g. both `dose-AP-neutron` and `dose-AP-total`), `quantity=` is required to disambiguate; otherwise it defaults to the only one.

### `InterpolationResult`

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/studies/variable_material.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ VOID_THICKNESS = 1000
CONCRETE_THICKNESS = 50
source = rpk.Source(particle="neutron", energy=14.1e6)

N_DOSE = f"dose-{GEOMETRY}"
N_DOSE = f"dose-{GEOMETRY}-neutron"
P_DOSE = f"dose-{GEOMETRY}-coupled-photon"
TOTAL_DOSE = f"dose-{GEOMETRY}-total" # auto-synthesized by compute_buildup

Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ nav:
- Uncollided flux in void: vnv/uncollided_flux_in_void.md
- Transmission in void: vnv/transmission_in_void.md
- Beer-Lambert single slab: vnv/beer_lambert_single_slab.md
- Neutron fit form quality: vnv/neutron_fit_quality.md
- Primary-photon fit form quality: vnv/primary_photon_fit_quality.md
- Secondary-photon fit form quality: vnv/secondary_photon_fit_quality.md

plugins:
- search
Expand Down
Loading