Update README.md
Browse files
README.md
CHANGED
|
@@ -6,21 +6,35 @@ tags:
|
|
| 6 |
- science
|
| 7 |
- physics
|
| 8 |
---
|
| 9 |
-
# Model Card for Model ID
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
-
|
|
|
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
-intensity scaling (multiplicative factor): [0.9, 1.1]
|
| 24 |
-
-background (in log10 representation): [-10.0, -4.0]
|
| 25 |
-
d. the prior bounds provided for the SLDs for inference should not exceed a width of 5 Å.
|
| 26 |
|
|
|
|
|
|
|
|
|
| 6 |
- science
|
| 7 |
- physics
|
| 8 |
---
|
|
|
|
| 9 |
|
| 10 |
+
# Model Card for `neutrons-2layers-basic-v1`
|
| 11 |
|
| 12 |
+
## Summary
|
| 13 |
+
This is a trained **neutron reflectometry (NR)** model designed for use with the [`reflectorch`](https://pypi.org/project/reflectorch/) package.
|
| 14 |
|
| 15 |
+
---
|
| 16 |
+
|
| 17 |
+
## Specifications
|
| 18 |
+
|
| 19 |
+
- **Number of layers**: 2 (excluding fronting and backing media; ordered from *fronting* → *backing*)
|
| 20 |
+
- **Maximum q-range**: `[0.05, 0.4]`
|
| 21 |
+
|
| 22 |
+
### Parameter Types and Ranges
|
| 23 |
+
|
| 24 |
+
| Parameter | Range | Units |
|
| 25 |
+
|----------------------|------------------------|--------------------|
|
| 26 |
+
| Thickness | `[1.0, 1500.0]` | Å |
|
| 27 |
+
| Roughness | `[0.0, 60.0]` | Å |
|
| 28 |
+
| Nuclear SLD | `[-8.0, 16.0] × 10⁻⁶` | Å⁻² |
|
| 29 |
+
| Intensity scaling | `[0.9, 1.1]` | multiplicative factor |
|
| 30 |
+
| Background (log₁₀) | `[-10.0, -4.0]` | dimensionless |
|
| 31 |
|
| 32 |
+
---
|
| 33 |
+
|
| 34 |
+
## Notes on Usage
|
| 35 |
+
- For inference, **prior bounds on SLDs** should not exceed a width of **5 Å**.
|
| 36 |
+
|
| 37 |
+
---
|
|
|
|
|
|
|
|
|
|
| 38 |
|
| 39 |
+
## License
|
| 40 |
+
This model is distributed under the [GPL-3.0 license](https://www.gnu.org/licenses/gpl-3.0.html).
|