flood-adapt 1.1.0__tar.gz → 1.1.1__tar.gz

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: flood-adapt
-Version: 1.1.0
+Version: 1.1.1
 Summary: A software package support system which can be used to assess the benefits and costs of flood resilience measures
 Author-email: Gundula Winter <Gundula.Winter@deltares.nl>, Panos Athanasiou <Panos.Athanasiou@deltares.nl>, Frederique de Groen <Frederique.deGroen@deltares.nl>, Tim de Wilde <Tim.deWilde@deltares.nl>, Julian Hofer <Julian.Hofer@deltares.nl>, Daley Adrichem <Daley.Adrichem@deltares.nl>, Luuk Blom <Luuk.Blom@deltares.nl>
 License: ====================================================
@@ -705,21 +705,21 @@ Project-URL: Source, https://github.com/Deltares-research/FloodAdapt
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
 Classifier: Topic :: Scientific/Engineering :: Hydrology
-Requires-Python: <3.13,>=3.8
+Requires-Python: <3.13,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: cht-cyclones==1.0.3
-Requires-Dist: cht-meteo==0.3.1
-Requires-Dist: cht-observations==0.2.1
-Requires-Dist: cht-tide==0.1.1
+Requires-Dist: cht-cyclones<2.0,>=1.0.3
+Requires-Dist: cht-meteo<1.0,>=0.3.1
+Requires-Dist: cht-observations<1.0,>=0.2.1
+Requires-Dist: cht-tide<1.0,>=0.1.1
 Requires-Dist: dask==2024.11.2
 Requires-Dist: numba_celltree==0.2.2
 Requires-Dist: fiat-toolbox<0.2.0,>=0.1.22
 Requires-Dist: fiona<2.0,>=1.0
 Requires-Dist: geojson<4.0,>=3.0
 Requires-Dist: geopandas<2.0,>=1.0
-Requires-Dist: hydromt-fiat==0.5.5
-Requires-Dist: hydromt-sfincs==1.2.0
+Requires-Dist: hydromt-fiat<1.0,>=0.5.9
+Requires-Dist: hydromt-sfincs<2.0,>=1.2.0
 Requires-Dist: numpy<2.0,>=1.0
 Requires-Dist: numpy-financial<2.0,>=1.0
 Requires-Dist: pandas<3.0,>=2.0
@@ -755,8 +755,6 @@ Requires-Dist: python-dotenv<2.0,>=1.0; extra == "docs"
 Requires-Dist: folium<1.0,>=0.19.0; extra == "docs"
 Requires-Dist: mapclassify<3.0,>=2.8.0; extra == "docs"
 Requires-Dist: contextily; extra == "docs"
-Provides-Extra: all
-Requires-Dist: flood-adapt[build,dev,docs]; extra == "all"
 
 # FloodAdapt
 FloodAdapt is a decision-support tool that seeks to advance and accelerate flooding-related adaptation planning. It brings rapid, physics-based compound flood and detailed impact modelling into an easy-to-use system, allowing non-expert end-users to evaluate a wide variety of compound events, future conditions, and adaptation options in minutes.  FloodAdapt serves as a connector between scientific advances and practitioner needs, improving and increasing the uptake and impact of adaptation research and development.
@@ -774,117 +772,6 @@ Recent developments of the decision-support system include (1) simplifying and p
 
 FloodAdapt is currently in an intensive development stage. Independent usage of the repository will be challenging prior to end-of-year 2024. FloodAdapt documentation will be expanded on throughout 2024.
 
-# Installation
+# Getting Started
 
