cw2

Name	cw2 JSON
Version	2.5.1 JSON
	download
home_page	https://github.com/ALRhub/cw2
Summary	A reengineered framework to run experiments on a computing cluster.
upload_time	2024-02-16 11:43:43
maintainer
docs_url	None
author	Maximilian Li
requires_python	>=3
license	MIT
keywords	scientific experiments distributed computing mpi research
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # cw2 - ClusterWork 2

[![Upload Python Package](https://github.com/ALRhub/cw2/actions/workflows/python-publish.yml/badge.svg)](https://github.com/ALRhub/cw2/actions/workflows/python-publish.yml)

ClusterWork 2 is a python 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
```bash
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
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ALRhub/cw2",
    "name": "cw2",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "scientific,experiments,distributed computing,mpi,research",
    "author": "Maximilian Li",
    "author_email": "maximilian.xiling.li@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6a/b6/7e4f191496a3f9d992c2a7e6f8f393248342cff097be774e34391d37a152/cw2-2.5.1.tar.gz",
    "platform": null,
    "description": "# cw2 - ClusterWork 2\n\n[![Upload Python Package](https://github.com/ALRhub/cw2/actions/workflows/python-publish.yml/badge.svg)](https://github.com/ALRhub/cw2/actions/workflows/python-publish.yml)\n\nClusterWork 2 is a python 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).\n\n## Installation\n```bash\npip install cw2\n```\n\n## Quickstart\nPlease refer to the [Quickstart Guide](doc/01_quickstart.md).\n\n## Program Execution\nTo start an experiment locally, e.g. for testing:\n```bash\npython3 YOUR_MAIN.py YOUR_CONFIG.yml\n```\n\nTo start an experiment on a slurm cluster:\n```bash\npython3 YOUR_MAIN.py YOUR_CONFIG.yml -s\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A reengineered framework to run experiments on a computing cluster.",
    "version": "2.5.1",
    "project_urls": {
        "Homepage": "https://github.com/ALRhub/cw2"
    },
    "split_keywords": [
        "scientific",
        "experiments",
        "distributed computing",
        "mpi",
        "research"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e66275d332d8d84fb4b8ca7d4e72f9bd9f3d50684d0f3b0b17154aaad7bb770c",
                "md5": "f3fdb442f4e1360b984178ec729d1edb",
                "sha256": "6e51a0f496da4ef45856900aefc529e1024dbd596b5e4ee756e9a9b63054a629"
            },
            "downloads": -1,
            "filename": "cw2-2.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f3fdb442f4e1360b984178ec729d1edb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 35812,
            "upload_time": "2024-02-16T11:43:42",
            "upload_time_iso_8601": "2024-02-16T11:43:42.152800Z",
            "url": "https://files.pythonhosted.org/packages/e6/62/75d332d8d84fb4b8ca7d4e72f9bd9f3d50684d0f3b0b17154aaad7bb770c/cw2-2.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ab67e4f191496a3f9d992c2a7e6f8f393248342cff097be774e34391d37a152",
                "md5": "053afb9794218d20f30f5a837f84655f",
                "sha256": "c57bb8005f8a6aefab6dba4d38146c72c5c97a169c044b593d7d407053128aa4"
            },
            "downloads": -1,
            "filename": "cw2-2.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "053afb9794218d20f30f5a837f84655f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 30531,
            "upload_time": "2024-02-16T11:43:43",
            "upload_time_iso_8601": "2024-02-16T11:43:43.575737Z",
            "url": "https://files.pythonhosted.org/packages/6a/b6/7e4f191496a3f9d992c2a7e6f8f393248342cff097be774e34391d37a152/cw2-2.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-16 11:43:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ALRhub",
    "github_project": "cw2",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cw2"
}