Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,57 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: gpl-3.0
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: gpl-3.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- science
|
| 7 |
+
- physics
|
| 8 |
+
metadata:
|
| 9 |
+
parameterization: "slab"
|
| 10 |
+
number_of_layers: 1
|
| 11 |
+
param_ranges:
|
| 12 |
+
thicknesses: [1., 1500.]
|
| 13 |
+
roughnesses: [0., 60.]
|
| 14 |
+
slds: [-8., 16.]
|
| 15 |
+
r_scale: [0.9, 1.1]
|
| 16 |
+
log10_background: [-10.0, -4.0]
|
| 17 |
+
bound_width_ranges:
|
| 18 |
+
thicknesses: [1.0e-2, 1500.]
|
| 19 |
+
roughnesses: [1.0e-2, 60.]
|
| 20 |
+
slds: [1.0e-2, 5.]
|
| 21 |
+
r_scale: [1.0e-3, 0.2]
|
| 22 |
+
log10_background: [1.0e-2, 6.0]
|
| 23 |
+
shift_param_config:
|
| 24 |
+
r_scale: true
|
| 25 |
+
log10_background: true
|
| 26 |
+
---
|
| 27 |
+
# Model Card for `neutrons-1layer-basic-v1`
|
| 28 |
+
|
| 29 |
+
## Summary
|
| 30 |
+
This is a trained **neutron reflectometry (NR)** model designed for use with the [`reflectorch`](https://pypi.org/project/reflectorch/) package.
|
| 31 |
+
|
| 32 |
+
---
|
| 33 |
+
|
| 34 |
+
## Specifications
|
| 35 |
+
|
| 36 |
+
- **Number of layers**: 1 (excluding fronting and backing media; ordered from *fronting* → *backing*)
|
| 37 |
+
- **Maximum q-range**: `[0.05, 0.4]`
|
| 38 |
+
|
| 39 |
+
### Parameter Types and Ranges
|
| 40 |
+
|
| 41 |
+
| Parameter | Range | Units |
|
| 42 |
+
|----------------------|------------------------|--------------------|
|
| 43 |
+
| Thicknesses | `[1.0, 1500.0]` | Å |
|
| 44 |
+
| Roughnesses | `[0.0, 60.0]` | Å |
|
| 45 |
+
| Nuclear SLDs | `[-8.0, 16.0]` | 10⁻⁶ Å⁻² |
|
| 46 |
+
| Intensity scaling | `[0.9, 1.1]` | multiplicative factor |
|
| 47 |
+
| Background (log₁₀) | `[-10.0, -4.0]` | dimensionless |
|
| 48 |
+
|
| 49 |
+
---
|
| 50 |
+
|
| 51 |
+
## Notes on Usage
|
| 52 |
+
- For inference, **prior bounds on SLDs** should not exceed a width of **5 Å**.
|
| 53 |
+
|
| 54 |
+
---
|
| 55 |
+
|
| 56 |
+
## License
|
| 57 |
+
This model is distributed under the [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html).
|