-## Setting up Pixi
-To build the environment, manage dependencies and run tasks, FloodAdapt uses [Pixi](https://pixi.sh/latest/), please download and install it by following the instructions on the pixi website.
-
-Before continuing the installation process, make sure you have access to all required private repositories by ensuring you are in the Teams `FloodAdaptUsers` in the [Deltares](https://github.com/orgs/Deltares/teams/floodadaptusers) and [Deltares-research](https://github.com/orgs/Deltares-research/teams/floodadaptusers) organizations.
-
-## Windows
-Then run these commands to install FloodAdapt:
-```bash
-git clone https://github.com/Deltares-research/FloodAdapt.git
-cd FloodAdapt
-pixi install
-```
-## Linux
-Linux is not supported at the moment, but will be supported in the near future.
-
-## Configure database
-
-#### TODO add section for the DatabaseBuilder.
-
-FloodAdapt uses a database to store, handle and organize input files, output files and static data. This database needs to be configured the first time you want to use FloodAdapt. Which is done via `flood_adapt/misc/config.py` which contains the `Settings` class to set and validate environment variables, specific to your system.
-
-To initialize FloodAdapt and configure the database, add the following lines to the top of your script / initialize function to validate and set the environment variables:
-```python
-from pathlib import Path
-from flood_adapt import Settings
-
-# Usually ends in `Database` and can contain multiple sites
-root = Path("path/to/your/database/root")
-
-# Specifies which site to use
-name = "database_name"
-
-# Define the paths to the model kernel binaries
-sfincs_bin = Path("path/to/your/sfincs/bin.exe")
-fiat_bin = Path("path/to/your/fiat/bin.exe")
-
-# Validate and set environment variables
-Settings(
-    DATABASE_ROOT=root,
-    DATABASE_NAME=name,
-    SFINCS_BIN_PATH=sfincs_bin,
-    FIAT_BIN_PATH=fiat_path,
-    VALIDATE_BINARIES=True,
-)
-```
-
-## Developing FloodAdapt
-
-To contribute to FloodAdapt, you will need to install additional dependencies. To do so, clone the repository and install the development environment:
-
-```bash
-# Install dev environment
-git clone https://github.com/Deltares/FloodAdapt
-cd FloodAdapt
-
-# This will install the required environment and run the tests to verify
-pixi run tests
-```
-
-Alternatively, you can open an interactive shell and have pixi take care of activating and updating your environment.
-```bash
-# `activate` the dev environment
-pixi shell -e dev
-
-# Develop
-pytest tests/test_x/test_y/test_z.py
-python scripts/my_script.py
-...
-```
-
-### Adding editable installations to your environment
-
-To make developing easier and not have to reinstall packages after every change, editable installs exist.
-Pixi supports editable installs, but not in the most intuitive way, as they need to be defined as editable in the project specification.
-
-Example command to add the package `example_package` as an editable install to the default environment:
-- go to the non-pixi sections in `pyproject.toml` and comment out the `example_package`. (`[dependencies]` or `[optional-dependencies]`)
-- in the pixi section `[tool.pixi.pypi-dependencies]`: add the following line `example_package = {path = "./path/to/example_package", editable = true }`. Note that this path is relative to the root of this project.
-- run `pixi update`
-
-## Useful pixi commands
-```bash
-# Display all pixi commands and options
-pixi -h
-
-# Install a non default pixi environment defined in pyproject.toml
-pixi install -e [ENV_NAME]
-
-# Update environment(s) to the latest allowed by dependency specifications in pyproject.toml
-pixi update
-
-# List all available tasks
-pixi task list
-
-# Run a task in the default environment for that task
-pixi run [TASK]
-
-# Start a shell in the pixi environment
-pixi shell -e [ENV_NAME]
-
-# Add a package to the dependencies
-pixi add [PACKAGE]
-
-# Run a task in a specific environment
-pixi run -e [ENV_NAME] [TASK]
-```
-
-### Generating the documentation
-
-We use `quartodoc` to generate our API documentation automatically. If you have the `docs` optional dependency group installed.
-you can do this by running `quartodoc build` from the `docs` directory, and it will create the documentation for you.
-After this is done, if you wish, you can build and view the documentation locally by running `quarto preview` from the `docs` directory
+Please review our [`developer guide`](DEVELOPER_GUIDE.md) for information on how to install and use FloodAdapt locally.

flood_adapt-1.1.1/README.md

@@ -0,0 +1,19 @@
+# FloodAdapt
+FloodAdapt is a decision-support tool that seeks to advance and accelerate flooding-related adaptation planning. It brings rapid, physics-based compound flood and detailed impact modelling into an easy-to-use system, allowing non-expert end-users to evaluate a wide variety of compound events, future conditions, and adaptation options in minutes.  FloodAdapt serves as a connector between scientific advances and practitioner needs, improving and increasing the uptake and impact of adaptation research and development.
+
+To make decisions on flood adaptation, communities need to understand how climate and socio-economic changes will affect flood risk and the risk-reduction potential of various adaptation options. This type of information is usually costly to acquire, and models are often too slow and labor-intensive to evaluate all the scenarios required to understand the impacts and effectiveness of potential adaptation decisions. FloodAdapt addresses this by making rapid, physics-based compound flood modeling and detailed impact modeling accessible to non-expert end-users, allowing them to evaluate a wide variety of compound events, future conditions, and adaptation options in minutes.
+
+FloodAdapt was developed as a rapid planning tool with a straightforward graphical user interface for scenario generation, simulation, and visualization of spatial flooding and flooding impacts. Decision-making needs at the community level were central to the design of FloodAdapt. Users can answer planning questions like: “How will potential adaptation options reduce flood impacts?”, “How will those options perform for different types of events, like hurricanes, king tides, or heavy rainfall?”, “Which neighborhoods will benefit most?”, “How will those options hold up in the future?”
+
+Users specify what-if scenarios composed of historic or synthetic weather events, climate or socio-economic future projections, and adaptation measures.
+The backend of FloodAdapt leverages the open-source, state-of-the-art process-based compound flood model SFINCS (https://github.com/Deltares/SFINCS) that can accurately predict compound flooding due to surge, rainfall, and river discharge, at a fraction of the computation time typically required by physics-based models. The damage model included in FloodAdapt is the Deltares-developed flood impact assessment tool Delft-FIAT (https://github.com/Deltares/Delft-FIAT). It calculates the flood damages to individual buildings and roads, and – when social vulnerability data is available – aggregates these damages over vulnerability classes.
+
+FloodAdapt can greatly support adaptation planning by allowing users to explore many scenarios. It can be used to evaluate flooding and impacts due to compound weather events, like hurricanes, king tides, and rainfall events. Users can evaluate flooding, impacts, and risk considering user-specified projections of sea level rise, precipitation increase, storm frequency increase, population growth, and economic growth. Users can also test out adaptation options, like sea walls, levees, pumps, home elevations, buyouts and floodproofing.
+
+Recent developments of the decision-support system include (1) simplifying and partially automating the setup of the SFINCS and Delft-FIAT models, (2) improving the user experience, (3) better supporting adaptation planning with improvements like metrics tables, infographics, better visualizations in the user interface, adding in additional adaptation options to evaluate, and calculating benefits of adaptation options, and (4) incorporating social vulnerability and equity into the evaluation of adaptation options to support equitable adaptation planning.
+
+FloodAdapt is currently in an intensive development stage. Independent usage of the repository will be challenging prior to end-of-year 2024. FloodAdapt documentation will be expanded on throughout 2024.
+
+# Getting Started
+
+Please review our [`developer guide`](DEVELOPER_GUIDE.md) for information on how to install and use FloodAdapt locally.

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/__init__.py

@@ -1,5 +1,5 @@
 # has to be here at the start to avoid circular imports
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 
 from flood_adapt import adapter, database_builder, dbs_classes, objects
 from flood_adapt.config.config import Settings

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/adapter/fiat_adapter.py

@@ -106,7 +106,7 @@ class FiatAdapter(IImpactAdapter):
         self.config_base_path = config_base_path
         self.exe_path = exe_path
         self.delete_crashed_runs = delete_crashed_runs
-        self._model_root = str(model_root.resolve())
+        self._model_root = model_root.resolve().as_posix()
         self.fiat_columns = _FIAT_COLUMNS
         self.impact_columns = _IMPACT_COLUMNS  # columns of FA impact output
 
@@ -135,7 +135,7 @@ class FiatAdapter(IImpactAdapter):
     def read(self, path: Path) -> None:
         """Read the fiat model from the current model root."""
         if Path(self.model.root).resolve() != Path(path).resolve():
-            self.model.set_root(root=str(path), mode="r")
+            self.model.set_root(root=path.as_posix(), mode="r")
         self.model.read()
 
     def write(self, path_out: Union[str, os.PathLike], overwrite: bool = True) -> None:
@@ -148,7 +148,7 @@ class FiatAdapter(IImpactAdapter):
 
         write_mode = "w+" if overwrite else "w"
         with cd(path_out):
-            self.model.set_root(root=str(path_out), mode=write_mode)
+            self.model.set_root(root=path_out.as_posix(), mode=write_mode)
             self.model.write()
 
     def close_files(self):
@@ -717,8 +717,8 @@ class FiatAdapter(IImpactAdapter):
         conversion_factor = wl_current_units.convert(self.model.exposure.unit)
 
         self.model.setup_hazard(
-            map_fn=map_fn,
-            map_type=map_type,
+            map_fn=[Path(p).as_posix() for p in map_fn],
+            map_type=map_type.value,
             rp=None,
             crs=None,  # change this in new version (maybe to str(floodmap.crs.split(':')[1]))
             nodata=-999,  # change this in new version
@@ -1160,7 +1160,7 @@ class FiatAdapter(IImpactAdapter):
                 object_dir=ObjectDir.measure,
                 obj_name=measure.name,
                 path=measure.polygon_file,
-            )
+            ).as_posix()
         else:
             polygon_file = None
 
@@ -1171,7 +1171,7 @@ class FiatAdapter(IImpactAdapter):
             non_building_names=self.config.non_building_names,
             aggregation=measure.aggregation_area_type,
             aggregation_area_name=measure.aggregation_area_name,
-            polygon_file=str(polygon_file),
+            polygon_file=polygon_file,
         )
 
         return ids

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/adapter/sfincs_adapter.py

@@ -121,7 +121,7 @@ class SfincsAdapter(IHazardAdapter):
         self.settings = self.database.site.sfincs
         self.units = self.database.site.gui.units
         self._model = HydromtSfincsModel(
-            root=str(model_root.resolve()),
+            root=model_root.resolve().as_posix(),
             mode="r",
             logger=self._setup_sfincs_logger(model_root),
         )
@@ -130,7 +130,7 @@ class SfincsAdapter(IHazardAdapter):
     def read(self, path: Path):
         """Read the sfincs model from the current model root."""
         if Path(self._model.root).resolve() != Path(path).resolve():
-            self._model.set_root(root=str(path), mode="r")
+            self._model.set_root(root=path.as_posix(), mode="r")
         self._model.read()
 
     def write(self, path_out: Union[str, os.PathLike], overwrite: bool = True):
@@ -147,7 +147,7 @@ class SfincsAdapter(IHazardAdapter):
 
         write_mode = "w+" if overwrite else "w"
         with cd(path_out):
-            self._model.set_root(root=str(path_out), mode=write_mode)
+            self._model.set_root(root=path_out.as_posix(), mode=write_mode)
             self._model.write()
 
     def close_files(self):
@@ -190,10 +190,16 @@ class SfincsAdapter(IHazardAdapter):
             True if the model ran successfully, False otherwise.
 
         """
+        sfincs_bin = Settings().sfincs_bin_path
+        if not sfincs_bin or not sfincs_bin.exists():
+            raise FileNotFoundError(
+                f"SFINCS binary not found at {sfincs_bin}. Please check your settings."
+            )
+
         with cd(path):
             logger.info(f"Running SFINCS in {path}")
             process = subprocess.run(
-                str(Settings().sfincs_bin_path),
+                sfincs_bin.as_posix(),
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,
                 text=True,
@@ -563,7 +569,7 @@ class SfincsAdapter(IHazardAdapter):
                 zsmax=floodmap_conversion * zsmax,
                 dep=dem_conversion * dem,
                 hmin=0.01,
-                floodmap_fn=str(floodmap_fn),
+                floodmap_fn=floodmap_fn.as_posix(),
             )
 
     def write_water_level_map(
@@ -803,7 +809,7 @@ class SfincsAdapter(IHazardAdapter):
                     zsmax=floodmap_conversion * zsmax,
                     dep=dem_conversion * dem,
                     hmin=0.01,
-                    floodmap_fn=str(floodmap_fn),
+                    floodmap_fn=floodmap_fn.as_posix(),
                 )
 
     ######################################
@@ -1626,7 +1632,7 @@ class SfincsAdapter(IHazardAdapter):
 
         # Initialize the tropical cyclone
         tc = TropicalCyclone()
-        tc.read_track(filename=str(track_forcing.path), fmt="ddb_cyc")
+        tc.read_track(filename=track_forcing.path.as_posix(), fmt="ddb_cyc")
 
         # Alter the track of the tc if necessary
         tc = self._translate_tc_track(

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/config/hazard.py

@@ -341,7 +341,7 @@ class SlrScenariosModel(BaseModel):
         # write html to results folder
         output_loc.parent.mkdir(parents=True, exist_ok=True)
         fig.write_html(output_loc)
-        return str(output_loc)
+        return output_loc.as_posix()
 
 
 class FloodModel(BaseModel):

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/dbs_classes/database.py

@@ -192,7 +192,7 @@ class Database(IDatabase):
         if self.site.sfincs.slr_scenarios is None:
             raise ConfigError("No SLR scenarios defined in the site configuration.")
         slr = self.site.sfincs.slr_scenarios
-        slr.file = str(self.static_path / slr.file)
+        slr.file = (self.static_path / slr.file).as_posix()
         return slr
 
     def get_outputs(self) -> dict[str, Any]:
@@ -285,7 +285,7 @@ class Database(IDatabase):
             path to topobathy tiles
         """
         path = self.input_path.parent.joinpath("static", "dem", "tiles", "topobathy")
-        return str(path)
+        return path.as_posix()
 
     def get_index_path(self) -> str:
         """Return the path of the index tiles which are used to connect each water level cell with the topobathy tiles.
@@ -296,7 +296,7 @@ class Database(IDatabase):
             path to index tiles
         """
         path = self.input_path.parent.joinpath("static", "dem", "tiles", "indices")
-        return str(path)
+        return path.as_posix()
 
     def get_depth_conversion(self) -> float:
         """Return the flood depth conversion that is need in the gui to plot the flood map.

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/dbs_classes/dbs_static.py

@@ -290,9 +290,9 @@ class DbsStatic(IDbsStatic):
             raise ConfigError(
                 "No cyclone track database defined in the site configuration."
             )
-        database_file = str(
+        database_file = (
             self._database.static_path
             / "cyclone_track_database"
             / self._database.site.sfincs.cyclone_track_database.file
-        )
+        ).as_posix()
         return CycloneTrackDatabase("ibtracs", file_name=database_file)

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/flood_adapt.py

@@ -891,7 +891,7 @@ class FloodAdapt:
 
         output_path = self.database.get_flooding_path(scenario.name)
         obs_points["html"] = [
-            str(output_path.joinpath(f"{station}_timeseries.html"))
+            (output_path / f"{station}_timeseries.html").as_posix()
             for station in obs_points.name
         ]
 
@@ -967,10 +967,10 @@ class FloodAdapt:
         # Check if the file exists
         if not metrics_path.exists():
             raise FileNotFoundError(
-                f"The metrics file for scenario {name}({str(metrics_path)}) does not exist."
+                f"The metrics file for scenario {name}({metrics_path.as_posix()}) does not exist."
             )
         # Read the metrics file
-        df = MetricsFileReader(str(metrics_path)).read_metrics_from_file(
+        df = MetricsFileReader(metrics_path.as_posix()).read_metrics_from_file(
             include_long_names=True,
             include_description=True,
             include_metrics_table_selection=True,

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/misc/utils.py

@@ -4,13 +4,17 @@ from contextlib import contextmanager
 from pathlib import Path
 from typing import Union
 
+import geopandas as gpd
 from pydantic import BeforeValidator
 
+from flood_adapt.misc.log import FloodAdaptLogging
 from flood_adapt.misc.path_builder import (
     ObjectDir,
     db_path,
 )
 
+logger = FloodAdaptLogging.getLogger(__name__)
+
 
 @contextmanager
 def modified_environ(*remove, **update):
@@ -136,22 +140,37 @@ def save_file_to_database(
     if src_file == dst_file:
         return dst_file
     elif dst_file.exists():
-        if dst_file.suffix == ".shp":
-            for file in list(dst_file.parent.glob(f"{dst_file.stem}.*")):
-                os.remove(file)
-        else:
-            os.remove(dst_file)
+        match dst_file.suffix:
+            case ".shp":
+                for file in list(dst_file.parent.glob(f"{dst_file.stem}.*")):
+                    os.remove(file)
+            case _:
+                os.remove(dst_file)
 
     dst_file.parent.mkdir(parents=True, exist_ok=True)
-    if src_file.suffix == ".shp":
-        for file in list(src_file.parent.glob(f"{src_file.stem}.*")):
-            shutil.copy2(file, dst_file.parent.joinpath(file.name))
-    else:
-        shutil.copy2(src_file, dst_file)
+    match src_file.suffix:
+        case ".shp" | ".geojson" | ".gpkg":
+            write_gdf_with_global_crs(src_file, dst_file)
+        case _:
+            shutil.copy2(src_file, dst_file)
 
     return dst_file
 
 
+def write_gdf_with_global_crs(src: gpd.GeoDataFrame | Path, dst_path: Path) -> None:
+    if isinstance(src, gpd.GeoDataFrame):
+        gdf = src
+    else:
+        gdf = gpd.read_file(src)
+
+    if gdf.crs is None:
+        logger.warning(f"CRS is not defined for {src}. Assuming EPSG:4326.")
+        gdf = gdf.set_crs(epsg=4326)
+    else:
+        gdf = gdf.to_crs(epsg=4326)
+    gdf.to_file(dst_path)
+
+
 def copy_file_to_output_dir(file_path: Path, output_dir: Path) -> Path:
     output_dir = output_dir.resolve()
     if file_path == output_dir / file_path.name:

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/objects/forcing/plotting.py

@@ -161,7 +161,7 @@ def plot_discharge(
     if output_loc.exists():
         output_loc.unlink()
     fig.write_html(output_loc)
-    return str(output_loc), None
+    return output_loc.as_posix(), None
 
 
 def plot_waterlevel(
@@ -278,7 +278,7 @@ def plot_waterlevel(
     if output_loc.exists():
         output_loc.unlink()
     fig.write_html(output_loc)
-    return str(output_loc), None
+    return output_loc.as_posix(), None
 
 
 def plot_rainfall(
@@ -351,7 +351,7 @@ def plot_rainfall(
     if output_loc.exists():
         output_loc.unlink()
     fig.write_html(output_loc)
-    return str(output_loc), None
+    return output_loc.as_posix(), None
 
 
 def plot_wind(
@@ -423,4 +423,4 @@ def plot_wind(
     if output_loc.exists():
         output_loc.unlink()
     fig.write_html(output_loc)
-    return str(output_loc), None
+    return output_loc.as_posix(), None

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/objects/measures/measures.py

@@ -198,7 +198,9 @@ class Measure(Object):
         measure = cls.model_validate(toml)
 
         if measure.polygon_file:
-            measure.polygon_file = str(Path(file_path).parent / measure.polygon_file)
+            measure.polygon_file = (
+                Path(file_path).parent / measure.polygon_file
+            ).as_posix()
 
         return measure
 

{flood_adapt-1.1.0 → flood_adapt-1.1.1}/flood_adapt/workflows/benefit_runner.py

@@ -1,4 +1,5 @@
 import shutil
+from pathlib import Path
 from typing import Any
 
 import geopandas as gpd
@@ -32,7 +33,7 @@ class BenefitRunner:
         self.benefit = benefit
 
         # Get output path based on database path
-        self.results_path = self.database.benefits.output_path.joinpath(
+        self.results_path: Path = self.database.benefits.output_path.joinpath(
             self.benefit.name
         )
         self.site_info = self.database.site
@@ -71,7 +72,7 @@ class BenefitRunner:
         results_html = self.results_path.joinpath("benefits.html")
         with open(results_toml, mode="rb") as fp:
             results = tomli.load(fp)
-        results["html"] = str(results_html)
+        results["html"] = results_html.as_posix()
         self._results = results
         return results