Metadata-Version: 1.1
Name: cluster-tools
Version: 0.1
Summary: Utility library for easily distributing code execution on clusters
Home-page: https://github.com/scalableminds/cluster_tools
Author: scalableminds
Author-email: hello@scalableminds.com
License: MIT
Description: # Cluster Tools
        
        [![CircleCI](https://circleci.com/gh/scalableminds/cluster_tools/tree/master.svg?style=svg)](https://circleci.com/gh/scalableminds/cluster_tools/tree/master)
        
        This package provides python `Executor` classes for distributing tasks on a slurm cluster or via multi processing.
        
        
        ## Example
        
        ```python
        import cluster_tools
        
        def square(n):
          return n * n
        
        if __name__ == '__main__':
          strategy = "slurm"  # other valid values are "multiprocessing" and "sequential"
          with cluster_tools.get_executor(strategy) as executor:
            result = list(executor.map(square, [2, 3, 4]))
            assert result == [4, 9, 16]
        ```
        
        ## Credits
        
        Thanks to [sampsyo/clusterfutures](https://github.com/sampsyo/clusterfutures) for providing the slurm core abstraction and [giovtorres/slurm-docker-cluster](https://github.com/giovtorres/slurm-docker-cluster) for providing the slurm docker environment which we use for CI based testing.
        
Platform: ALL
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
