Metadata-Version: 2.1
Name: cw2
Version: 2.0.0
Summary: A reengineered framework to run experiments on a computing cluster.
Home-page: https://github.com/ALRhub/cw2
Author: Maximilian Li
Author-email: maximilian.xiling.li@gmail.com
License: MIT
Keywords: scientific,experiments,distributed computing,mpi,research
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Environment :: Console
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# cw2 - ClusterWork 2

ClusterWork 2 is a pyhton framework to manage experiments using YAML config files. It also enables users to easily deploy multiple experiments using different configurations on computing clusters, which support the [slurm workload manager](https://slurm.schedmd.com/documentation.html).

## Installation
`pip install cw2`

## Quickstart
Please refer to the [Quickstart Guide](doc/01_quickstart.md).

## Program Execution
To start an experiment locally, e.g. for testing:
```bash
python3 YOUR_MAIN.py YOUR_CONFIG.yml
```

To start an experiment on a slurm cluster:
```bash
python3 YOUR_MAIN.py YOUR_CONFIG.yml -s
```

