[Documentation] Add docstrings for modules (#687)

* [Documentation] Add docstrings for modules

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: jan-janssen

executorlib/__init__.py

@@ -1,3 +1,17 @@
+"""
+Up-scale python functions for high performance computing (HPC) with executorlib. The executorlib module provides five
+different executor classes, namely:
+* SingleNodeExecutor - for testing executorlib on your local workstation, before up-scaling to HPC.
+* SlurmClusterExecutor - for SLURM clusters, submitting Python functions as SLURM jobs.
+* FluxClusterExecutor - for flux-framework clusters, submitting Python functions as flux jobs.
+* SlurmJobExecutor - for distributing Python functions within a given SLRUM job.
+* FluxJobExecutor - for distributing Python functions within a given flux job or SLRUM job.
+
+In addition, the executorlib includes a BaseExecutor class to validate a given executor object is based on executorlib.
+Finally, the get_cache_data() function allows users to cache the content of their current cache directory in one
+pandas.DataFrame.
+"""
+
 from executorlib.executor.base import BaseExecutor
 from executorlib.executor.flux import (
     FluxClusterExecutor,

executorlib/api.py

@@ -1,5 +1,5 @@
 """
-External application programming interface (API) following the semantic versioning this inteface is promised to remain
+External application programming interface (API) following the semantic versioning this interface is promised to remain
 stable during minor releases and any change in the interface leads to a major version bump. External libraries should
 only use the functionality in this API in combination with the user interface defined in the root __init__.py, all other
 functionality is considered internal and might change during minor releases.

executorlib/backend/__init__.py

@@ -0,0 +1,6 @@
+"""
+Backend for executorlib, these are the executables called by executorlib to initialize the Python processes which
+receive the Python functions for execution. The backends are divided based on two criteria, once whether they are using
+the file based cache as it is employed by the FluxClusterExecutor and SlurmClusterExecutor versus the interactive
+interface and secondly whether the submitted Python function is executed MPI parallel or in serial.
+"""

executorlib/executor/__init__.py

@@ -0,0 +1,5 @@
+"""
+The executor module provides five different executor classes the user interacts with, namely: SingleNodeExecutor,
+SlurmClusterExecutor, FluxClusterExecutor, SlurmJobExecutor and FluxJobExecutor. In addition, it includes a BaseExecutor
+class to validate a given executor object is based on executorlib.
+"""

executorlib/task_scheduler/__init__.py

@@ -0,0 +1,4 @@
+"""
+The task schedulers are used inside executorlib to distribute Python functions for execution, the following task
+schedulers are available: BlockAllocationTaskScheduler, DependencyTaskScheduler, FileTaskScheduler and OneProcessTaskScheduler.
+"""