updated the name of input files to "barrier3d-default"

barrier3d/barrier3d.py

@@ -915,12 +915,12 @@ def __init__(self, **kwds):
         self._time_index = 1
 
     @classmethod
-    def from_path(cls, path_to_folder, fmt="yaml"):
-        return cls(**load_inputs(path_to_folder, prefix="barrier3d", fmt=fmt))
+    def from_path(cls, path_to_folder, prefix="barrier3d", fmt="yaml"):
+        return cls(**load_inputs(path_to_folder, prefix=prefix, fmt=fmt))
 
     @classmethod
-    def from_xlsx(cls, path_to_xlsx):
-        return cls(**load_inputs(path_to_xlsx, prefix="barrier3d", fmt="xlsx"))
+    def from_xlsx(cls, path_to_xlsx, prefix="barrier3d"):
+        return cls(**load_inputs(path_to_xlsx, prefix=prefix, fmt="xlsx"))
 
     @classmethod
     def from_yaml(cls, path_to_yaml, prefix="barrier3d"):

barrier3d/bmi.py

@@ -32,9 +32,9 @@ def initialize(self, config_file):
         parameter_file_prefix = config_file.replace("-parameters.yaml", "")
         parameter_file_prefix = parameter_file_prefix.split("/").pop()
 
-        # if filepath.name != "barrier3d-parameters.yaml":  # IR 15Mar22: commented out to allow for prefixes in input parameter file name for batch simulations
+        # if filepath.name != "barrier3d-default-parameters.yaml":  # IR 15Mar22: commented out to allow for prefixes in input parameter file name for batch simulations
         #     raise ValueError(
-        #         "barrier3d parameter file must be named barrier3d-parameters.yaml"
+        #         "barrier3d parameter file must be named barrier3d-default-parameters.yaml"
         #     )
 
         # self._model = Barrier3d.from_path(filepath.parent, prefix=prefix, fmt="yaml")

barrier3d/cli.py

@@ -19,7 +19,7 @@
 
 def csv_contents(infile):
     datadir = pathlib.Path(pkg_resources.resource_filename("barrier3d", "data"))
-    with open(datadir / f"barrier3d-{infile}.csv") as fp:
+    with open(datadir / f"barrier3d-default-{infile}.csv") as fp:
         return fp.read()
 
 
@@ -158,11 +158,11 @@ def show(infile: str) -> None:
 def setup() -> None:
     """Setup a folder of input files for a simulation."""
     files = {
-        "parameters": pathlib.Path("barrier3d-parameters.yaml"),
-        "elevations": pathlib.Path("barrier3d-elevations.csv"),
-        "dunes": pathlib.Path("barrier3d-dunes.csv"),
-        "growthparam": pathlib.Path("barrier3d-growthparam.csv"),
-        "storms": pathlib.Path("barrier3d-storms.csv"),
+        "parameters": pathlib.Path("barrier3d-default-parameters.yaml"),
+        "elevations": pathlib.Path("barrier3d-default-elevations.csv"),
+        "dunes": pathlib.Path("barrier3d-default-dunes.csv"),
+        "growthparam": pathlib.Path("barrier3d-default-growthparam.csv"),
+        "storms": pathlib.Path("barrier3d-default-storms.csv"),
     }
 
     existing_files = [name for name in files.values() if name.exists()]

barrier3d/configuration.py

@@ -17,19 +17,19 @@
 class Barrier3dConfiguration(Configuration):
     elevation_file = Field(
         "elevation_file",
-        default="barrier3d-elevations.npy",
+        default="barrier3d-default-elevations.npy",
         description="File that contains initial elevations in [m MHH]",
         validators=[Path(file_okay=True, dir_okay=False)],
     )
     dune_file = Field(
         "dune_file",
-        default="barrier3d-dunes.npy",
+        default="barrier3d-default-dunes.npy",
         description="File that contains initial dune height values [m]",
         validators=[Path(file_okay=True, dir_okay=False)],
     )
     growth_param_file = Field(
         "growth_param_file",
-        default="barrier3d-growthparam.npy",
+        default="barrier3d-default-growthparam.npy",
         description="File that contains initial growth parameters",
         validators=[Path(file_okay=True, dir_okay=False)],
     )

barrier3d/load_input.py

@@ -17,7 +17,7 @@ def as_cwd(path):
     os.chdir(prev_cwd)
 
 
