Rename excel2dict to excel_to_dict

Author: lucaeg

src/semeio/fmudesign/__init__.py

@@ -6,14 +6,14 @@
 """
 
 from semeio.fmudesign._designsummary import summarize_design
-from semeio.fmudesign._excel2dict import excel2dict_design, inputdict_to_yaml
+from semeio.fmudesign._excel_to_dict import excel_to_dict, inputdict_to_yaml
 from semeio.fmudesign._tornado_onebyone import calc_tornadoinput
 from semeio.fmudesign.create_design import DesignMatrix
 
 __all__ = [
     "DesignMatrix",
     "calc_tornadoinput",
-    "excel2dict_design",
+    "excel_to_dict",
     "inputdict_to_yaml",
     "summarize_design",
 ]

src/semeio/fmudesign/_excel2dict.py src/semeio/fmudesign/_excel_to_dict.pysrc/semeio/fmudesign/_excel2dict.py renamed to src/semeio/fmudesign/_excel_to_dict.py

@@ -14,7 +14,7 @@
 import yaml
 
 
-def excel2dict_design(
+def excel_to_dict(
     input_filename: str,
     *,
     gen_input_sheet: str = "general_input",
@@ -62,7 +62,7 @@ def excel2dict_design(
             "Use 'rms_seeds' instead"
         )
 
-    return _excel2dict_onebyone(
+    return _excel_to_dict_onebyone(
         input_filename=input_filename,
         gen_input_sheet=gen_input_sheet,
         design_input_sheet=design_input_sheet,
@@ -165,7 +165,7 @@ def resolve_path(input_filename: str, reference: str) -> str:
     return str(Path(input_filename).parent / reference_path)
 
 
-def _excel2dict_onebyone(
+def _excel_to_dict_onebyone(
     input_filename: str | Path,
     *,
     gen_input_sheet: str,
@@ -178,7 +178,7 @@ def _excel2dict_onebyone(
         input_filename(str or path): path to excel workbook
         gen_input_sheet (str): name of general input sheet
         design_input_sheet (str): name of design input sheet
-        default_val_sheet (str): name of defaul value sheet
+        default_val_sheet (str): name of default value sheet
         sheetnames (dict): Dictionary of worksheet names to load
             information from. Supported keys: general_input, defaultvalues,
             and designinput.
@@ -535,7 +535,7 @@ def _read_scenario_sensitivity(sensgroup: pd.DataFrame) -> dict[str, Any]:
             )
         if not _has_value(row.value1):
             raise ValueError(
-                f"Parameter {row.param_name} har been input "
+                f"Parameter {row.param_name} has been input "
                 'as type "scenario" but with empty '
                 "value in value1 column "
             )

src/semeio/fmudesign/create_design.py

@@ -14,7 +14,7 @@
 
 import semeio
 from semeio.fmudesign import design_distributions as design_dist
-from semeio.fmudesign._excel2dict import _raise_if_duplicates
+from semeio.fmudesign._excel_to_dict import _raise_if_duplicates
 from semeio.fmudesign.quality_report import QualityReporter, print_corrmat
 
 

src/semeio/fmudesign/fmudesignrunner.py

@@ -9,7 +9,7 @@
 from packaging.version import Version
 
 import semeio
-from semeio.fmudesign import DesignMatrix, excel2dict_design
+from semeio.fmudesign import DesignMatrix, excel_to_dict
 
 
 def get_parser() -> ArgumentParser:
@@ -87,7 +87,7 @@ def validate_args(parser: ArgumentParser) -> None:
 
 
 def generate_design_matrix(args: Namespace) -> None:
-    input_dict = excel2dict_design(
+    input_dict = excel_to_dict(
         args.config,
         gen_input_sheet=args.general_input,
         design_input_sheet=args.designinput,

tests/fmudesign/test_create_design.py

@@ -11,8 +11,8 @@
 from scipy import stats
 
 import semeio
-from semeio.fmudesign import DesignMatrix, excel2dict_design
-from semeio.fmudesign._excel2dict import _read_defaultvalues
+from semeio.fmudesign import DesignMatrix, excel_to_dict
+from semeio.fmudesign._excel_to_dict import _read_defaultvalues
 
 TESTDATA = Path(__file__).parent / "data"
 
@@ -126,7 +126,7 @@ def gl(paramname, distname, p1, p2, p3="", p4=""):
         corr_sheet.to_excel(writer, sheet_name="corr1")
 
     # Read the file and draw samples
-    input_dict = excel2dict_design(FILENAME)
+    input_dict = excel_to_dict(FILENAME)
     design = DesignMatrix()
     design.generate(input_dict)
     assert len(design.designvalues) == NUM_SAMPLES
@@ -184,7 +184,7 @@ def test_generate_onebyone(tmpdir):
 
     inputfile = TESTDATA / "config/design_input_example1.xlsx"
 
-    input_dict = excel2dict_design(inputfile)
+    input_dict = excel_to_dict(inputfile)
 
     # Note that repeats are set to 10 in general_input sheet.
     # So, there are 10 rows for each senscase of type seed and scenario.
@@ -357,7 +357,7 @@ def test_generate_full_mc_snapshot(snapshot):
     """
     # Setup
     inputfile = TESTDATA / "config/design_input_mc_with_correls.xlsx"
-    input_dict = excel2dict_design(inputfile)
+    input_dict = excel_to_dict(inputfile)
     design = DesignMatrix()
 
     # Generate the design matrix
@@ -388,7 +388,7 @@ def test_generate_full_mc_snapshot(snapshot):
 def test_generate_full_mc(tmpdir):
     """Test generation of full monte carlo"""
     inputfile = TESTDATA / "config/design_input_mc_with_correls.xlsx"
