Pathway to v1.x#137
Open
CyprienBosserelle wants to merge 31 commits into
Open
Conversation
Add a new SimpleRain example (Examples/SimpleRain) including BG_param.txt, PortCharles_DEM.nc, DEM_figure.png and a rain time series (rain.txt) for a Port Charles stress test; BG_param uses dx=32, a 100 mm/h 1-hour rain burst and writes StressTest_Port_Charles.nc. Rewrite and simplify docs/tutorial/TutorialSimpleRain.md into a basic rain-flood tutorial that references the new example files and clarifies DEM, domain, forcing and output settings. Add tools/PostProcessing/CollapseBG.jl, a Julia utility to collapse adaptive BG_Flood NetCDF outputs into single-level grids (functions to read metadata, inject/coarsen levels, compute wet/dry masks and write collapsed NetCDFs).
Change smallnc default from 1 to 0 in src/Param.h so netCDF outputs are saved as floats by default instead of being converted to short integers. This avoids implicit short-integer conversion/quantization unless smallnc is explicitly set to 1; scalefactor and addoffset remain unchanged.
Expand and clarify module documentation: add detailed Atmospheric Pressure usage and boundary impact notes in AtmPress.md; greatly expand Boundaries.md with usage, types, polygon examples, shorthand sides, tapering, zsoffset and atm pressure notes; add Engine 5 compatibility warning to Wetdryfix-Conservelevation.md. Also reorganize mkdocs.yml nav (rename/reshuffle Modules -> In-depth and reorder entries) to surface the updated docs.
Updated project description and added development status.
Removed reference section and added citations for BG_Flood and related publications.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Todo list for the next minor release of BG_FLood