Skip to content

Commit 6f24fb7

Browse files
committed
rename trouble>faq; link template error to setup, not own entry
1 parent 73fc9a2 commit 6f24fb7

File tree

5 files changed

+14
-66
lines changed

5 files changed

+14
-66
lines changed

R/qsys.r

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ QSys = R6::R6Class("QSys",
6666
template_error = function(scheduler, status, filled) {
6767
message("\nThe filled ", scheduler, " template ", sQuote(private$template_file),
6868
" was:\n", '"""', "\n", filled, '"""', "\n")
69-
message("see: https://mschubert.github.io/clustermq/articles/troubleshooting.html#template\n")
69+
message("see: https://mschubert.github.io/clustermq/articles/userguide.html#scheduler-setup\n")
7070
stop("Job submission failed with error code ", status, call.=FALSE)
7171
}
7272
),

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Browse the vignettes here:
3030

3131
* [User Guide](https://mschubert.github.io/clustermq/articles/userguide.html)
3232
* [Technical Documentation](https://mschubert.github.io/clustermq/articles/technicaldocs.html)
33+
* [FAQ](https://mschubert.github.io/clustermq/articles/faq.html)
3334

3435
Installation
3536
------------
@@ -53,7 +54,7 @@ remotes::install_github('mschubert/clustermq')
5354

5455
> [!TIP]
5556
> For installation problems, see the
56-
> [Troubleshooting guide](https://mschubert.github.io/clustermq/articles/troubleshooting.html#install)
57+
> [FAQ](https://mschubert.github.io/clustermq/articles/faq.html#install)
5758
5859
Schedulers
5960
----------
@@ -180,7 +181,7 @@ sizes. These include, but are not limited to:
180181
> [!TIP]
181182
> For any questions and issues, please check the
182183
> [User](https://mschubert.github.io/clustermq/articles/userguide.html) and the
183-
> [Troubleshooting](https://mschubert.github.io/clustermq/articles/troubleshooting.html)
184+
> [FAQ](https://mschubert.github.io/clustermq/articles/faq.html)
184185
> guides first
185186
186187
Citation

_pkgdown.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ navbar:
1313
href: articles/userguide.html
1414
- text: Technical Documentation
1515
href: articles/technicaldocs.html
16-
- text: Troubleshooting
17-
href: articles/troubleshooting.html
16+
- text: FAQ
17+
href: articles/faq.html
1818
- text: Reference
1919
href: reference/index.html
2020
- text: Changelog

vignettes/troubleshooting.Rmd vignettes/faq.Rmd

+2-55
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "Troubleshooting"
2+
title: "Frequently asked questions"
33
output:
44
rmarkdown::html_vignette
55
vignette: >
6-
%\VignetteIndexEntry{Troubleshooting}
6+
%\VignetteIndexEntry{FAQ}
77
%\VignetteEngine{knitr::rmarkdown}
88
%\VignetteEncoding{UTF-8}
99
---
@@ -58,59 +58,6 @@ compiler installed that you need to add to your `$PATH` or load as a module.
5858
Once this is set, you can install the package from R *that was started in a
5959
terminal that has this module/path active*.
6060

61-
## Job submission fails with template error {#template}
62-
63-
If you test your setup with a simple `Q` call, but get an error like the
64-
following:
65-
66-
```{r eval=FALSE}
67-
> clustermq::Q(identity, x=1, n_jobs=1)
68-
Submitting 1 worker jobs (ID: cmq6053) ...
69-
Unable to run job: unknown resource "m_mem_free"
70-
Exiting.
71-
72-
The filled SGE template ‘~/R/x86_64-pc-linux-gnu-library/4.2/clustermq/SGE.tmpl’ was:
73-
"""
74-
#$ -N cmq6053
75-
#$ -j y
76-
#$ -o /dev/null
77-
#$ -cwd
78-
#$ -V
79-
#$ -t 1-1
80-
#$ -pe smp 1
81-
#$ -l m_mem_free=1073741824
82-
83-
ulimit -v $(( 1024 * 4096 ))
84-
CMQ_AUTH=xxxx R --no-save --no-restore -e 'clustermq:::worker("tcp://10.0.0.100:6053")'
85-
"""
86-
87-
see: https://mschubert.github.io/clustermq/articles/troubleshooting.html#template
88-
89-
Error in initialize(...) : Job submission failed with error code 1
90-
In addition: Warning message:
91-
In system2("qsub", input = filled, stdout = TRUE) :
92-
running command ''qsub' < '/tmp/RtmpdGJOxs/filee7f3011007b'' had status 1
93-
```
94-
95-
This means that your job submission system has not been successfully
96-
auto-detected and requires some configuration, _i.e._ you need to manually
97-
specify what scheduler and template you want to use.
98-
99-
Be sure to know which scheduler your HPC provides, and then see the [manual
100-
scheduler setup](https://mschubert.github.io/clustermq/articles/userguide.html#scheduler-templates)
101-
on how to set it up.
102-
103-
You may need to change some scheduler-specific options in the template file for
104-
this to work, like the queue/partition name or how to request memory or
105-
runtime. Often, the error message gives you a good hint on what to change: In
106-
the example above, we are using a version of SGE where we need to use
107-
`mem_free` instead of `m_mem_free` to request memory.
108-
109-
If it is not obvious what do change, consult the scheduler documentation or
110-
your system admins for more information. For the latter, provide them with the
111-
filled template from the error message (as this is an HPC submission template
112-
issue rather than a `clustermq` package issue).
113-
11461
## Session gets stuck at "Running calculations" {#stuck}
11562

11663
Your R session may be stuck at something like the following:

vignettes/userguide.Rmd

+6-6
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ remotes::install_github("mschubert/clustermq@develop")
6666
```
6767

6868
For any installation issues please see the
69-
[Troubleshooting guide](https://mschubert.github.io/clustermq/articles/troubleshooting.html#install).
69+
[FAQ](https://mschubert.github.io/clustermq/articles/faq.html#install).
7070

7171
## Configuration
7272

@@ -81,7 +81,7 @@ There are three kinds of schedulers:
8181

8282
* `LOCAL` - sequential processing of calls (default if no HPC scheduler found)
8383
* [Multiple cores on the same machine](#local-parallelization)
84-
* [HPC schedulers](#setting-up-the-scheduler)
84+
* [HPC schedulers](#scheduler-setup)
8585

8686
Parallel and HPC schedulers can also be used [via SSH](#ssh-connector).
8787

@@ -97,7 +97,7 @@ to test your code before submitting it to a scheduler.
9797
multiple threads with `options(clustermq.scheduler="multicore")`. This
9898
sometimes causes problems (macOS, RStudio) and is not available on Windows.
9999

100-
### Setting up the scheduler
100+
### Setting up the scheduler {#scheduler-setup}
101101

102102
An HPC cluster's scheduler ensures that computing jobs are distributed to
103103
available worker nodes. Hence, this is what `clustermq` interfaces with in
@@ -138,9 +138,9 @@ providing a transparent SSH interface.
138138

139139
In order to use `clustermq` from your local machine, the package needs to be
140140
installed on both there and on the computing cluster. On the computing cluster,
141-
[set up your scheduler](#setting-up-the-scheduler) and make sure `clustermq`
142-
runs there without problems. Note that the *remote scheduler* can not be
143-
`LOCAL` (default if no HPC scheduler found) or `SSH` for this to work.
141+
[set up your scheduler](#scheduler-setup) and make sure `clustermq` runs there
142+
without problems. Note that the *remote scheduler* can not be `LOCAL` (default
143+
if no HPC scheduler found) or `SSH` for this to work.
144144

145145
```{r eval=FALSE}
146146
# If this is set to 'LOCAL' or 'SSH' you will get the following error:

0 commit comments

Comments
 (0)