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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9296fc2
update folder directories explanation
Santonia27 Aug 20, 2024
e8dcd99
update text for folder directories
Santonia27 Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions docs/3_setup_guide/Delft_Fiat/hydromt_fiat_gui.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,23 +379,35 @@ There is also a button "Exposure output". This opens the full model data, which
Coming soon...
:::

## Delft-FIAT model folder
Once you have created your model, the model folder you specified when you chose your working directory in the [getting started](#getting-started) step will be populated with the Delft-FIAT model files. This folder structure will be described...**coming soon**...
## Delft-FIAT model folder structure
Once you have created your model, the model folder you specified when you chose your working directory in the [getting started](#getting-started) step will be populated with the Delft-FIAT model files. Below you can see what the folder structure looks like for a comprehensive model, saved in a working directory named "Delft-FIAT".
When you create a basic model (without using QuickBuild or any advanced options), the resulting folder structure will contain fewer folders and files. The additional folders and files that appear when using QuickBuild or adding additional attributes to your model are highlighted in the figure below, indicating that the folders (incl. files within) are generated only under those specific conditions.

<!--
Figure x shows what the folder structure looks like, for a working directory named "FIAT".

├───📁 FIAT/
|
├───📁 hazard/
│ └───📄 This will be empty
```
├───📁 Delft-FIAT/
|
├───📁 exposure/
│ ├───📁 additional_attributes/ (advanced model)
│ │ ├─── 📄 base_zone.gpkg
│ │ ├─── 📄 land_use.gpkg
│ ├───📁 aggregation_areas/ (quickbuild/advanced model)
│ │ ├─── 📄 block_groups.gpkg
│ ├───📁 equity/ (quickbuild/advanced model)
│ │ ├─── 📄 equity_data.gpkg
│ ├───📄 buildings.gpkg
│ └───📄 exposure.csv
│ ├───📄 exposure.csv
│ ├───📄 region.gpkg
│ ├───📄 roads.gpkg
|
├───📁 vulnerability/
│ └───📄 vulnerability_curves.csv
│ ├───📄 vulnerability_curves.csv
│ ├───📄 vulnerability_identifiers.csv
|
└───📄 settings.toml
-->
├───📁 hazard/
│
├───📁 output/
|
├───📄 hydromt.log
├───📄 settings.toml
└───📄 spatial_joins.toml (quickbuild/advanced model)
```
Loading