Docs #389
Merged
Docs #389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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 (#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>
…al text and figures in the landing pages for these. (#375)
* remove appendix folder and update style sheet * update theme
* Added information on climate projections, plus figures * Corrected spelling mistakes * removed the accidental config file push
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
update content