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::
$ 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::
$ 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
`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.
License
^^^^^^^
MIT License
Copyright (c) 2024 Mira Geoscience
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Third Party Software
^^^^^^^^^^^^^^^^^^^^
The param-sweeps Software may provide links to third party libraries or code (collectively "Third Party Software")
to implement various functions. Third Party Software does not comprise part of the Software.
The use of Third Party Software is governed by the terms of such software license(s).
Third Party Software notices and/or additional terms and conditions are located in the
`THIRD_PARTY_SOFTWARE.rst`_ file.
.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst
Copyright
^^^^^^^^^
Copyright (c) 2024 Mira Geoscience Ltd.
Raw data
{
"_id": null,
"home_page": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"name": "param-sweeps",
"maintainer": "Benjamin Kary",
"docs_url": null,
"requires_python": "<3.11,>=3.9",
"maintainer_email": "benjamink@mirageoscience.com",
"keywords": "geology, geophysics, earth sciences",
"author": "Mira Geoscience",
"author_email": "support@mirageoscience.com",
"download_url": "https://files.pythonhosted.org/packages/90/32/2901d1319f993bd6b56a766b1975eb732524e512ed60af361019a7d3e1b2/param_sweeps-0.1.8.tar.gz",
"platform": null,
"description": "Param-sweeps\n============\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\nBasic Usage\n^^^^^^^^^^^\n\nTo generate a sweep file from a ui.json file for an existing\napplication, use the following command::\n\n $ python -m param_sweeps.generate some_file.ui.json\n\nThis will create a new `some_file_sweep.ui.json` file that may be run\nwith::\n\n $ python -m param_sweeps.driver some_file_sweep.ui.json\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\n`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\nLicense\n^^^^^^^\nMIT License\n\nCopyright (c) 2024 Mira Geoscience\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n\nThird Party Software\n^^^^^^^^^^^^^^^^^^^^\nThe param-sweeps Software may provide links to third party libraries or code (collectively \"Third Party Software\")\nto implement various functions. Third Party Software does not comprise part of the Software.\nThe use of Third Party Software is governed by the terms of such software license(s).\nThird Party Software notices and/or additional terms and conditions are located in the\n`THIRD_PARTY_SOFTWARE.rst`_ file.\n\n.. _THIRD_PARTY_SOFTWARE.rst: THIRD_PARTY_SOFTWARE.rst\n\n\nCopyright\n^^^^^^^^^\nCopyright (c) 2024 Mira Geoscience Ltd.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Parameter sweeper for ui.json powered applications",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://www.mirageoscience.com/mining-industry-software/python-integration/",
"Repository": "https://github.com/MiraGeoscience/param-sweeps"
},
"split_keywords": [
"geology",
" geophysics",
" earth sciences"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af49c1809e182870df6216260fb9b42ad08745c93eba7bfe8f6d93ac7b00fcec",
"md5": "b4fbae73ea87a7b258f884ad47e19181",
"sha256": "ea43e35f1e88933352adb193a5adf49b71188891dfb6224589cfa88b4422d5d7"
},
"downloads": -1,
"filename": "param_sweeps-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4fbae73ea87a7b258f884ad47e19181",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.9",
"size": 11920,
"upload_time": "2024-07-29T22:35:38",
"upload_time_iso_8601": "2024-07-29T22:35:38.485465Z",
"url": "https://files.pythonhosted.org/packages/af/49/c1809e182870df6216260fb9b42ad08745c93eba7bfe8f6d93ac7b00fcec/param_sweeps-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90322901d1319f993bd6b56a766b1975eb732524e512ed60af361019a7d3e1b2",
"md5": "c511800c605cbd532ed35e20c6a37135",
"sha256": "8e07432a610866b92b7e49f67c845647adfd588899c29792577120dec8b56473"
},
"downloads": -1,
"filename": "param_sweeps-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "c511800c605cbd532ed35e20c6a37135",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.9",
"size": 7441,
"upload_time": "2024-07-29T22:35:39",
"upload_time_iso_8601": "2024-07-29T22:35:39.586967Z",
"url": "https://files.pythonhosted.org/packages/90/32/2901d1319f993bd6b56a766b1975eb732524e512ed60af361019a7d3e1b2/param_sweeps-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 22:35:39",
"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
