Add Web Interface for Synthea Patient Generator

[gregorywmorris]

Pull Request: Add Web Interface for Synthea Patient Generator

Summary:

This pull request introduces a brand-new web interface to the Synthea Patient Generator repository. The web interface allows users to generate Synthea commands via a user-friendly HTML form, eliminating the need to manually enter commands in the terminal.

Additions:

1. README instructions updated with web interface instructions
   • Fence markup updated formating
2. Makefile
3. app.py
4. index.html

Key Features:

1. HTML Form-Based Interface:

   • User-Friendly Command Generation:

     • The web interface features an intuitive HTML form that lets users input parameters such as state, city, population size, and various configuration paths.
     • The form automatically constructs the correct Synthea command based on the user’s input, ensuring that all required options are included and properly formatted.

   • Dynamic Input Handling:

     • Input fields for various parameters (e.g., paths, state, and city names) automatically handle cases where spaces might cause issues in command-line execution by wrapping the inputs in double quotes.
     • The form also provides an option for users to specify additional Synthea configurations directly.

   • Preview Command Before Execution:

     • Upon submission, the generated Synthea command is displayed in an alert, allowing users to review and copy the command for execution.

2. Backend Integration with Flask:

   • A Flask backend is included to facilitate the integration of the web interface with the Synthea engine. This backend processes form submissions and prepares the command for execution.
   • The backend is designed to be lightweight and easy to extend if additional functionality is needed in the future.

3. Makefile for Easy Setup and Execution:

   • The repository now includes a Makefile to automate the environment setup, including:
     • Creating a Python virtual environment and installing dependencies (e.g., Flask).
     • Serving the HTML frontend via Python’s built-in HTTP server.
     • Running the Flask backend.
   • The Makefile includes targets for setting up the environment (setup), starting the frontend server (serve), running the Flask backend (flask), and executing both servers in parallel (run).

Getting Started:

• Setup:

  • Clone the repository and navigate to the project directory.
  • Run make to set up the Python environment, install the necessary dependencies, and start both the HTML frontend and Flask backend.

• Using the Interface:

  • Access the web interface at http://localhost:8000.
  • Fill out the form with your desired parameters, review the generated command, and execute it in your terminal.

Benefits:

• Ease of Use: Simplifies the process of generating Synthea commands, especially for users who may not be comfortable with command-line interfaces.
• Consistency: Reduces the likelihood of user error when manually constructing complex commands.
• Extendibility: The modular structure allows for easy future enhancements, such as adding more configuration options or integrating additional features.

Conclusion:
This new web interface significantly enhances the usability of the Synthea Patient Generator, making it accessible to a broader audience by providing a straightforward way to generate and execute Synthea commands.

[jgsuess]

Any chance this will merge soon? Are there any open issues?

[jawalonoski]

Any chance this will merge soon? Are there any open issues?

I don't believe any of the maintainers has reviewed this yet. Have you tried it? What did you think of it?

In the past, we've separated UI/UX and other tools from the core engine... For example, see the other repositories within https://github.com/synthetichealth, in particular projects like the module builder and spt.

[awatson1978]

The code does in fact work. There's a Makefile. It adds a python webserver (flask). It creates a super simple website.

[awatson1978]

I would be inclined to move the Node/Python wrappers into core, and separate this out into a python-webapp repo (and maybe also make a node-webapp repo). $0.02

[awatson1978]

FYI, I was noodling on a similar interface for the synthea.properties file and to generate the --exporter flags.