Troubleshooting

We're here to help. Before contacting support or posting to user groups, please take these steps:

  1. Identify which component is causing the error
  2. Check for updates for that component
  3. Review common issues below if the problem persists

If you still need assistance, you'll also find guidance below on gathering the necessary information to report the issue to our support team.

Check for Software Updates First

Patch releases are often made to individual components outside the main installer.

How to Update:

  • Windows users: SWAT+ Editor and Toolbox update automatically. For QSWAT+, visit the GitHub release page.
  • Linux/Mac users: Run the curl commands from the install page.
  • Manual checks: Visit the release pages for QSWAT+, SWAT+ Editor, and SWAT+ Toolbox. (SWAT+ model releases are bundled with tool updates.)

Before Installing Updates:

Close SWAT+ Toolbox, SWAT+ Editor, QSWAT+, and QGIS completely.

Troubleshooting Installation Issues:

If software won't open or projects won't load in SWAT+ Editor:

  1. Open Task Manager (Windows) and check for swatplus_rest_api.exe processes
  2. End any running instances
  3. Reinstall the software
  4. If problems persist, restart your computer

Review Common Issues

Pick your component below. It is important to identify where your error is occurring so that the right team members can assist you.

QSWAT+ Plugin Not Visible?

The QSWAT+ plugin should appear automatically in your QGIS toolbar after installation.

Troubleshooting steps:

  1. Check plugin status: Go to Plugins menu → verify QSWAT+ is listed and checked
  2. Review error messages: Click the thought bubble icon (lower right) → check the QSWAT+ tab for messages
  3. Get help: Copy any error messages and post them to the QSWAT+ User Group

Tip: If there's no QSWAT+ tab in the messages panel, check other tabs for relevant errors.

Screenshot of QGIS circling points of interest to load QSWAT+ plugin

Identify points of interest in QGIS. Click to enlarge.

Errors Delineating Watershed or Creating HRUs (Steps 1 & 2)

Carefully review the QSWAT+ manual to ensure proper plugin usage before troubleshooting. Keep in mind that errors during watershed delineation will cascade into subsequent steps, so it's crucial to resolve them first. When reporting issues to the QSWAT+ user group, document your workflow and provide as much detail as possible about the error.

Errors Editing Inputs, Running SWAT+, or Visualization (Steps 3 & 4)

Errors in Step 3 (Edit Inputs and Run SWAT+) are related to the SWAT+ Editor software or model executable, not QSWAT+. Please consult the appropriate tabs above and post to the relevant user groups for these issues.

For Step 4 (Visualization) errors, start by verifying that your model ran successfully and that SWAT+ Check opens properly from SWAT+ Editor. If it doesn't, the problem is with your model setup. If your model runs correctly but you're having trouble with visualization charts and maps, post your questions to the QSWAT+ user group.

Unable to Open Project in SWAT+ Editor

If you receive an error alert box, or you see a loading spinner for a minute followed by a message that the editor did not load correctly, it's possible that your installation didn't work properly.

Step 1: Reinstall

The quickest solution is often a fresh reinstall. You only need to reinstall SWAT+ Editor—other tools like QSWAT+ and SWAT+ Toolbox can remain installed.

To uninstall on Windows, search for "Add or remove programs" and locate SWAT+ Editor in your installed apps list. If multiple versions appear, first try uninstalling only the older versions, as having multiple installations can cause conflicts. If issues persist, uninstall all versions and confirm that the installation folder is completely removed from your system.

Download the latest SWAT+ Editor installer from GitHub, ensuring you select the most recent release date. Run the installer and use the default installation location when prompted.

Step 2: Check Firewall and Antivirus Software

Security software may be preventing SWAT+ Editor from running properly. Because firewall and antivirus configurations vary widely, please consult your IT department or software documentation for guidance on allowing programs through your security settings.

You'll need to check three executables: SWATPlusEditor.exe in C:\Users\[YOUR_USERNAME]\SWATPlus\SWATPlusEditor, plus two additional files in C:\Users\[YOUR_USERNAME]\SWATPlus\SWATPlusEditor\resources\app.asar.unpacked\static\api_dist. If you installed for all users, your base path will be C:\SWAT\SWATPlus\SWATPlusEditor instead.

While reviewing these files, check that their modification dates match the software release date. Significantly older dates indicate the reinstallation didn't complete properly. If this is the case, repeat Step 1 and watch the directory during uninstallation to ensure files are fully removed.

Step 3: Check Functionality in the Editor

If steps 1 and 2 have not solved your problem, please first check the Help page within SWAT+ Editor and take a screen shot of the Troubleshooting section as shown below:

Screenshot of SWAT+ Editor Help Page Troubleshooting Block
SWAT+ Editor Help Page Troubleshooting Block

Next, let's open the dev tools console, and take a screen shot of any errors that may appear:

Screenshot of SWAT+ Editor showing how to toggle developer tools
Open the Developer Tools

Screenshot showing the developer console window in SWAT+ Editor
Developer Tools Console Tab

Note in the screenshot above, the Console tab is selected. In my case, no errors are shown. However, if you have anything in this space, please first EXPAND any arrows and then take a screenshot of the text.

Report both this text and the Troubleshooting block to the SWAT+ Editor google group. Include comprehensive details about your process and previous troubleshooting attempts so we can provide accurate assistance.

Errors Running SWAT+

When encountering errors in SWAT+ Editor during a model run, the issue typically originates from the model execution itself rather than the editor interface. To troubleshoot these errors, you'll need to capture and review the console error log.

Examine each line of the error report to identify the problem's source. While the error will cite a specific line in the source code, you don't need to dive into the code itself—the file name referenced in the error provides the key information. If it mentions soils-related files, inspect your model's soil database for data errors. If it references climate, wgn, or weather files, check your weather input data for issues.

When you're unsure how to proceed, zip your project's TxtInOut directory and post it along with the full error log to the SWAT+ user group for help.

Screenshot of SWAT+ model run error log

Example of SWAT+ model error. Click to enlarge.