From 72e5cc0ceeaf161d96a6381199bbf9cb926f7e13 Mon Sep 17 00:00:00 2001 From: giuliaelgarcia Date: Fri, 9 Feb 2024 15:36:41 +0000 Subject: [PATCH 1/4] =?UTF-8?q?created=20the=20troub=C3=83leshooting.md=20?= =?UTF-8?q?file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/troubleshooting.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 docs/troubleshooting.md diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 00000000..804635db --- /dev/null +++ b/docs/troubleshooting.md @@ -0,0 +1,9 @@ +What to do if your pipeline beaks 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 yml file. + +Firslty: check the log file to see what went wrong and fix the issue + +Secondly: Before re running make sure to delete any intermediate files that where created in the previous run which +broke halfway throught, to ensure that you can fully reattempt. From a8a3807784b4e421080c860531313cc23129c02c Mon Sep 17 00:00:00 2001 From: giuliaelgarcia Date: Fri, 9 Feb 2024 16:22:13 +0000 Subject: [PATCH 2/4] some changes to troubleshooting.md document --- docs/troubleshooting.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 804635db..3768615c 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,4 +1,7 @@ -What to do if your pipeline beaks mid-run: +#Troubleshooting common issues when running panpipes + + +### 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 yml file. From 34c1f451741335fe9a3d35186bd3f7a2ca424cf8 Mon Sep 17 00:00:00 2001 From: giuliaelgarcia Date: Fri, 9 Feb 2024 16:29:15 +0000 Subject: [PATCH 3/4] changes to troubleshooting.md --- docs/troubleshooting.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 3768615c..f7f47098 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,12 +1,11 @@ #Troubleshooting common issues when running panpipes - ### 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 yml file. +accurately changed in the yaml file. -Firslty: check the log file to see what went wrong and fix the issue +First: check the log file to see what went wrong and fix the issue -Secondly: Before re running make sure to delete any intermediate files that where created in the previous run which -broke halfway throught, to ensure that you can fully reattempt. +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. From 583fe96dc7a5ae5a356706cb646691b2fe62e574 Mon Sep 17 00:00:00 2001 From: Fabiola Curion Date: Fri, 9 Feb 2024 17:46:54 +0100 Subject: [PATCH 4/4] Update troubleshooting.md fixed typos --- docs/troubleshooting.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f7f47098..1ba11de1 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -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.