Merge pull request #63 from MiraGeoscience/hotfix/0.1.8

GEOPY-1651: merge hotfix/0.1.8 to main 🚧

Author: sebhmg

README.md renamed to README.rst

@@ -1,30 +1,29 @@
-# Param-sweeps
+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
+
+Basic Usage
+^^^^^^^^^^^
 
 To generate a sweep file from a ui.json file for an existing
-application, use the following command:
+application, use the following command::
 
-```bash
-python -m param_sweeps.generate some_file.ui.json
-```
+    $ 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:
+with::
 
-```bash
-python -m param_sweeps.driver some_file_sweep.ui.json
-```
+    $ 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/)
+`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.
 
@@ -33,6 +32,7 @@ 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
@@ -60,10 +60,15 @@ SOFTWARE.
 
 Third Party Software
 ^^^^^^^^^^^^^^^^^^^^
-The param-sweeps Software may provide links to third party libraries or code (collectively “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.

param_sweeps/__init__.py

@@ -6,4 +6,4 @@
 #  (see LICENSE file at the root of this source code package).
 
 
-__version__ = "0.1.7"
+__version__ = "0.1.8"

param_sweeps/generate.py

@@ -33,6 +33,10 @@ def generate(
     file_path = Path(worker).resolve(strict=True)
     ifile = InputFile.read_ui_json(file_path)
     sweepfile = InputFile(ui_json=deepcopy(default_ui_json), validate=False)
+
+    if sweepfile.data is None or sweepfile.ui_json is None:
+        raise ValueError("Sweep file data is empty.")
+
     sweepfile.data.update({"worker_uijson": str(worker)})
     if update_values:
         sweepfile.data.update(**update_values)
@@ -47,10 +51,8 @@ def generate(
 
     sweepfile.data["geoh5"] = ifile.data["geoh5"]
     dirpath = file_path.parent
-    filename = file_path.name
-    filename = filename.rstrip("ui.json")
+    filename = file_path.name.removesuffix(".ui.json")
     filename = re.sub(r"\._sweep$", "", filename)
-    # filename = filename.rstrip("_sweep")
     filename = f"{filename}_sweep.ui.json"
 
     print(f"Writing sweep file to: {dirpath / filename}")

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "param-sweeps"
-version = "0.1.7"
+version = "0.1.8"
 
 description = "Parameter sweeper for ui.json powered applications"
 license = "MIT"
@@ -10,7 +10,7 @@ repository = "https://github.com/MiraGeoscience/param-sweeps"
 #documentatio  = "https://mirageoscience-param-sweeps.readthedocs-hosted.com/"
 homepage = "https://www.mirageoscience.com/mining-industry-software/python-integration/"
 
-readme = "README.md"
+readme = "README.rst"
 keywords = ["geology", "geophysics", "earth sciences"]
 classifiers = [
     "Development Status :: 4 - Beta",