docs: doc string for _available_cores method

jonescompneurolab · Dec 16, 2024 · e1b2035 · e1b2035
1 parent 12e5e7b
commit e1b2035
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/hnn_core/gui/gui.py b/hnn_core/gui/gui.py
@@ -496,6 +496,13 @@ def __init__(self, theme_color="#802989",
 
     @staticmethod
     def _available_cores():
+        """Return the number of available cores to the process.
+
+        This is important for systems where the number of available cores is
+        partitioned such as on HPC systems. Linux and Windows can return cpu
+        affinity, which is the number of available cores. MacOS can only return
+        total system cores.
+        """
         # For macos
         if platform.system() == 'Darwin':
             return psutil.cpu_count()