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 #366

Merged
merged 102 commits into from
Feb 27, 2024
Merged

Docs #366

merged 102 commits into from
Feb 27, 2024

Conversation

Santonia27
Copy link
Contributor

update light theme

@Santonia27 Santonia27 merged commit 40246d4 into main Feb 27, 2024
4 checks passed
@Santonia27 Santonia27 deleted the docs branch February 27, 2024 08:51
@Santonia27 Santonia27 restored the docs branch February 27, 2024 08:51
kathrynroscoe added a commit that referenced this pull request Mar 1, 2024
* 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>
Santonia27 added a commit that referenced this pull request Mar 1, 2024
* 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>
kathrynroscoe added a commit that referenced this pull request Mar 1, 2024
* 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

---------

Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>
Co-authored-by: kathrynroscoe <79269966+kathrynroscoe@users.noreply.github.com>
LuukBlom pushed a commit that referenced this pull request Mar 1, 2024
* 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

---------

Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>
Co-authored-by: kathrynroscoe <79269966+kathrynroscoe@users.noreply.github.com>
kathrynroscoe added a commit that referenced this pull request Mar 13, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants