Move some `model.toml` options to "developer"/"expert" section

[alexdewar]

Currently all the options are mixed in together in the main section of the TOML file. It may be a good idea to put some of them into a separate [developer] or [expert] section to highlight that tinkering with them might break things.

[alexdewar]

Marking as "question" because it's questionable as to which of the existing options (if any) would belong in this new section.

[tsmbland]

I'd say this is everything apart from milestone_years, and possibly max_ironing_out_iterations and price_tolerance.

I wouldn't say they necessarily need to be in their own section in the toml file, but I think we should find a way to hide these in the documentation so casual users don't have see them. Currently they're very prominent at the top of the input file documentation and it's a bit confusing.

I think if we could have a "Show/hide advanced options" button that would be cool

[alexdewar]

I'd say this is everything apart from milestone_years, and possibly max_ironing_out_iterations and price_tolerance.

👍

I wouldn't say they necessarily need to be in their own section in the toml file, but I think we should find a way to hide these in the documentation so casual users don't have see them. Currently they're very prominent at the top of the input file documentation and it's a bit confusing.

Agree that it's confusing. The logic for having them in a separate section was to make it clear that users shouldn't be changing these options at all and that, if they do, they might get nonsensical results (or even hit bugs). We should also warn users if they try to change any of them, I think.

It's not totally obvious to me which parameters belong in this category, but max_ironing_out_iterations and price_tolerance are just regular model params as far as I'm concerned -- changing them won't break stuff. default_candidate_asset_capacity is probably one that users shouldn't ever change though. (That said, you might have to tweak it if you're working with processes with really small capacities, so there is a bit of a deeper problem there -- maybe we should use a heuristic to determine it by default.)

On a related note, I've noticed that we don't validate most of the model params, so users could enter nonsensical values (e.g.<0, inf etc.) and we should probably fix this.

I think if we could have a "Show/hide advanced options" button that would be cool

Good idea!