Restructure as installable floodpath package#10
Merged
Conversation
Renames the project from "flood_inundation" to "floodpath" and prepares a v0.1.0 release suitable for PyPI: - Move dem/, hydrology/, exposure/, damage/ under floodpath/ namespace so users get safe, project-prefixed imports (no "from dem import ...") - Rewrite all cross-package imports to floodpath.<pkg>.<module> - Update tests/conftest.py, fixture generators and the pytest config so the same suite runs against the new package - Add LICENSE (MIT), README.md (badges, install, quickstart, citations), and a [project] / [build-system] block in pyproject.toml - Move per-user caches from ~/.cache/flood_inundation/* to ~/.cache/floodpath/* and update OSM User-Agent + GHSL/WorldPop docstrings accordingly - Rename the conda env (1c_setup_env.sh) and the GHA workflow's micromamba environment from "flood_inundation" to "floodpath" - Add smoke_test.py and .claude/ to .gitignore The GitHub repo has been renamed in parallel (rehsani/flood_inundation -> rehsani/floodpath); badge and project URLs updated to match. 122 tests still pass (offline + integration).
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.
Summary
flood_inundationtofloodpath. The GitHub repo has already been renamed (rehsani/flood_inundation→rehsani/floodpath); GitHub auto-redirects old URLs.dem/,hydrology/,exposure/,damage/underfloodpath/. Users now writefrom floodpath.dem import get_deminstead offrom dem import get_dem, which avoids namespace collisions.[project]+[build-system]blocks inpyproject.tomlso the package ispip install floodpath-ready.1c_setup_env.sh) and the GHAmicromambaenv fromflood_inundationtofloodpath.~/.cache/flood_inundation/*to~/.cache/floodpath/*. (User caches will be re-populated on first call after this PR; old ones can be deleted.)smoke_test.pyand.claude/to.gitignore.Test plan
python -m build) — already verified locally; producesfloodpath-0.1.0-py3-none-any.whl(~31 KB) and.tar.gz(~25 KB).Follow-ups (next session)
twine upload dist/*to TestPyPI, verify installtwine upload dist/*to real PyPIflood_inundation/→floodpath/)