AtHeartEngineer/SIMoN
1
0
Fork 0
mirror of https://github.com/JHUAPL/SIMoN.git synced 2026-01-09 23:07:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

readme updates

Browse Source 
Former-commit-id: 43dd31813b8165ffae41dbea0a6013a5ab26bbaf
This commit is contained in:
Michael T. Kelbaugh
2020-03-16 13:55:30 -04:00
parent b239363936
commit a45b2ac377
4 changed files with 67 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
broker/README.md
View File

@@ -14,11 +14,11 @@ The Inner Wrappers are interfaces tailored to each model, and support the models
Adjust parameters in the `build/config.json` file.
* `mongo_port` is the port that the MongoDB container will use. The default Mongo port is 27017.
* `boot_timer` is the number of seconds that the broker will wait for all models to initialize, before it sends the shutdown signal. Try extending this time if models will take longer to load and process their configuration data in the custom `configure()` method in their inner wrapper.
* `watchdog_timer` is the number of seconds that the broker will wait to receive a status message from a model, before it sends the shutdown signal. If a model crashes, the broker will wait for this number of seconds before stopping the SIMoN run.
* `max_incstep` is the number of increments that the SIMoN run should perform before closing down.
* `initial_year` is the year corresponding to the configuration data (increment step 0).*
* `models` lists the ID / unique name of each model that will be included in the SIMoN run.
* `mongo_port` is the port that the MongoDB container will use. The default Mongo port is 27017.
* `boot_timer` is the number of seconds that the broker will wait for all models to initialize, before it sends the shutdown signal. Try extending this time if models will take longer to load and process their configuration data in the custom `configure()` method in their inner wrapper.
* `watchdog_timer` is the number of seconds that the broker will wait to receive a status message from a model, before it sends the shutdown signal. If a model crashes, the broker will wait for this number of seconds before stopping the SIMoN run.
* `max_incstep` is the number of increments that the SIMoN run should perform before closing down.
* `initial_year` is the year corresponding to the configuration data (increment step 0).
* `models` lists the ID / unique name of each model that will be included in the SIMoN run.
* Because SIMoN runs predictive models, each increment step, and the data published at that increment step, corresponds to a point in time in the future. Currently, each increment corresponds to a year, since the data in the example models is annual. The `initial_year` parameter is used to specify the initial year assigned to increment step 0, and translate each subsequent increment step to its corresponding year. For models that do not have annual data, the reported "year" can be ignored by the user. In the future, SIMoN may be expanded to support multiple definitions of time (such as year, month, and fiscal quarter), just like it currently supports multiple definitions of geography (such as state, county, and watershed).
Because SIMoN runs predictive models, each increment step, and the data published at that increment step, corresponds to a point in time in the future. Currently, each increment corresponds to a year, since the data in the example models is annual. The `initial_year` parameter is used to specify the year assigned to the initial increment step 0, and translates each subsequent increment step to its corresponding year. For models that do not have annual data, the reported "year" can be ignored by the user. In the future, SIMoN may be expanded to support multiple definitions of time (such as year, month, and fiscal quarter), just like it currently supports multiple definitions of geography.