Skip to content

Commit 19e801f

Browse files
committed
adds note to docs on how to generate the params file
1 parent 602c563 commit 19e801f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ uv run python -m nhp.model -d data/synth --type all
1818

1919
to run the model with the sample parameters.
2020

21+
### Generating Sample Parameters
22+
23+
you can generate sample parameters using the CLI command:
24+
25+
``` bash
26+
python -m nhp.model.params --dataset [dataset] --scenario [scenario] --app-version dev > params.json
27+
```
28+
29+
replacing the values as needed. This will generate a file `params.json` with the sample parameters.
30+
2131
## API Reference
2232

2333
See the [Model Reference](reference/nhp/model/index.md) for detailed documentation of all classes and functions.

0 commit comments

Comments
 (0)