# Param-sweeps
A Parameter sweeper for applications driven by ui.json files
This package contains two main modules. One is for generating sweep
files, and the other is to run a sweep over some number of parameters
in a driver application.
### Basic Usage
To generate a sweep file from a ui.json file for an existing
application, use the following command:
```bash
python -m param_sweeps.generate some_file.ui.json
```
This will create a new `some_file_sweep.ui.json` file that may be run
with:
```bash
python -m param_sweeps.driver some_file_sweep.ui.json
```
By default, this would execute a single run of the original parameters.
To design a sweep, simply drag the `some_file_sweep.ui.json` file into
the [Geoscience ANALYST Pro](https://mirageoscience.com/mining-industry-software/geoscience-analyst-pro/)
session that produced the original file and select start, end, and number
of samples values for parameters that you would like to sweep.
To organize the output, param-sweeps uses a `UUID` file naming scheme, with
a `lookup.json` file to map individual parameter sets back to their respective
files.
Raw data
{
"_id": null,
"home_page": "https://mirageoscience.com",
"name": "param-sweeps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "geology,geophysics,earth sciences",
"author": "Mira Geoscience",
"author_email": "benjamink@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/4d/0f/4c1b404114473b923a46547edaf67b889edf295fefb4c9670cb0872790fa/param_sweeps-0.1.6.tar.gz",
"platform": null,
"description": "# Param-sweeps\n\nA Parameter sweeper for applications driven by ui.json files\n\nThis package contains two main modules. One is for generating sweep\nfiles, and the other is to run a sweep over some number of parameters\nin a driver application.\n\n### Basic Usage\n\nTo generate a sweep file from a ui.json file for an existing\napplication, use the following command:\n\n```bash\npython -m param_sweeps.generate some_file.ui.json\n```\n\nThis will create a new `some_file_sweep.ui.json` file that may be run\nwith:\n\n```bash\npython -m param_sweeps.driver some_file_sweep.ui.json\n```\n\nBy default, this would execute a single run of the original parameters.\nTo design a sweep, simply drag the `some_file_sweep.ui.json` file into\nthe [Geoscience ANALYST Pro](https://mirageoscience.com/mining-industry-software/geoscience-analyst-pro/)\nsession that produced the original file and select start, end, and number\nof samples values for parameters that you would like to sweep.\n\n\nTo organize the output, param-sweeps uses a `UUID` file naming scheme, with\na `lookup.json` file to map individual parameter sets back to their respective\nfiles.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Parameter sweeper for ui.json powered applications",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://mirageoscience.com",
"Repository": "https://github.com/MiraGeoscience/param-sweeps"
},
"split_keywords": [
"geology",
"geophysics",
"earth sciences"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "085d1b1b866e01ed83e1a973da701f6ce0c9614ebdf27172a79f43e22b639717",
"md5": "66f505b0b061045cca056be7da63124c",
"sha256": "d661aeba8f1b95b78fd9ab9f7b798fdd1ea454fdf80484d789b293604b8f2452"
},
"downloads": -1,
"filename": "param_sweeps-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66f505b0b061045cca056be7da63124c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 8250,
"upload_time": "2024-01-10T23:48:28",
"upload_time_iso_8601": "2024-01-10T23:48:28.176467Z",
"url": "https://files.pythonhosted.org/packages/08/5d/1b1b866e01ed83e1a973da701f6ce0c9614ebdf27172a79f43e22b639717/param_sweeps-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d0f4c1b404114473b923a46547edaf67b889edf295fefb4c9670cb0872790fa",
"md5": "716b5b102b2124e6de678a82c198486c",
"sha256": "0cea3e285f72b7920446d7b7f3a07c7b03924db09d4af10dc5b8962b0359d961"
},
"downloads": -1,
"filename": "param_sweeps-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "716b5b102b2124e6de678a82c198486c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 6452,
"upload_time": "2024-01-10T23:48:29",
"upload_time_iso_8601": "2024-01-10T23:48:29.586829Z",
"url": "https://files.pythonhosted.org/packages/4d/0f/4c1b404114473b923a46547edaf67b889edf295fefb4c9670cb0872790fa/param_sweeps-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 23:48:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MiraGeoscience",
"github_project": "param-sweeps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "param-sweeps"
}
JSON
