Skip to content

Commit

Permalink
Docs (#389)
Browse files Browse the repository at this point in the history
* create df for aggregation

* create df for scenario aggregation

* create full scenarios EAD

* calculate aggregation zone benefits

* create dictionary of sum, in progress

* summing aggregation loop, in progress

* loop aggregation sum partially running

* aggregation sum

* update loop

* correction interpolation

* fixing loop sum aggregation

* correct benefits per zone

* aggregation sum loop working

* cleaning

* print aggregation benefit to files, still bugs

* update absolute to relative path

* update file path

* remove unneccessary files

* bugfix output duplicates

* bugfix output file name

* bugfixes

* update file path

* flexible number of aggregation zones

* create temp files

* update output name

* add code comments

* create seperate function cba, cba_aggregation

* update input variables

* add aggregation assert to test_benefits

* update aggregation.csv output name

* Move Docs Folder from FloodAdapt_Gui to FloodAdapt Repo

* add clear_notebookds.py

* Added a bunch of content in the introduction, changed the structure of the introduction (one page instead of sections), changed the order of the setup guide and installation guide, and added a couple of images to the static\images folder.

* small correction to one of the headers

* Made changes to the events

* update appearance navigation sidebar

* update theme-light.scss

* add home icon

* make copy of lookalike SFINCS docs, but create other layout for Floodadapt

* just added some dummy text for demonstration

* test (#352)

* Modified the structure: put the user guide before the setup guide, removed the installation guide and added a subsection for this under the user guide, and changed some wording of the section headings.

* move docs folder

* fix indendation

* this is a test

* Restructured a bit. Changed 'quick view' to compare, and added subsections, one for maps and one for metrics. Moved some content from the user guide index.qmd into the Getting Started file. This is still a work in progress! Just want to update quickly since so many structural changes were made and could cause conflicts. Also changed the name of the user interface general features section.

* change collapse level and title

* Finished the USER GUIDE landing page, deleted redundant text from the 'Getting Started' page, and cleaned up the structure a bit (removed scenario comparison section)

* Added a new historic events section so that each type of historic event can have its own page. That makes it easier to create linkable headings under each of the event types. Further added content to the historic event with gauged water levels.

* Made some refinements to the historical events content, and removed the historic_events.qmd that was there prior to creating a folder for the historic events (the index.qmd in that folder contains the content that was in the deleted historic_events.qmd).

* Worked on (and finished first draft) of the historic events. Added info on the general events page about how events are modelled in FloodAdapt.

* Added content to the events. Minor mods to the introduction.

* Added content to the synthetic event page

* Finished first draft of the events documentation. Some info still awaiting confirmation, and some videos still missing (to be added later).

* update style

* update sections and design

* update design appendix section

* fix appendix design

* change name hurricane.qmd

* worked on the 'getting started' page

* remove background

* change titles in _quarto.yml

* bugfix hover properties in sidebar

* change title in appendix files

* bugfix _quarto.yml

* update dark theme style sheet

* add environment for docs

* add workflow file to publish (need to move to .git folder later)

* delete quarto copy

* spelling mistakes

* add highlight color to dark theme

* update benefits file to match main

* update benefits file to match main

* update benefits to match main

* update docs workflow. Move files  to correct folders.

* Added info to getting started, historic events, and added a firewall png for the getting started section

* commet out pip install e . in docs workflow

* Added images for green infra

* update schedule to cron, remove out-commented line in docs workflow

* bugfix

* bugfix

* Worked on folder structure in getting started page

* Revert "Merge branch 'docs' of https://github.com/Deltares/FloodAdapt into docs"

This reverts commit 02c1aa3, reversing
changes made to 3a7ed10.

* change gh upload schedule

* correct branch for gh publishing

* update light theme css

* update style and docs workflow

* update order in docs.yml

* update light theme

* remove double lines

* Docs getting started (#371)

* Docs (#366)

* create df for aggregation

* create df for scenario aggregation

* create full scenarios EAD

* calculate aggregation zone benefits

* create dictionary of sum, in progress

* summing aggregation loop, in progress

* loop aggregation sum partially running

* aggregation sum

* update loop

* correction interpolation

* fixing loop sum aggregation

* correct benefits per zone

* aggregation sum loop working

* cleaning

* print aggregation benefit to files, still bugs

* update absolute to relative path

* update file path

* remove unneccessary files

* bugfix output duplicates

* bugfix output file name

* bugfixes

* update file path

* flexible number of aggregation zones

* create temp files

* update output name

* add code comments

* create seperate function cba, cba_aggregation

* update input variables

* add aggregation assert to test_benefits

* update aggregation.csv output name

* Move Docs Folder from FloodAdapt_Gui to FloodAdapt Repo

* add clear_notebookds.py

* Added a bunch of content in the introduction, changed the structure of the introduction (one page instead of sections), changed the order of the setup guide and installation guide, and added a couple of images to the static\images folder.

* small correction to one of the headers

* Made changes to the events

* update appearance navigation sidebar

* update theme-light.scss

* add home icon

* make copy of lookalike SFINCS docs, but create other layout for Floodadapt

* just added some dummy text for demonstration

* test (#352)

* Modified the structure: put the user guide before the setup guide, removed the installation guide and added a subsection for this under the user guide, and changed some wording of the section headings.

* move docs folder

* fix indendation

* this is a test

* Restructured a bit. Changed 'quick view' to compare, and added subsections, one for maps and one for metrics. Moved some content from the user guide index.qmd into the Getting Started file. This is still a work in progress! Just want to update quickly since so many structural changes were made and could cause conflicts. Also changed the name of the user interface general features section.

* change collapse level and title

* Finished the USER GUIDE landing page, deleted redundant text from the 'Getting Started' page, and cleaned up the structure a bit (removed scenario comparison section)

* Added a new historic events section so that each type of historic event can have its own page. That makes it easier to create linkable headings under each of the event types. Further added content to the historic event with gauged water levels.

* Made some refinements to the historical events content, and removed the historic_events.qmd that was there prior to creating a folder for the historic events (the index.qmd in that folder contains the content that was in the deleted historic_events.qmd).

* Worked on (and finished first draft) of the historic events. Added info on the general events page about how events are modelled in FloodAdapt.

* Added content to the events. Minor mods to the introduction.

* Added content to the synthetic event page

* Finished first draft of the events documentation. Some info still awaiting confirmation, and some videos still missing (to be added later).

* update style

* update sections and design

* update design appendix section

* fix appendix design

* change name hurricane.qmd

* worked on the 'getting started' page

* remove background

* change titles in _quarto.yml

* bugfix hover properties in sidebar

* change title in appendix files

* bugfix _quarto.yml

* update dark theme style sheet

* add environment for docs

* add workflow file to publish (need to move to .git folder later)

* delete quarto copy

* spelling mistakes

* add highlight color to dark theme

* update benefits file to match main

* update benefits file to match main

* update benefits to match main

* update docs workflow. Move files  to correct folders.

* Added info to getting started, historic events, and added a firewall png for the getting started section

* commet out pip install e . in docs workflow

* Added images for green infra

* update schedule to cron, remove out-commented line in docs workflow

* bugfix

* bugfix

* Worked on folder structure in getting started page

* Revert "Merge branch 'docs' of https://github.com/Deltares/FloodAdapt into docs"

This reverts commit 02c1aa3, reversing
changes made to 3a7ed10.

* change gh upload schedule

* correct branch for gh publishing

* update light theme css

* update style and docs workflow

* update order in docs.yml

* update light theme

* remove double lines

---------

Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>

* Added a sentence, testing commits from branch

* Reverting the config back to original

---------

Co-authored-by: Santonia27 <145111392+Santonia27@users.noreply.github.com>

* Docs structure changes (#374)

* Docs (#366)

* create df for aggregation

* create df for scenario aggregation

* create full scenarios EAD

* calculate aggregation zone benefits

* create dictionary of sum, in progress

* summing aggregation loop, in progress

* loop aggregation sum partially running

* aggregation sum

* update loop

* correction interpolation

* fixing loop sum aggregation

* correct benefits per zone

* aggregation sum loop working

* cleaning

* print aggregation benefit to files, still bugs

* update absolute to relative path

* update file path

* remove unneccessary files

* bugfix output duplicates

* bugfix output file name

* bugfixes

* update file path

* flexible number of aggregation zones

* create temp files

* update output name

* add code comments

* create seperate function cba, cba_aggregation

* update input variables

* add aggregation assert to test_benefits

* update aggregation.csv output name

* Move Docs Folder from FloodAdapt_Gui to FloodAdapt Repo

* add clear_notebookds.py

* Added a bunch of content in the introduction, changed the structure of the introduction (one page instead of sections), changed the order of the setup guide and installation guide, and added a couple of images to the static\images folder.

* small correction to one of the headers

* Made changes to the events

* update appearance navigation sidebar

* update theme-light.scss

* add home icon

* make copy of lookalike SFINCS docs, but create other layout for Floodadapt

* just added some dummy text for demonstration

* test (#352)

* Modified the structure: put the user guide before the setup guide, removed the installation guide and added a subsection for this under the user guide, and changed some wording of the section headings.

* move docs folder

* fix indendation

* this is a test

* Restructured a bit. Changed 'quick view' to compare, and added subsections, one for maps and one for metrics. Moved some content from the user guide index.qmd into the Getting Started file. This is still a work in progress! Just want to update quickly since so many structural changes were made and could cause conflicts. Also changed the name of the user interface general features section.

* change collapse level and title

* Finished the USER GUIDE landing page, deleted redundant text from the 'Getting Started' page, and cleaned up the structure a bit (removed scenario comparison section)

* Added a new historic events section so that each type of historic event can have its own page. That makes it easier to create linkable headings under each of the event types. Further added content to the historic event with gauged water levels.

* Made some refinements to the historical events content, and removed the historic_events.qmd that was there prior to creating a folder for the historic events (the index.qmd in that folder contains the content that was in the deleted historic_events.qmd).

* Worked on (and finished first draft) of the historic events. Added info on the general events page about how events are modelled in FloodAdapt.

* Added content to the events. Minor mods to the introduction.

* Added content to the synthetic event page

* Finished first draft of the events documentation. Some info still awaiting confirmation, and some videos still missing (to be added later).

* update style

* update sections and design

* update design appendix section

* fix appendix design

* change name hurricane.qmd

* worked on the 'getting started' page

* remove background

* change titles in _quarto.yml

* bugfix hover properties in sidebar

* change title in appendix files

* bugfix _quarto.yml

* update dark theme style sheet

* add environment for docs

* add workflow file to publish (need to move to .git folder later)

* delete quarto copy

* spelling mistakes

* add highlight color to dark theme

* update benefits file to match main

* update benefits file to match main

* update benefits to match main

* update docs workflow. Move files  to correct folders.

* Added info to getting started, historic events, and added a firewall png for the getting started section

* commet out pip install e . in docs workflow

* Added images for green infra

* update schedule to cron, remove out-commented line in docs workflow

* bugfix

* bugfix

* Worked on folder structure in getting started page

* Revert "Merge branch 'docs' of https://github.com/Deltares/FloodAdapt into docs"

This reverts commit 02c1aa3, reversing
changes made to 3a7ed10.

* change gh upload schedule

* correct branch for gh publishing

* update light theme css

* update style and docs workflow

* update order in docs.yml

* update light theme

* remove double lines

---------

Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>

* Added a sentence, testing commits from branch

* Reverting the config back to original

* Made changes to the structure (removed Appendix, added benefits), changed some naming, and updated the introduction and user guide landing pages accordingly. Included updated readerGuidance fig.

---------

Co-authored-by: Santonia27 <145111392+Santonia27@users.noreply.github.com>

* Restructured the projections and measures sections and put some initial text and figures in the landing pages for these. (#375)

* remove appendix folder and update style sheet (#376)

* remove appendix folder and update style sheet

* update theme

* update stylesheet

* test

* Docs projections climate (#388)

* Added information on climate projections, plus figures

* Corrected spelling mistakes

* removed the accidental config file push

---------

Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>
Co-authored-by: kathrynroscoe <79269966+kathrynroscoe@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 13, 2024
1 parent cec5df0 commit a0d1ecd
Show file tree
Hide file tree
Showing 10 changed files with 57 additions and 5 deletions.
54 changes: 50 additions & 4 deletions docs/4_user_guide/projections/climate.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,57 @@ lightbox: auto
---
This section will describe how future projections of [sea level rise](#sea-level-rise), [precipitation](#increase-precipitation) and [tropical storm frequencies](#increased-storm-frequency) are specified and implemented in FloodAdapt.

![**Climate projections in FloodAdapt: sea level rise, increased storm frequencies, precipitation changes**](../../_static/images/projections_climate.png){width=70% fig-align=left #fig-projectionsClimate}


## Sea level rise
Coming soon
There are two ways to specify sea level rise in the projections window: ***manually*** and ***from scenario***.

If you select ***manually***, you can type a number in the "Sea Level Rise" (see @fig-projectionsSLR_manual). You can then give your projection a name and (optionally) a description and click "OK" and your projection will show up in the FlodoAdapt Projections tab.

![**Manually entering a sea level rise projection**](../../_static/images/projections_SLR_manual.png){width=70% fig-align=left #fig-projectionsSLR_manual}

If you select ***from scenario***, a dropdown box will appear from which you can select the sea level rise scenario you want to use (see @fig-projectionsSLR). These options are configurable and are specified at system setup. Once you select a scenario, you specify a year and FloodAdapt will automatically calculate the sea level rise for that year, using the selected sea level rise scenario. You can then give your projection a name and (optionally) a description and click "OK" and your projection will show up in the FlodoAdapt Projections tab.

![**Using a sea level rise scenario and a year to enter a sea level rise projection**](../../_static/images/projections_SLR.png){width=70% fig-align=left #fig-projectionsSLR}

::: {.callout-note}
## Sea level rise - since when?
Sea level rise scenarios have a starting point where sea level rise is zero (often, but not necessarily, starting at the year 2000). FloodAdapt corrects for this, using the 'current year', which is specified at system setup. So when a user chooses the "from scenario" option to input a sea level rise projection for a future year, the sea level rise that is shown in the projections window is relative to the current year. This is done by subtracting the projected rise between the starting point and the current year, for each sea level rise scenario.
:::

::: {.callout-note}
## How is the sea level rise projection represented in the modeling?
When a user runs a scenario with a sea level rise projection, the sea level rise is added to the flood model's coastal boundary condition. FloodAdapt treats this addition differently depending on the type of event. For a [recent event using gauged water levels](../events/historic_events/historic_events_gauged.qmd), the sea level rise in the current year relative to mean sea level is already represented in the measured water levels, so only the relative rise between the current year and future year is added. For a [recent event without gauged water levels](../events/historic_events/historic_events_ungauged.qmd) and for a [historical hurricane](../events/historic_events/historic_events_hurricane.qmd), the offshore model calculates the nearshore coastal water levels relative to mean sea level. To correct for the sea level rise in the current year relative to mean sea level, an 'offset' is added which is specified at system set-up. On top of this, the relative sea level rise between the current year and the future year is added to represent the future conditions.
:::

## Increase precipitation
Coming soon
## Increased precipitation
An increase in precipitation is given as a percentage in the projections window (see @fig-projectionsPrecip). You can give the projection a name and (optionally) a description and click "OK" and the projection will be added in the projections tab.

### Why is this only for probabilistic event sets?
In the projection window, you see an indication that increased precipitation is for probabilistic events only. This is because for a single event, a user can explore a 'what-if' scenario about increased rainfall by adjusting the rainfall when they define an event (with the precipitation magnifier for a [historical event](../events/historic_events/historic_events_gauged.qmd#rainfall-magnifier-with-the-timeseries-and-map-options), or with complete flexibility in defining rainfall for a [synthetic event](../events/synthetic_events.qmd)). For [probabilistic event sets](../events/probabilistic_events.qmd), the precpitation change needs to be applied to every event in the set, something that the user cannot do via the events tab.

::: {.callout-note}
## What happens if I choose this projection for a single event scenario?
If you choose a projection of increased precipitation for a single event, it will work exactly as expected, and is identical to the precipitation magnifier option when you define your event. If you prefer to specify the increased precipitation via the projections tab instead of as a precipitation magnifier in the event tab, that is completely fine! Just be careful not to choose both, or the increase will be applied twice.
:::

![**Entering increased precipitation as a percentage increase**](../../_static/images/projections_precip.png){width=70% fig-align=left #fig-projectionsPrecip}

## Increased storm frequency
Coming soon
An increase in storm frequency is given as a percentage in the projections window (see @fig-projectionsPrecip). This percentage is treated as an increase in the occurrence frequency of each tropical storm event in a probabilistic event set. This influences the return period flood maps and risk estimates, because when storms occur more frequently, the chance of storm flooding, and hence risk, increases.

::: callout-tip
## Example - increased storm frequency
For example, if you select a storm frequency increase of 10%, and a tropical storm in the event set had an occurrence frequency of once in 50 years (0.02), the increased frequency of this storm would be 0.22, or once in about 45 years.
:::

### Why is this only for probabilistic event sets?
The change in storm frequency will only affect the frequency of the storm. This frequency is used in the derivation of return period flood maps and the calculation of expected annual damages. For a single event, this frequency is not used.

::: {.callout-note}
## What happens if I choose this projection for a single event scenario?
If you choose a projection of increased storm frequency for a single event, it will have no effect. The frequency is only used when calculating return period flood maps and risk, and for a single event scenario will play no role. It won't do any harm, but it won't have any effect on the resulting event-scenario flood and impact results.
:::

![**Entering increased storm frequency as a percentage increase**](../../_static/images/projections_stormFreq.png){width=70% fig-align=left #fig-projectionsPrecip}
8 changes: 7 additions & 1 deletion docs/4_user_guide/projections/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ lightbox: auto
---
FloodAdapt can simulate future climate and socio-economic conditions.

![**Projections about the future that FloodAdapt can simulate: sea level rise, increased tropical storm frequencies, precipitation changes, population growth, and economic growth**](../../_static/images/projections.png){#fig-projections}
![**FloodAdapt can simulate future [climate projections]{.underline} - sea level rise, increased tropical storm frequencies, precipitation changes, and [socio-economic projections]{.underline} - population growth and economic growth**](../../_static/images/projections.png){#fig-projections}

On the Projections Tab in FloodAdapt, click 'Add Projection' to open the projections window (see @fig-projectionWindow)

![**Projections window on the Projections tab in FloodAdapt**](../../_static/images/Projection_window.png){#fig-projectionWindow}

In this window you can specify a [climate projection](climate.qmd), a [socio-economic projection](socioEconomic.qmd), or a combination (for example: 10% population growth with 1 foot of SLR).

Click the following links to learn more about how climate and socio-economic projections can be specified in FloodAdapt, and how they are represented in the modeling.

Expand Down
Binary file added docs/_static/images/Projection_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/green_infra_CRC.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_SLR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_SLR_manual.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_climate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_precip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/projections_stormFreq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0d1ecd

Please sign in to comment.