-def load_inputs(path_to_folder, prefix="barrier3d", fmt="yaml"):
+def load_inputs(path_to_folder, prefix="barrier3d-default", fmt="yaml"):
     """Load input parameter and elevation data for Barrier3d.
 
     Parameters

scripts/plot_BMI_vs_V1.py

@@ -19,7 +19,7 @@
 # Version 2.0 ------------------------------
 # create an instance of the new BMI class, which is the model
 barrier3d = Barrier3dBmi()
-input_file = "barrier3d-parameters.yaml"
+input_file = "barrier3d-default-parameters.yaml"
 barrier3d.initialize(datadir_V2 + input_file)
 
 # increase time step

scripts/runB3D_BMI.py

@@ -14,7 +14,7 @@
 
 # specify data directory with initial conditions
 datadir = "tests/test_params/"
-input_file = "barrier3d-parameters.yaml"
+input_file = "barrier3d-default-parameters.yaml"
 barrier3d.initialize(datadir + input_file)
 
 # increase time step

tests/test_params.py

@@ -14,7 +14,7 @@ def test_parameters_to_expected(datadir):
         expected = dict(
             [(k, v) for k, v in mod.__dict__.items() if not k.startswith("_")]
         )
-        actual = load_inputs(datadir, prefix="barrier3d", fmt="yaml")
+        actual = load_inputs(datadir, prefix="barrier3d-default", fmt="yaml")
 
     for key in actual:
         assert key in expected
@@ -26,8 +26,8 @@ def test_parameters_to_expected(datadir):
 
 
 def test_barrier3d_configuration(datadir):
-    expected = load_inputs(datadir, prefix="barrier3d", fmt="py")
-    actual = load_inputs(datadir, prefix="barrier3d", fmt="yaml")
+    expected = load_inputs(datadir, prefix="barrier3d-default", fmt="py")
+    actual = load_inputs(datadir, prefix="barrier3d-default", fmt="yaml")
 
     assert set(actual.keys()) - set(expected.keys()) == set(), "found extra keys"
     assert set(expected.keys()) - set(actual.keys()) == set(), "missing keys"
@@ -51,7 +51,7 @@ def test_barrier3d_configuration(datadir):
 
 def test_bad_input_format(datadir):
     with pytest.raises(ValueError):
-        load_inputs(datadir, prefix="barrier3d", fmt="xlsx")
+        load_inputs(datadir, prefix="barrier3d-default", fmt="xlsx")
 
 
 @pytest.mark.parametrize("fmt", ["yaml", "py"])
@@ -67,18 +67,18 @@ def test_missing_folder(datadir):
 
 @pytest.mark.parametrize("fmt", ["yaml", "py"])
 def test_barrier3d_init(datadir, fmt):
-    params = load_inputs(datadir, prefix="barrier3d", fmt=fmt)
+    params = load_inputs(datadir, prefix="barrier3d-default", fmt=fmt)
     barrier3d = Barrier3d(**params)
     assert isinstance(barrier3d, Barrier3d)
 
 
 @pytest.mark.parametrize("fmt", ["yaml", "py"])
 def test_barrier3d_from_path(datadir, fmt):
-    barrier3d = Barrier3d.from_path(datadir, fmt=fmt)
+    barrier3d = Barrier3d.from_path(datadir, prefix="barrier3d-default", fmt=fmt)
     assert isinstance(barrier3d, Barrier3d)
 
 
 @pytest.mark.parametrize("fmt", ["yaml", "py"])
 def test_barrier3d_update(datadir, fmt):
-    barrier3d = Barrier3d.from_path(datadir, fmt=fmt)
+    barrier3d = Barrier3d.from_path(datadir, prefix="barrier3d-default", fmt=fmt)
     barrier3d.update()

tests/test_params/barrier3d-parameters.py → tests/test_params/barrier3d-default-parameters.py

@@ -1,9 +1,9 @@
-elevation_file = "InitElevHog.npy"  # File that contains initial elevations
-dune_file = "DuneStart_1000dam.npy"  # File that contains initial dune values
+elevation_file = "barrier3d-default-elevations.npy"  # File that contains initial elevations
+dune_file = "barrier3d-default-dunes.npy"  # File that contains initial dune values
 growth_param_file = (
-    "growthparam_1000dam.npy"  # File that contains initial growth parameters
+    "barrier3d-default-growthparam.npy"  # File that contains initial growth parameters
 )
-storm_file = "StormTimeSeries_1000yr.npy"  # File that contains storm data
+storm_file = "barrier3d-default-storms.npy"  # File that contains storm data
 TMAX = 51  # [y] Duration of simulation
 StormStart = 2  # [y] Year when storm can start occurring (NOTE: if changed, need new storm time series)
 BarrierLength = 500.0  # [m] Static length (alongshore) of island segment

tests/test_params/barrier3d-parameters.yaml → tests/test_params/barrier3d-default-parameters.yaml

@@ -1,7 +1,7 @@
-elevation_file: "InitElevHog.npy" # File that contains initial elevations [m MHW]
-dune_file: "DuneStart_1000dam.npy"  # File that contains initial dune height values [m]
-growth_param_file: "growthparam_1000dam.npy" # File that contains initial growth parameters
-storm_file: "StormTimeSeries_1000yr.npy" # File that contains storm data
+elevation_file: "barrier3d-default-elevations.npy" # File that contains initial elevations [m MHW]
+dune_file: "barrier3d-default-dunes.npy"  # File that contains initial dune height values [m]
+growth_param_file: "barrier3d-default-growthparam.npy" # File that contains initial growth parameters
+storm_file: "barrier3d-default-storms.npy" # File that contains storm data
 TMAX: 51                        # [y] Duration of simulation
 StormStart: 2                   # [y] Year when storm can start occurring (NOTE: if changed, need new storm time series)
 BarrierLength: 500.0            # [m] Static length (alongshore) of island segment

tests/test_versions.py

@@ -27,7 +27,7 @@ def test_BMI_against_V1(datadir):
     # Version 2.0 and beyond (contains a BMI) ------------------------------
     # NOTE: putting this in a separate function also didn't work (b/c of pytest usage of datadir)
     barrier3d = Barrier3dBmi()
-    barrier3d.initialize(str(datadir) + "/barrier3d-parameters.yaml")
+    barrier3d.initialize(str(datadir) + "/barrier3d-default-parameters.yaml")
 
     # increase time step
     for time_step in range(1, barrier3d._model._TMAX):