Generic Module Framework: Running New Modules - synthetichealth/synthea GitHub Wiki

All new modules should be saved in a local directory that is passed to Synthea^TM when it is run. For users of the basic setup:

java -jar synthea-with-dependencies.jar -d path/to/modules/directory

For those using the developer setup:

./run_synthea -d path/to/modules/directory

Synthea will scan the supplied directory for modules and include them in its output.

For those using the developer setup only:

If you want to edit existing modules to change their behavior, we recommend that you edit the module in the Module Builder.

When you are finished editing the module, click the "Download" link. That will open a modal dialog showing you the module JSON. Click the "Download" button again and save your module file.

Next, replace the original module file in src/main/resources/modules (add any subfolders to that path if it is a submodule). The next time you run Synthea, it will use your modified versions.

Note: if your module contains Table-based Transitions, and you altered those tables, then you also need those CSV files in a subfolder within your modules directory called lookup_tables.