Closed trevorb1 closed 2 months ago
@ktehranchi, what are your thoughts on the initialization step? It does add an extra step, but saves the headache of tracking config files. We will have to remember to add any config changes to the template config file, though.
I think this is a great idea! I can modify my test config bash script so we can use it to double check if our changes match the template
Closes #262
Changes proposed in this Pull Request
In this PR I have removed tracking of configuration files. Since (from what I saw) there is no option to have files in your repo that are not tracked when modified, I added template config files in the
repo_data/
folder. When first installingpypsa-usa
, the user must run the newinit_pypa_usa.sh
script to copy the template files to theconfig
folder.To summarize the changes:
repo_data/config
init_pypsa_usa.sh
workflow/config
are not tracked by gitAlternatively, we could probably use the
onstart
argument from snakemake to check for the files beforehand. However, this may be difficult cause we dont really need all the config files for a run (for example, theconfig.cluster.yaml
is not required for local runs).There are some git options (such as
assume-unchanged
orskip-worktree
) that can be used to accomplish not tracking changes to git tracked files. However, this doesnt seem to be recommended practice.Checklist
envs/environment.yaml
.config.default.yaml
.doc/configtables/*.csv
.