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

Jump to bottom

Configuration based TUDelft calculation #353

Merged

joemoorhouse merged 10 commits into os-climate:main from joemoorhouse:config-based-tudelft3

Sep 22, 2024

Collaborator

joemoorhouse commented Sep 18, 2024

Finish changes related to running a flood calculation using TUDelft data, including standard of protection, and using configuration-based vulnerability.
Partial implementation of vulnerability function uncertainty in config-based models and add to docs.

xbarra suggested changes

View reviewed changes

Collaborator

xbarra left a comment

Please, rebase this branch onto main before merging.

xbarra suggested changes

View reviewed changes

Collaborator

xbarra left a comment

I would rather this got moved to it's own pr and merged.

Also a part of a bigger conversation, but squashing it on this merge would make it difficult to track

VMarfima reviewed

View reviewed changes

src/physrisk/vulnerability_models/cdf_based_vuln_function.py Outdated

		@@ -0,0 +1,162 @@
		from typing import Optional

VMarfima Sep 19, 2024

Missing docstring in public module (fails Ruff rule D100).

src/physrisk/vulnerability_models/cdf_based_vuln_function.py Outdated

		@@ -0,0 +1,162 @@
		from typing import Optional
		from numba import float64, njit

VMarfima Sep 19, 2024

numa.float64 imported but unsed (fails Ruff rule F401)

src/physrisk/vulnerability_models/cdf_based_vuln_function.py Outdated

@@ @@ -0,0 +1,162 @@ @@
+              from typing import Optional
+              from numba import float64, njit
+              from numba.experimental import jitclass

VMarfima Sep 19, 2024

numba.experimental.jitclass imported but unused (fails Ruff rule F401)

src/physrisk/vulnerability_models/cdf_based_vuln_function.py Outdated



		class CDFBasedVulnerabilityFunction:
		"""In general the vulnerability curve specifies for each hazard intensity level a

VMarfima Sep 19, 2024

1 blank line required between summary line and description (fails Ruff rule D205)

Use r""" if any backslashes in a docstring (fails Ruff rule D301)

First line should end with a period (fails Ruff rule D400)

First line should end with a period, question mark, or exclamation point (fails Ruff rule D415)

src/physrisk/vulnerability_models/cdf_based_vuln_function.py Outdated

+                      kind: str = "deterministic",
+                      impact_grid: Optional[np.ndarray] = _default_impact_grid,
+                  ):
+                      """Initialise a CDF

VMarfima Sep 19, 2024

First line should end with a period (fails Ruff rule D400)

First line should end with a period, question mark, or exclamation point (fails Ruff rule D415)

src/physrisk/vulnerability_models/config_based_vuln_model_param.py

+                      ):
+                          self.thresholds = np.array(range(25, 60, 5))
+                  def get_data_requests(

VMarfima Sep 19, 2024

Missing docstring in public method (fails Ruff rule D102)

src/physrisk/vulnerability_models/config_based_vuln_model_param.py

+                          indicator_id=self.indicator_id,
+                      )
+                  def get_impact(

VMarfima Sep 19, 2024

Missing docstring in public method (fails Ruff rule D102)

tests/data/hazard_model_store_test.py

    
            @@ -68,9 +68,9 @@ def _crs_shape_transform_global(
          
                      self,

                      width: int = 43200,

                      height: int = 21600,

                      return_periods: Union[List[float], npt.NDArray] = [0.0],

                      index_values: Union[List[float], npt.NDArray, List[str]] = [0.0],

VMarfima Sep 19, 2024

Do not use mutable data structures for argument defaults (fails Ruff rule B006).

tests/data/hazard_model_store_test.py

    
            @@ -118,10 +118,10 @@ def _crs_shape_transform(
          
                      self,

                      width: int,

                      height: int,

                      return_periods: Union[List[float], npt.NDArray] = [0.0],

                      index_values: Union[List[float], npt.NDArray, List[str]] = [0.0],

VMarfima Sep 19, 2024

Do not use mutable data structures for argument defaults (fails Ruff rule B006).

docs/user-guide/vulnerability_uncertainty.ipynb

+                  "    fig.add_scatter(x=vuln.cdf[i, :], y=vuln.impact, name=f\"Flood depth {hazard_indicator[i]}m\")\n",
+                  "# also interpolate for a depth of 0.6m and display\n",
+                  "interp = vuln.interpolate_cdfs(np.array([0.6]))\n",
+                  "fig.add_scatter(x=interp[0, :], y=vuln.impact, name=f\"Interpolated depth 0.6m\")\n",

VMarfima Sep 19, 2024

f-string without any placeholders (fails Ruff rule F541).

joemoorhouse added 10 commits

September 22, 2024 15:21


          Update config documentation.

f7667d8

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Tidying and test improvements; fix precision-related bug in applying …

684a0da

…SOP.

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Linting

fa103c6

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Add units, neaten vuln confgi test.

08fafd7

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Lint again

6d00b57

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Fix damage function.

dbd75fd

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Changes to standard of protection and use Sequence in place of List/I…

fad4984

…terable.

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Lint changes.

a7b36d5

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Rename; start to add CDF-based function.

bf3d5c1

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>


          Lint again

204d7c5

Signed-off-by: Joe Moorhouse <5102656+joemoorhouse@users.noreply.github.com>

joemoorhouse force-pushed the config-based-tudelft3 branch from 47d3f21 to 204d7c5 Compare

September 22, 2024 14:22

Collaborator Author

joemoorhouse commented Sep 22, 2024

Hi @xbarra and @VMarfima,
Thanks for comments; as suggested I pulled out the PDM lock update into a separate PR and rebased. I took the change to add the PDM matrix CI at the same time.

A couple of changes that hit a lot of files:

Change of Type hint in vulnerability models from Iterable[HazardDataResponse] to Sequence[HazardDataResponse]. Probably should have been like this in the first place (not really intent to allow for generators here and length should be known), but had a case with the config-based models where it was desirable to see length of responses hence change in this PR. I also addressed some other Type hints, generally preferring Sequence over List.
Hopefully does not affect too much and straight forward to change; no good time to make such changes.
Starting to address some of the ruff excluded items I removed exclusion for unused imports.

Added some more doc strings, but still more to do there.

Thanks,
Joe

joemoorhouse merged commit e7a1c3e into os-climate:main

6 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet