Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs minor changes #544

Merged
merged 3 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 1 addition & 26 deletions docs/3_setup_guide/Delft_Fiat/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Setting up a Delft-FIAT model
filters:
- lightbox
lightbox: auto
jupyter: python3
---

[Delft-FIAT](https://deltares.github.io/Delft-FIAT/stable/) is the open-source flood impact model implemented in FloodAdapt. When setting up FloodAdapt in a new location, it is required to first set up a Delft-FIAT model in the project area. This is considered the 'baseline' Delft-FIAT model, which FloodAdapt users can then modify through the FloodAdapt user interface - for example, by elevating buildings. @fig-DF_concept shows the flood impact modeling concept on which Delft-FIAT is based. It relates a **hazard** (the flood waters), **exposure** (buildings or roads that might be flooded), and **vulnerability** (the propensity of assets to be damaged when flooded).
Expand Down Expand Up @@ -37,28 +36,4 @@ The **secondary occupancy type** can be optional, but will sometimes be required

**Vulnerability data** in Delft-FIAT are captured in depth-damage curves. These translate inundation depths at an asset to a fraction of total damage (@fig-damagefunction). The depth-damage curve is related to the building type (e.g. 'residential 1-story building') and the inundation depth during a flood event. Different types of assets incur different degrees of damage at varying inundation levels.

```{python}
#| echo: false
#| label: fig-damagefunction
#| fig-cap: "Example of depth-damage functions."
import numpy as np
import matplotlib.pyplot as plt
import pandas as pd
from pathlib import Path
file_path = Path.cwd()
file_path = Path(file_path.parents[1], "_static", "files", "vulnerability_curves.csv")
file_path = file_path.resolve()
data = df = pd.read_csv(file_path, comment='#')
df = pd.DataFrame({
('water depth'): data.iloc[:, 0],
('STRUCT1'): data.iloc[:, 1],
('STRUCT2'): data.iloc[:, 2],
})
labels=["example building type 1","example building type 1"]
plt.plot(df['water depth'], df['STRUCT1'])
plt.plot(df['water depth'], df['STRUCT2'])
plt.xlabel('Water depth (m)')
plt.ylabel('Fraction of maximum potential damage')
plt.legend(labels)
plt.gca().get_legend().set_title('')
```
![Example of depth-damage functions.](../../_static/images/damage_curves.png){#fig-damagefunction}
4 changes: 0 additions & 4 deletions docs/4_user_guide/user_interface.qmd

This file was deleted.

1 change: 0 additions & 1 deletion docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ website:
file: 4_user_guide/index.qmd # This contains text before sections start
contents:
- "4_user_guide/getting_started.qmd" #Moving content from the old 'installation' section into here
- "4_user_guide/user_interface.qmd" #These two don't have subsections so just have one qmd file
- "4_user_guide/site_tab.qmd"
- section: "Events"
file: "4_user_guide/events/index.qmd"
Expand Down
Binary file added docs/_static/images/damage_curves.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading