From b8267e94ad998657110b5439ce6fdc0c78651dbd Mon Sep 17 00:00:00 2001 From: Jan Janssen Date: Sat, 14 Jun 2025 16:25:32 -0600 Subject: [PATCH] [Documentation] Explain missing dependencies in more detail --- docs/trouble_shooting.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/trouble_shooting.md b/docs/trouble_shooting.md index 61179ac4..2fed0e2d 100644 --- a/docs/trouble_shooting.md +++ b/docs/trouble_shooting.md @@ -4,7 +4,8 @@ Some of the most frequent issues are covered below, for everything else do not b ## Filesystem Usage The cache of executorlib is not removed after the Python process completed. So it is the responsibility of the user to clean up the cache directory they created. This can be easily forgot, so it is important to check for remaining cache -directories from time to time and remove them. +directories from time to time and remove them. In addition, there is no guarantee for cache compatibility between +different versions, the cache is only intended for temporary use and it is not designed for long-term storage. ## Firewall Issues 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 additional dependencies. The dependencies are explained in more detail in the [installation section](https://executorlib.readthedocs.io/en/latest/installation.html). +Typical error messages related to missing dependencies are `ModuleNotFoundError` like the following: +* `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. +* `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. +* `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. + ## Python Version Executorlib supports all current Python version ranging from 3.9 to 3.13. Still some of the dependencies and especially the [flux](http://flux-framework.org) job scheduler are currently limited to Python 3.12 and below. Consequently for high