NR-1layer-basic-v1 / README.md
valentinsingularity's picture
Update README.md
ad3055e verified
---
license: gpl-3.0
language:
- en
tags:
- science
- physics
metadata:
parameterization: "slab"
number_of_layers: 1
param_ranges:
thicknesses: [1., 1500.]
roughnesses: [0., 60.]
slds: [-8., 16.]
r_scale: [0.9, 1.1]
log10_background: [-10.0, -4.0]
bound_width_ranges:
thicknesses: [1.0e-2, 1500.]
roughnesses: [1.0e-2, 60.]
slds: [1.0e-2, 5.]
r_scale: [1.0e-3, 0.2]
log10_background: [1.0e-2, 6.0]
shift_param_config:
r_scale: true
log10_background: true
---
# Model Card for `neutrons-1layer-basic-v1`
## Summary
This is a trained **neutron reflectometry (NR)** model designed for use with the [`reflectorch`](https://pypi.org/project/reflectorch/) package.
---
## Specifications
- **Number of layers**: 1 (excluding fronting and backing media; ordered from *fronting**backing*)
- **Maximum q-range**: `[0.05, 0.4]`
### Parameter Types and Ranges
| Parameter | Range | Units |
|----------------------|------------------------|--------------------|
| Thicknesses | `[1.0, 1500.0]` | Å |
| Roughnesses | `[0.0, 60.0]` | Å |
| Nuclear SLDs | `[-8.0, 16.0]` | 10⁻⁶ Å⁻² |
| Intensity scaling | `[0.9, 1.1]` | multiplicative factor |
| Background (log₁₀) | `[-10.0, -4.0]` | dimensionless |
---
## Notes on Usage
- For inference, **prior bounds on SLDs** should not exceed a width of **5 Å**.
---
## License
This model is distributed under the [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html).