Skip to content

Commit ca7f09f

Browse files
committed
Improved documentation in script
1 parent 7555691 commit ca7f09f

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

src/main/emme/toolbox/utilities/settings_manager.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,20 @@ def __call__(self, target):
212212
self.update_settings_file(target)
213213

214214
if __name__ == "__main__":
215-
# Run from root directory of a clone of the ABM repo
216-
# Instructions to run from Anaconda prompt:
217-
# python src\main\emme\toolbox\utilities\settings_manager.py [DIRS OR FILES TO UPDATE]
215+
"""
216+
Run from root directory of a clone of the ABM repo
217+
Instructions to run from Anaconda prompt:
218+
python src\main\emme\toolbox\utilities\settings_manager.py [DIRS OR FILES TO UPDATE]
219+
220+
Example (just passenger model configs):
221+
python src\main\emme\toolbox\utilities\settings_manager.py src\asim\configs
222+
223+
Example (property file):
224+
python src\main\emme\toolbox\utilities\settings_manager.py src\main\resources\conf\sandag_abm.properties
225+
226+
Example (all configs):
227+
python src\main\emme\toolbox\utilities\settings_manager.py src\main\resources\conf\sandag_abm.properties src\asim\configs src\asim-cvm\configs
228+
"""
218229
manage_settings = SettingsManager(r"src\main\resources\abm3_settings.yaml")
219230
import sys
220231
assert len(sys.argv) > 1, "Please provide at least one file or directory to update"

src/main/python/run_settings_manager.py

Whitespace-only changes.

0 commit comments

Comments
 (0)