-    input_dict = excel2dict_design(inputfile)
+    input_dict = excel_to_dict(inputfile)
 
     design = DesignMatrix()
     design.generate(input_dict)
@@ -460,7 +460,7 @@ def test_generate_full_mc(tmpdir):
 
 def test_generate_background(tmpdir):
     inputfile = TESTDATA / "config/design_input_background.xlsx"
-    input_dict = excel2dict_design(inputfile)
+    input_dict = excel_to_dict(inputfile)
     source_file = TESTDATA / "config/doe1.xlsx"
     dest_file = tmpdir.join("doe1.xlsx")
     shutil.copy2(source_file, dest_file)

tests/fmudesign/test_excel2dict.py tests/fmudesign/test_excel_to_dict.pytests/fmudesign/test_excel2dict.py renamed to tests/fmudesign/test_excel_to_dict.py

@@ -1,4 +1,4 @@
-"""Testing excel2dict"""
+"""Testing excel_to_dict"""
 
 import os
 
@@ -7,8 +7,8 @@
 import pandas as pd
 import pytest
 
-from semeio.fmudesign import excel2dict_design, inputdict_to_yaml
-from semeio.fmudesign._excel2dict import _assert_no_merged_cells, _has_value
+from semeio.fmudesign import excel_to_dict, inputdict_to_yaml
+from semeio.fmudesign._excel_to_dict import _assert_no_merged_cells, _has_value
 
 MOCK_GENERAL_INPUT = pd.DataFrame(
     data=[
@@ -25,7 +25,7 @@
 )
 
 
-def test_excel2dict_design(tmpdir, monkeypatch):
+def test_excel_to_dict(tmpdir, monkeypatch):
     """Test that we can convert an Excelfile to a dictionary"""
     monkeypatch.chdir(tmpdir)
     defaultvalues = pd.DataFrame()
@@ -40,7 +40,7 @@ def test_excel2dict_design(tmpdir, monkeypatch):
     defaultvalues.to_excel(writer, sheet_name="defaultvalues", index=False, header=None)
     writer.close()
 
-    dict_design = excel2dict_design("designinput.xlsx")
+    dict_design = excel_to_dict("designinput.xlsx")
     assert isinstance(dict_design, dict)
     assert dict_design["designtype"] == "onebyone"
     assert dict_design["distribution_seed"] is None
@@ -69,7 +69,7 @@ def test_excel2dict_design(tmpdir, monkeypatch):
     defaultvalues.to_excel(writer, sheet_name="DefaultValues", index=False, header=None)
     writer.close()
 
-    dict_design = excel2dict_design("designinput2.xlsx")
+    dict_design = excel_to_dict("designinput2.xlsx")
     assert isinstance(dict_design, dict)
     assert dict_design["sensitivities"]["rms_seed"]["senstype"] == "seed"
 
@@ -109,7 +109,7 @@ def test_duplicate_sensname_exception(tmpdir, monkeypatch):
     with pytest.raises(
         ValueError, match="Two sensitivities can not share the same sensname"
     ):
-        excel2dict_design("designinput3.xlsx")
+        excel_to_dict("designinput3.xlsx")
 
 
 def test_strip_spaces(tmpdir, monkeypatch):
@@ -142,7 +142,7 @@ def test_strip_spaces(tmpdir, monkeypatch):
     )
     writer.close()
 
-    dict_design = excel2dict_design("designinput_spaces.xlsx")
+    dict_design = excel_to_dict("designinput_spaces.xlsx")
     assert next(iter(dict_design["sensitivities"].keys())) == "rms_seed"
 
     # Check default values parameter names:
@@ -174,7 +174,7 @@ def test_mixed_senstype_exception(tmpdir, monkeypatch):
     writer.close()
 
     with pytest.raises(ValueError, match="contains more than one sensitivity type"):
-        excel2dict_design("designinput4.xlsx")
+        excel_to_dict("designinput4.xlsx")
 
 
 def test_has_value():
@@ -217,7 +217,7 @@ def test_background_sheet(tmpdir, monkeypatch):
     background.to_excel(writer, sheet_name="backgroundsheet", index=False, header=None)
     writer.close()
 
-    dict_design = excel2dict_design("designinput.xlsx")
+    dict_design = excel_to_dict("designinput.xlsx")
 
     # Assert it has been interpreted correctly from input files:
     assert dict_design["background"]["parameters"]["extraseed"] == [

tests/fmudesign/test_use_cases.py

@@ -8,7 +8,7 @@
 import pandas as pd
 import pytest
 
-from semeio.fmudesign import DesignMatrix, excel2dict_design
+from semeio.fmudesign import DesignMatrix, excel_to_dict
 
 TESTDATA = Path(__file__).parent / "data"
 TEST_FILES = list((TESTDATA / "config").glob("design_input*.xlsx"))
@@ -77,7 +77,7 @@ def test_prediction_rejection_sampled_ensemble(tmpdir, monkeypatch):
     defaultvalues.to_excel(writer, sheet_name="defaultvalues", index=False)
     writer.close()
 
-    dict_design = excel2dict_design("designinput.xlsx")
+    dict_design = excel_to_dict("designinput.xlsx")
     design = DesignMatrix()
     design.generate(dict_design)
 
@@ -149,7 +149,7 @@ def test_constant_distribution(tmpdir, monkeypatch, gen_input_sheet):
     writer.close()
 
     # Generate design matrix
-    dict_design = excel2dict_design("designinput.xlsx", gen_input_sheet="generalinput")
+    dict_design = excel_to_dict("designinput.xlsx", gen_input_sheet="generalinput")
     design = DesignMatrix()
     design.generate(dict_design)