Skip to content

Commit

Permalink
Update troubleshooting.md
Browse files Browse the repository at this point in the history
fixed typos
  • Loading branch information
bio-la authored Feb 9, 2024
1 parent 34c1f45 commit 583fe96
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
#Troubleshooting common issues when running panpipes
# Troubleshooting common issues when running panpipes

### What to do when the pipeline breaks mid run
### What to do when the pipeline breaks mid-run

Sometimes the pipeline will stop because, for example, a parameter is wrong in the config file, or a path was not
accurately changed in the yaml file.
Sometimes the pipeline will stop because, for example, a parameter is wrong in the config file, or a path is not
accurate in the YAML file.

First: check the log file to see what went wrong and fix the issue
TODO add examples of directories when pipeline breaks mid-run

**Solution**
First: check the log files to see what went wrong.
- Inspect the pipeline.log file: the bottom of the file will print the error that broke the pipeline.
TODO: add text from a failed pipeline.log as an example
- In this case the pipeline failed at ...: inspect the log file for this process in logs/xxx.log

You can fix the issue by ...

Second: Before re-running panpipes, we recommend deleting any intermediate files that were created in the previous run which
broke halfway through.

Second: Before re running make sure to delete any intermediate files that where created in the previous run which
broke halfway through, to ensure that you can fully reattempt.

0 comments on commit 583fe96

Please sign in to comment.