adjtomo/seisflows

Separate or de-prioritize internal paths vs required paths

bch0w opened this issue · 1 comments

bch0w commented

Currently the SeisFlows parameter file lumps all paths together in section Paths. However some of these paths are internally used paths (e.g., the name of the log file), and some are required paths (e.g., path to the SPECFEM binary executables).

It's not directly obvious which paths are important for a user or required, and probably not until they run seisflows check or seisflows submit will they realize that some paths are set incorrectly.

It would be useful then to separate or de-prioritize the internal paths so that it's more obvious which paths are required by the user. A few ways to implement

  • put internal paths into a separate section of the parameter file (sort of like a 'constants' section)
  • by default, do not include internal paths in the parameter file. add a command line flag (e.g., seisflows configure --include_internal_paths) that allows these to be included and set by the User.

Both options would require differentiating in the source code between internal and required paths. SeisFlows v2.0.0 had an implementation to do this but it felt like unnecessary overhead for a simple feature. Hopefully there is some easier way to handle this.

This was done in #181, internal paths are now visually separated from required paths