Skip to content

Update docs/parameters.md to reflect deprecated and obsolete params#123

Merged
Alomir merged 2 commits into
SIP78_convert_switches_to_run_time_options_part_3from
SIP78_update_docs
Jul 16, 2025
Merged

Update docs/parameters.md to reflect deprecated and obsolete params#123
Alomir merged 2 commits into
SIP78_convert_switches_to_run_time_options_part_3from
SIP78_update_docs

Conversation

@dlebauer

Copy link
Copy Markdown
Member

This PR updates docs/parameters.md to align with the SIPNET implementation as it will be following completion of #78 by merging #114.

  • removal of obsolete parameters
  • annotate unused soilWetness from clim file
  • replace compile-time parameters with "Run-time options" and "Hard coded values"

More work is likely needed - I am just adding these as I review #114.

Comment thread docs/parameters.md
| `soil-quality` | 0 | Use soil quality submodel. |
| `water-hresp` | 1 | Whether soil moisture affects heterotrophic respiration. |
| `num-carbon-soil-pools` | 1 | Number of carbon soil pools. |
| `do-main-output` | 1 | Print time series of all output variables to `<file-name>.out`. |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to delete duplicate rows

Comment thread docs/parameters.md
Comment on lines +357 to +359
# Input files
param-file = mysite.param
clim-file = mysite.clim

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not settable in the config file (or via command line). They'll get read, but they will be overridden by calculation from file-name

Comment thread docs/parameters.md

```
# Base filename (used for derived filenames if not explicitly specified)
file-name = mysite

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I definitely like this form ('snake-case', as it's called), given the parallel with the command line - but it's a deviation from all of the sipnet.in files in the codebase (which use ALL_CAPS versions of these params). Do we care?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VERY IMPORTANT correction: snake_case uses underscores. This is obviously kebab-case 😛

But more seriously I vote we enforce identical spelling on command line and sipnet.in so that we don't have to remember differences like underscore vs hyphen.

@Alomir Alomir left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of tweaks needed, which I'll get in the parent branch. Thanks so much for doing this!

@Alomir Alomir merged commit 756855b into SIP78_convert_switches_to_run_time_options_part_3 Jul 16, 2025
6 checks passed
@Alomir Alomir deleted the SIP78_update_docs branch July 16, 2025 13:56
@Alomir Alomir mentioned this pull request Feb 3, 2026
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants