Troubleshooting
Use this page when PINGMapper, PINGInstaller, or PINGWizard is not behaving as expected. If you cannot resolve the problem here, please submit an Issue.
Table of contents
Start Here
Before digging into a specific problem, confirm the recommended workflow:
- Install Miniforge.
- Run PINGInstaller.
- Launch PINGWizard.
- Run the small dataset test.
If the small dataset test passes, your installation is usually healthy and the problem is more likely tied to a specific sonar file, processing setting, or output location.
PINGInstaller or PINGWizard Will Not Launch
Symptom
python -m pinginstallerdoes nothing or fails.- The PINGWizard shortcut does not open.
conda run -n ping python -m pingwizardfails.
What to try
- Re-open
Miniforge Promptand rerun the installation steps from Installation. - Reinstall
PINGInstallerinbase:
pip install pinginstaller -U
- Rerun the installer:
python -m pinginstaller
- If the shortcut fails, try launching directly from the prompt:
conda run -n ping python -m pingwizard
If that fails
Run the small dataset test if you can reach PINGWizard. If you cannot, open an issue and include the full terminal output.
ModuleNotFoundError
Symptom
You receive a ModuleNotFoundError during installation, launch, or while running the included tests.
Likely cause
The ping environment is missing a dependency, or the wrong Python environment is being used.
What to try
- Make sure you are using the
pingenvironment created byPINGInstaller. - If the error names a specific package, install that package into
ping.
Example:
conda activate ping
conda install sympy
If conda install fails, try:
pip install sympy
- Rerun the small dataset test.
Example error
One previously reported example is shown here.
If that fails
Submit an issue and include the full traceback, your operating system, and whether you installed with Miniforge + PINGInstaller.
The Small Dataset Test Fails
Symptom
The Small Dataset button in PINGWizard fails, closes early, or does not create outputs.
What to try
- Rerun the test from Testing.
- Confirm the output folder was created on a local drive.
- If the failure mentions a missing package, follow ModuleNotFoundError.
- If the failure happens only on the large dataset test, reduce other concurrent load on your computer and rerun the small test first.
If that fails
Open an issue and include whether the small test, large test, or both are failing.
My Sonar File Does Not Load
Symptom
- The selected recording does not appear in the GUI as expected.
- Processing starts but immediately fails.
- A Humminbird recording appears incomplete.
What to try
- Confirm the file type is supported.
- For Humminbird recordings, make sure the
.DATfile has a same-named folder beside it containing theSONandIDXfiles. See Running. - Try the same workflow on the included test data first to confirm the installation is healthy.
- If the file came from a cloud-synced folder, copy it to a fully local folder before processing.
If that fails
Open an issue and include the sonar format, manufacturer, and a screenshot of the input folder structure.
No Outputs Were Created
Symptom
Processing ran, but the expected project folder or exported files are missing.
What to try
- Verify the selected
Output FolderandProject NameinPINGWizard. - Check whether
Overwrite Existing Projectwas enabled when rerunning a project. - Confirm you are writing to a local drive rather than OneDrive, Google Drive, or another cloud-synced path.
- Look in the generated project
logsfolder for the latest log file.
If that fails
Submit an issue and attach the log file from the project logs directory.
Processing Freezes or Runs Out of Memory
Symptom
PINGMapper becomes very slow, freezes, or crashes during processing.
Likely cause
Thread count is too aggressive for the available RAM or the dataset is large.
What to try
- Lower
Thread Countin the GUI. - Start with
0.5to0.75of available CPU threads, as suggested in Running. - Close other memory-intensive applications.
- Run the small test first to verify the installation before processing a large survey.
If that fails
Open an issue and include dataset size, thread count used, and when the freeze occurs.
Exports Fail on OneDrive or Other Cloud Folders
Symptom
Processing appears to fail during export, or outputs are incomplete when writing to a synced folder.
What to try
Write outputs to a local folder instead. This is already noted in Running.
If that fails
Try a simple local path such as C:\PINGMapper_Outputs and rerun the workflow.
What to Include in an Issue Report
To make troubleshooting faster, include:
- Operating system.
- Sonar file format and manufacturer.
- Whether installation was done with Miniforge + PINGInstaller.
- Whether the small dataset test passes.
- The exact error message or traceback.
- The relevant log file from the project
logsdirectory. - Screenshots of the GUI settings or input folder structure when relevant.