Skip to content

Commit 7589d46

Browse files
authored
[Documentation] Explain missing dependencies in more detail (#685)
1 parent 40296a1 commit 7589d46

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/trouble_shooting.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Some of the most frequent issues are covered below, for everything else do not b
44
## Filesystem Usage
55
The cache of executorlib is not removed after the Python process completed. So it is the responsibility of the user to
66
clean up the cache directory they created. This can be easily forgot, so it is important to check for remaining cache
7-
directories from time to time and remove them.
7+
directories from time to time and remove them. In addition, there is no guarantee for cache compatibility between
8+
different versions, the cache is only intended for temporary use and it is not designed for long-term storage.
89

910
## Firewall Issues
1011
MacOS comes with a rather strict firewall, which does not allow to connect to an MacOS computer using the hostname even
@@ -25,6 +26,11 @@ and the [HPC Job Executors](https://executorlib.readthedocs.io/en/latest/install
2526
additional dependencies. The dependencies are explained in more detail in the
2627
[installation section](https://executorlib.readthedocs.io/en/latest/installation.html).
2728

29+
Typical error messages related to missing dependencies are `ModuleNotFoundError` like the following:
30+
* `ModuleNotFoundError: No module named 'pysqa'` - Install [pysqa](https://pysqa.readthedocs.io/) as explained in the [HPC Cluster Executors](https://executorlib.readthedocs.io/en/latest/installation.html#hpc-cluster-executor) section of the installation.
31+
* `ModuleNotFoundError: No module named 'h5py'` - Install [h5py](https://www.h5py.org/) as explained in the [Caching](https://executorlib.readthedocs.io/en/latest/installation.html#caching) section of the installation.
32+
* `ModuleNotFoundError: No module named 'networkx'` - Install [networkx](https://networkx.org/) as explained in the [Visualisation](https://executorlib.readthedocs.io/en/latest/installation.html#visualisation) section of the installation.
33+
2834
## Python Version
2935
Executorlib supports all current Python version ranging from 3.9 to 3.13. Still some of the dependencies and especially
3036
the [flux](http://flux-framework.org) job scheduler are currently limited to Python 3.12 and below. Consequently for high

0 commit comments

Comments
 (0)