Skip to content

Commit de44ab0

Browse files
authored
[Documentation] Update links (#1018)
1 parent d8456c4 commit de44ab0

2 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -185,18 +185,22 @@ function calls.
185185
* [HPC Cluster Executor](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html)
186186
* [SLURM](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html#slurm)
187187
* [Flux](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html#flux)
188+
* [Disconnecting and Reconnecting](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html#disconnecting-and-reconnecting)
189+
* [Combine both](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html#combine-both)
190+
* [Cleaning Cache](https://executorlib.readthedocs.io/en/latest/2-hpc-cluster.html#cleaning-cache)
188191
* [HPC Job Executor](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html)
189192
* [SLURM](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html#slurm)
190193
* [SLURM with Flux](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html#slurm-with-flux)
191194
* [Flux](https://executorlib.readthedocs.io/en/latest/3-hpc-job.html#flux)
192195
* [Application](https://executorlib.readthedocs.io/en/latest/application.html)
193196
* [GPAW](https://executorlib.readthedocs.io/en/latest/4-1-gpaw.html)
194197
* [Quantum Espresso](https://executorlib.readthedocs.io/en/latest/4-2-quantum-espresso.html)
195-
* [Coupling with other Libraries](https://executorlib.readthedocs.io/en/latest/coupling.html)
196-
* [emcee](https://executorlib.readthedocs.io/en/latest/coupling.html#emcee-markov-chain-monte-carlo)
197-
* [pipefunc](https://executorlib.readthedocs.io/en/latest/coupling.html#pipefunc-function-pipelines)
198-
* [omp4py](https://executorlib.readthedocs.io/en/latest/coupling.html#omp4py-openmp-for-python)
199-
* [pylammpsmpi](https://executorlib.readthedocs.io/en/latest/coupling.html#pylammpsmpi-mpi-parallel-lammps)
198+
* [Integration](https://executorlib.readthedocs.io/en/latest/coupling.html)
199+
* [emcee](https://executorlib.readthedocs.io/en/latest/coupling.html#emcee)
200+
* [pipefunc](https://executorlib.readthedocs.io/en/latest/coupling.html#pipefunc)
201+
* [omp4py](https://executorlib.readthedocs.io/en/latest/coupling.html#omp4py)
202+
* [pylammpsmpi](https://executorlib.readthedocs.io/en/latest/coupling.html#pylammpsmpi)
203+
* [General Pattern](https://executorlib.readthedocs.io/en/latest/coupling.html#general-pattern)
200204
* [Trouble Shooting](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html)
201205
* [Filesystem Usage](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#filesystem-usage)
202206
* [Firewall Issues](https://executorlib.readthedocs.io/en/latest/trouble_shooting.html#firewall-issues)

docs/coupling.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Coupling with other Libraries
1+
# Integration
22
A lot of scientific Python packages already know how to distribute work over many processes - they just need to be
33
handed an object that behaves like an executor or a worker pool. Because executorlib implements the
44
[Executor interface](https://docs.python.org/3/library/concurrent.futures.html#executor-objects) of the Python standard
@@ -18,7 +18,7 @@ not part of the executorlib test environment. In every example the `SingleNodeEx
1818
HPC cluster.
1919
```
2020

21-
## emcee (Markov Chain Monte Carlo)
21+
## emcee
2222
[emcee](https://emcee.readthedocs.io) is a widely used Python package for Markov Chain Monte Carlo (MCMC) sampling, for
2323
example to estimate the posterior distribution of model parameters from experimental data. The likelihood function has
2424
to be evaluated many times per sampling step, and these evaluations are independent of each other, so they can be
@@ -50,7 +50,7 @@ more expensive likelihood functions the parallel evaluation provides a substanti
5050
`SingleNodeExecutor` with a `FluxJobExecutor` the very same sampling can be distributed over multiple compute nodes of an
5151
HPC cluster.
5252

53-
## pipefunc (Function Pipelines)
53+
## pipefunc
5454
[pipefunc](https://pipefunc.readthedocs.io) is a library to build function pipelines, where the output of one function
5555
is used as the input for the next function, including map-reduce patterns over many parameters. pipefunc takes care of
5656
the book keeping of the pipeline, while the actual execution of the individual functions is delegated to an executor.
@@ -92,7 +92,7 @@ results = pipeline.map(inputs, executor=executor)
9292
The combination of pipefunc and executorlib is explained in more detail in the
9393
[pipefunc documentation on execution and parallelism](https://pipefunc.readthedocs.io/en/latest/concepts/execution-and-parallelism/).
9494

95-
## omp4py (OpenMP for Python)
95+
## omp4py
9696
The [thread based parallelism](https://executorlib.readthedocs.io/en/latest/1-single-node.html#thread-parallel-functions)
9797
of executorlib is most commonly used to control the number of threads in linked libraries like NumPy. With
9898
[omp4py](https://omp4py.readthedocs.io) - a Python implementation of [OpenMP](https://www.openmp.org) - it is also
@@ -124,7 +124,7 @@ with SingleNodeExecutor() as exe:
124124
The `threads_per_core` parameter sets the environment variables which control the number of threads, so the requested
125125
number of cores is reserved for the threads created by omp4py inside the `calc_pi()` function.
126126

127-
## pylammpsmpi (MPI-parallel LAMMPS)
127+
## pylammpsmpi
128128
[pylammpsmpi](https://pylammpsmpi.readthedocs.io) provides a Python interface to the molecular dynamics code
129129
[LAMMPS](https://www.lammps.org) which distributes the simulation over multiple MPI ranks while the Python process
130130
itself remains serial. Internally pylammpsmpi uses an executor to start the MPI-parallel LAMMPS processes, so an

0 commit comments

Comments
 (0)