Skip to content

Commit a08691e

Browse files
authored
Fixes for documentation (#560)
1 parent a3baf6d commit a08691e

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ with SlurmClusterExecutor() as exe:
8787
```
8888
In this case the [Python simple queuing system adapter (pysqa)](https://pysqa.readthedocs.io) is used to submit the
8989
`calc()` function to the [SLURM](https://slurm.schedmd.com) job scheduler and request an allocation with two CPU cores
90-
for the execution of the function - [HPC Cluster Executor](https://executorlib.readthedocs.io/en/latest/2-hpc-submission.html). In the background the [sbatch](https://slurm.schedmd.com/sbatch.html)
90+
for the execution of the function - [HPC Cluster Executor](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html). In the background the [sbatch](https://slurm.schedmd.com/sbatch.html)
9191
command is used to request the allocation to execute the Python function.
9292

9393
Within a given [SLURM](https://slurm.schedmd.com) job executorlib can also be used to assign a subset of the

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ documentation covers the [installation of pysqa](https://pysqa.readthedocs.io/en
6868
detail.
6969

7070
## HPC Job Executor
71-
For optimal performance in [HPC Allocation Mode](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html) the
72-
[flux framework](https://flux-framework.org) is recommended as job scheduler. Even when the [Simple Linux Utility for Resource Management (SLURM)](https://slurm.schedmd.com)
71+
For optimal performance the [HPC Job Executor](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html) leverages the
72+
[flux framework](https://flux-framework.org) as its recommended job scheduler. Even when the [Simple Linux Utility for Resource Management (SLURM)](https://slurm.schedmd.com)
7373
or any other job scheduler is already installed on the HPC cluster. [flux framework](https://flux-framework.org) can be
7474
installed as a secondary job scheduler to leverage [flux framework](https://flux-framework.org) for the distribution of
7575
resources within a given allocation of the primary scheduler.

docs/trouble_shooting.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@ dependency. The installation of this and other optional dependencies is covered
2020

2121
## Missing Dependencies
2222
The default installation of executorlib only comes with a limited number of dependencies, especially the [zero message queue](https://zeromq.org)
23-
and [cloudpickle](https://github.com/cloudpipe/cloudpickle). Additional features like [caching](https://executorlib.readthedocs.io/en/latest/installation.html#caching), [HPC submission mode](https://executorlib.readthedocs.io/en/latest/installation.html#hpc-cluster-executor)
24-
and [HPC allocation mode](https://executorlib.readthedocs.io/en/latest/installation.html#hpc-job-executor) require additional dependencies. The dependencies are explained in more detail in the
25-
[installation section](https://executorlib.readthedocs.io/en/latest/installation.html#).
23+
and [cloudpickle](https://github.com/cloudpipe/cloudpickle). Additional features like [caching](https://executorlib.readthedocs.io/en/latest/installation.html#caching), the [HPC Cluster Executors](https://executorlib.readthedocs.io/en/latest/installation.html#hpc-cluster-executor)
24+
and the [HPC Job Executors](https://executorlib.readthedocs.io/en/latest/installation.html#hpc-job-executor) require
25+
additional dependencies. The dependencies are explained in more detail in the
26+
[installation section](https://executorlib.readthedocs.io/en/latest/installation.html).
2627

2728
## Python Version
2829
Executorlib supports all current Python version ranging from 3.9 to 3.13. Still some of the dependencies and especially

notebooks/3-hpc-job.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
"metadata": {},
125125
"source": [
126126
"### Block Allocation\n",
127-
"The block allocation for the HPC allocation mode follows the same implementation as the [block allocation for the local mode](https://executorlib.readthedocs.io/en/latest/1-local.html#block-allocation). It starts by defining the initialization function `init_function()` which returns a dictionary which is internally used to look up input parameters for Python functions submitted to the `FluxJobExecutor` class. Commonly this functionality is used to store large data objects inside the Python process created for the block allocation, rather than reloading these Python objects for each submitted function."
127+
"The block allocation for the HPC allocation mode follows the same implementation as the [block allocation for the Single Node Executor](https://executorlib.readthedocs.io/en/latest/1-single-node.html#block-allocation). It starts by defining the initialization function `init_function()` which returns a dictionary which is internally used to look up input parameters for Python functions submitted to the `FluxJobExecutor` class. Commonly this functionality is used to store large data objects inside the Python process created for the block allocation, rather than reloading these Python objects for each submitted function."
128128
]
129129
},
130130
{

0 commit comments

Comments
 (0)