Skip to content
This repository has been archived by the owner on May 28, 2024. It is now read-only.

Add model instructions to README #146

Open
lekoenig opened this issue Jul 28, 2022 · 1 comment
Open

Add model instructions to README #146

lekoenig opened this issue Jul 28, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lekoenig
Copy link
Collaborator

lekoenig commented Jul 28, 2022

Ahh! This makes a lot more sense now. We should probably add a comment somewhere in 2a_model.R (maybe above p2a_med_obs_data and p2a_well_obs_data) that reminds a user that x_vars needs to be updated in this config file if any variables are added/omitted.

Originally posted by @lekoenig in #139 (comment)

It'd be useful if the README contained instructions for running the model, modifying the model (including adding new variables), and creating a new set of model experiments.

@lekoenig lekoenig added the documentation Improvements or additions to documentation label Sep 8, 2022
@lekoenig
Copy link
Collaborator Author

lekoenig commented Oct 19, 2022

Jotting down some items we might want to include:

  • use of git submodule to run river-dl
  • how to run the model without making any changes
  • where to modify model config inputs
  • use of committed weights vs retraining a model

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants