experiment-generator


Nameexperiment-generator JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryA tool to generate and manage parameter sensitivity experiments.
upload_time2025-08-13 23:47:13
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseApache-2.0
keywords experiment generator workflow access payu
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # access-experiment-generator

[![CI](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/ci.yml)
[![CD](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/cd.yml/badge.svg)](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/cd.yml)
[![Coverage Status](https://codecov.io/gh/ACCESS-NRI/access-experiment-generator/branch/main/graph/badge.svg)](https://codecov.io/gh/ACCESS-NRI/access-experiment-generator)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://opensource.org/license/apache-2-0) 
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)


# About
The main role of the ACCESS experiment generator is to streamline the creation of one or more experiment configurations from a "control" experiment setup. It reduces manual editing and ensures consistent, repeatable workflows for large ensembles. 

# Key features
1. Parameter perturbation / Configuration changes
    - Users provide a set or suite of parameter changes in a YAML input file.
    - The generator applies these changes to relevant configurations.
    - It can generate multiple experiments automatically, making it especially useful for large perturbation ensembles.

2. Branch-based storage approach
    - The generator checks out a control branch in a git repository.
    - For each perturbation, it creates a new branch containing modified parameters.
    - Changes are then committed on that branch and can be pushed back to the github repository.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "experiment-generator",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "experiment generator, workflow, access, payu",
    "author": null,
    "author_email": "Minghang Li <Minghang.Li1@anu.edu.au>",
    "download_url": "https://files.pythonhosted.org/packages/d5/f7/6615cf785f23ef7bbabd5d35f593935a1099c1279df9a5774bafbe090a82/experiment_generator-0.0.2.tar.gz",
    "platform": null,
    "description": "# access-experiment-generator\n\n[![CI](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/ci.yml)\n[![CD](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/cd.yml/badge.svg)](https://github.com/ACCESS-NRI/access-experiment-generator/actions/workflows/cd.yml)\n[![Coverage Status](https://codecov.io/gh/ACCESS-NRI/access-experiment-generator/branch/main/graph/badge.svg)](https://codecov.io/gh/ACCESS-NRI/access-experiment-generator)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://opensource.org/license/apache-2-0) \n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n\n# About\nThe main role of the ACCESS experiment generator is to streamline the creation of one or more experiment configurations from a \"control\" experiment setup. It reduces manual editing and ensures consistent, repeatable workflows for large ensembles. \n\n# Key features\n1. Parameter perturbation / Configuration changes\n    - Users provide a set or suite of parameter changes in a YAML input file.\n    - The generator applies these changes to relevant configurations.\n    - It can generate multiple experiments automatically, making it especially useful for large perturbation ensembles.\n\n2. Branch-based storage approach\n    - The generator checks out a control branch in a git repository.\n    - For each perturbation, it creates a new branch containing modified parameters.\n    - Changes are then committed on that branch and can be pushed back to the github repository.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A tool to generate and manage parameter sensitivity experiments.",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/ACCESS-NRI/access-experiment-generator"
    },
    "split_keywords": [
        "experiment generator",
        " workflow",
        " access",
        " payu"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e621483e0c3ce2adf59e380fafd79151e69fd4553d49c13ec74b961e7490c511",
                "md5": "06899a9afb1b1f55caf0bfccd68c3796",
                "sha256": "86ede16ae215109640ec240a5d9844a60806bdac9bee22d9bb34df03703266b7"
            },
            "downloads": -1,
            "filename": "experiment_generator-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06899a9afb1b1f55caf0bfccd68c3796",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 23632,
            "upload_time": "2025-08-13T23:47:12",
            "upload_time_iso_8601": "2025-08-13T23:47:12.485316Z",
            "url": "https://files.pythonhosted.org/packages/e6/21/483e0c3ce2adf59e380fafd79151e69fd4553d49c13ec74b961e7490c511/experiment_generator-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d5f76615cf785f23ef7bbabd5d35f593935a1099c1279df9a5774bafbe090a82",
                "md5": "603030cf116c75a6273d6ba9a9165ad5",
                "sha256": "53b9ac2e71ceba7c61ae0e1d1357f21ceac73aa64b83ab24d8138fa95a811d53"
            },
            "downloads": -1,
            "filename": "experiment_generator-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "603030cf116c75a6273d6ba9a9165ad5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 31645,
            "upload_time": "2025-08-13T23:47:13",
            "upload_time_iso_8601": "2025-08-13T23:47:13.836631Z",
            "url": "https://files.pythonhosted.org/packages/d5/f7/6615cf785f23ef7bbabd5d35f593935a1099c1279df9a5774bafbe090a82/experiment_generator-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-13 23:47:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ACCESS-NRI",
    "github_project": "access-experiment-generator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "experiment-generator"
}
None
Elapsed time: 2.33364s