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 update directory tree #511

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Docs update directory tree #511

merged 2 commits into from
Aug 20, 2024

Conversation

Santonia27
Copy link
Contributor

No description provided.

@Santonia27 Santonia27 requested a review from savente93 August 20, 2024 11:47
@Santonia27 Santonia27 merged commit d9c4ad6 into main Aug 20, 2024
3 checks passed
@Santonia27 Santonia27 deleted the docs_update_directory_tree branch August 20, 2024 11:50
dumontgoulart added a commit that referenced this pull request Aug 26, 2024
* 380 remove useless statements from log file (#478)

* Simplify logging

* Fix black

* Fix deleting files in hydromts

* change fiat_toolbox dependency to main branch instead of pypi (#499)

Co-authored-by: LuukBlom <153174893+LuukBlom@users.noreply.github.com>

* fix typo in fiat-toolbox url

* revert to using the latest release of fiat-toolbox

* docs hydromt fiat (#472)

* base setup hydromt FIAT

* upload videos hydromt fiat

* add videos and title for delft fiat

* insert more videos

* cross reference video and add text quickbuild

* fill in text for GUI sections

* correct style

* update style

* Add text SVI and additional attributes

* add workflows and fill in text

* fill vulnerability

* fill in text, update style sheet

* fixes

* add video to update vulnerability curves

* update data inputs

* style

* remove bold from "Delft FIAT"

* iupdate FIAT to Delft-FIAT

* update index.qmd and remove data_input qmd, following Kathryn's comments

* update hydormt_fiat_gui with kathryn's comments

* add ground elevation docs

* fine tuning

* update gui videos

* updates

* add new diagrams and remove videos

* add figures

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* replace with Delft-FIAT model-builder

* replace "the user" with "you"

* textual revision

* base setup hydromt FIAT

* upload videos hydromt fiat

* add videos and title for delft fiat

* insert more videos

* cross reference video and add text quickbuild

* fill in text for GUI sections

* correct style

* update style

* Add text SVI and additional attributes

* add workflows and fill in text

* fill vulnerability

* fill in text, update style sheet

* fixes

* add video to update vulnerability curves

* update data inputs

* style

* remove bold from "Delft FIAT"

* iupdate FIAT to Delft-FIAT

* update index.qmd and remove data_input qmd, following Kathryn's comments

* update hydormt_fiat_gui with kathryn's comments

* add ground elevation docs

* fine tuning

* update gui videos

* updates

* add new diagrams and remove videos

* add figures

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* replace with Delft-FIAT model-builder

* replace "the user" with "you"

* textual revision

* spelling

* textual

* textual

* update spell check to ignore static docs folder

* Made mods to the Delft-FIAT setup documentation (KR)

* Finished edits to get Delft-FIAT model builder documentation online

* base setup hydromt FIAT

* upload videos hydromt fiat

* add videos and title for delft fiat

* insert more videos

* cross reference video and add text quickbuild

* fill in text for GUI sections

* correct style

* update style

* Add text SVI and additional attributes

* add workflows and fill in text

* fill vulnerability

* fill in text, update style sheet

* fixes

* add video to update vulnerability curves

* update data inputs

* style

* remove bold from "Delft FIAT"

* iupdate FIAT to Delft-FIAT

* update index.qmd and remove data_input qmd, following Kathryn's comments

* update hydormt_fiat_gui with kathryn's comments

* add ground elevation docs

* fine tuning

* update gui videos

* updates

* add new diagrams and remove videos

* add figures

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* textual improvements

* replace with Delft-FIAT model-builder

* replace "the user" with "you"

* textual revision

* base setup hydromt FIAT

* upload videos hydromt fiat

* fill in text for GUI sections

* add workflows and fill in text

* fill in text, update style sheet

* fixes

* add video to update vulnerability curves

* update data inputs

* style

* remove bold from "Delft FIAT"

* iupdate FIAT to Delft-FIAT

* update index.qmd and remove data_input qmd, following Kathryn's comments

* update gui videos

* add new diagrams and remove videos

* textual improvements

* textual improvements

* spelling

* textual

* textual

* update spell check to ignore static docs folder

* Made mods to the Delft-FIAT setup documentation (KR)

* Finished edits to get Delft-FIAT model builder documentation online

* typos

* Update pyproject.toml

exclude svg files from typo checking

* Remove ignore-paths from GH action

The `ignore-paths` variable that was added to the typos action doesn't seem to be one the action recognises and probably does nothing at best, so I removed it

* add nbformat to environment

* adding more jupyter dependencies

* add python to env.yml

* update workflow

* update workflow docs

* fix workflow

* fix workflow

* update docs workflow

* clean up workflow

---------

Co-authored-by: LuukBlom <153174893+LuukBlom@users.noreply.github.com>
Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>
Co-authored-by: Sam Vente <savente93@proton.me>

* Update auto_code_doc.yml

* fix publishing of docs workflow

* Update auto_code_doc.yml

* Add github actions auth to docs workflow

* allow manual trigger (#501)

* Update workflows (#503)

Summary of changes:

 1.   updated all the used action versions to the latest vesion, as some were really quite out of date, and made any changes necessary to fix whatever broke
  2.  removed black in favour of ruff formatting as ruff formatting implements the same formatting rules as black but runs at least an order of magnitude faster
  3.  did the same two things for the pre-commit config
   4.  ran pre-commit on all files
    5. removed the manual linting steps in favor of just using the pre-commit action which is both faster (does better caching) and ensures both local and ci checks are consistent

* remove jupyter notebooks (#505)

* remove jupyter notebooks

* add image of damage_curves instead of code block

* revert docs workflow to older version

* update to find environment

* fix indentation

* revert docs workflow changes

* try docs workflow from other branch

* docs workflow like main

* remove empty space

* fix linting

* add point

* fix linting

---------

Co-authored-by: Sam Vente <savente93@proton.me>

* comment out destination in docs workflow (#506)

* #docs add jupyter (#507)

* add jupyter notebook

* remove damage curves

* Docs update style (#509)

* clean up style sheet

* clean up

* update section update floodadapt

* Docs update directory tree (#511)

* update folder directories explanation

* update text for folder directories

* Docs measures hydraulic (#512)

* started working on hydraulic measures documentation

* worked a bit more on the hydraulics.qmd

* Finished text about floodwalls and levees

* Added some more content, started pump section

* Finished hydraulic measures, waiting on content review to merge branch

* started working on hydraulic measures documentation

* worked a bit more on the hydraulics.qmd

* Finished text about floodwalls and levees

* Added some more content, started pump section

* Finished hydraulic measures, waiting on content review to merge branch

* testing commit/push

* finished testing commit/sync

* run pre-commit

---------

Co-authored-by: Santonia27 <sarah.rautenbach@deltares.nl>

* Docs measures urban green infra (#513)

* Added green infra documentation

* edited following review comments

* run pre-commit

---------

Co-authored-by: Santonia27 <sarah.rautenbach@deltares.nl>

* update docs structure and add "coming soon"to empty pages (#515)

* Don't offsett water levels in synthetic events (#514)

* Don't offsett water levels in synthetic events

* set wl_ts

* store waterlevel df in event object

* historical event doesnt need the function call

* fix typo

---------

Co-authored-by: = <=>
Co-authored-by: LuukBlom <153174893+LuukBlom@users.noreply.github.com>

* FloodAdapt builder (#421)

* first commit with outline of FA setup script

* updated builder script

* updated model builder workflow

* added template files for FA model builder

* added doc strings

* small updates

* updated relative paths to static folder instead of site folder

* updated fiat elevations method

* small update on fiat damage unit reading

* updated bfe sjoin method

* updated reading of spatial joins with Hydromt-FIAT, and added a footprint read from file

* small update in BF saving

* initial commit for station info

* added part on reading tide_gauge data

* small updates

* updates based on latest main branch changes

* updated tide_gauge checks

* updated workflows

* initial commit for templates

* updates to make sure infometrics and infographic config works well for US

* updated infometric and infographic templates

* added small change on roads graphic

* updates based on latest main merge

* updated infometric and infographic templates

* updated infometric workflow

* added generalization for FIAT geometries and tiles creation

* updated location and names

* corrected road name bug

* updated folder structure and added a executable build script

* small bug corrections

* updated template metrics and infographics

* small update in workflows

* updated NSI metrics

* updated SVI input

* updated slr and tide amplitude workflows

* added functionality for rivers

* update templates

* update metric configs

* small updates in footprints workflows

* rearranged folder structure and added api

* small updates

* small updates for NSI infographics

* update OSM metrics

* added option to get building footprint data from OSM

* update on logging and tide_gauge options

* corrected bug for bfe indexing

* change default option for overwriting database

* added functionality for relative paths

* main script config

* allowed database path to be relative as well

* corrected bug with probabilistic_set relative path

* path as posix corrections

* correction for tiles indices folder name

* correction

* small change in main method

* pre-commit changes

---------

Co-authored-by: dladrichem <136334482+dladrichem@users.noreply.github.com>
Co-authored-by: Panos Athanasiou <38324721+panosatha@users.noreply.github.com>
Co-authored-by: LuukBlom <153174893+LuukBlom@users.noreply.github.com>
Co-authored-by: Santonia27 <145111392+Santonia27@users.noreply.github.com>
Co-authored-by: Kathryn Roscoe <kathryn.roscoe@deltares.nl>
Co-authored-by: Sam Vente <savente93@proton.me>
Co-authored-by: kathrynroscoe <79269966+kathrynroscoe@users.noreply.github.com>
Co-authored-by: Santonia27 <sarah.rautenbach@deltares.nl>
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.

2 participants