afspies / meinsweeper

A light-weight framework for running experiments on arbitrary compute nodes

MeinSweeper

MeinSweeper is a light-weight framework for running experiments on arbitrary compute nodes

- This is still in alpha, and was written for research
- I.e. expect bugs and smelly code!

Installation

Use the package manager pip to install MeinSweeper.

pip install meinsweeper

Usage

MeinSweeper consists of four components

Using Provided Node-types

import meinsweeper

cfg = {'target': 'ssh', ...} 

meinsweeper.run(cfg)

With Custom Nodes

Subclass and existing node

Override the initialization, running or logging behaviour of an existing node type. If you would like to establish a generic, and robust, communication class which systematically utilizes STDOUT, that would be nice!.

Create a node class

class MyNode(Node):

Specify new target as pascal_case version of class name

cfg = {'target':'my_node', ....}

meinsweeper.run(cfg)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT