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

Split tropical_cyclone module #911

Merged
merged 13 commits into from
Jul 12, 2024
Merged

Split tropical_cyclone module #911

merged 13 commits into from
Jul 12, 2024

Conversation

ThomasRoosli
Copy link
Collaborator

Changes proposed in this PR:

  • The very large trop_cyclone.py file is split in two
  • One part is the Trop_Cyclone class
  • The other part is the windfields calculation using the different Holland or other models, the interface between the two submodules is one single function.

This PR fixes no specific issue, but is was mentioned in the discussion of #846

PR Author Checklist

PR Reviewer Checklist

@ThomasRoosli ThomasRoosli requested a review from peanutfun July 8, 2024 15:31
@ThomasRoosli ThomasRoosli self-assigned this Jul 8, 2024
@ThomasRoosli ThomasRoosli changed the title WIP: split tropical_cyclone module Split tropical_cyclone module Jul 10, 2024
Copy link
Member

@peanutfun peanutfun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good work! It is now much easier to get an overview of the module. I have suggestions that should fix some linter issues.

The change in module structure broke the module documentation. You will have to add two automodule directives for the new submodules in the last section of doc/climada/climada.hazard.rst. If you are confused say so, and I will try to fix it before merging. Thanks! 🙏

climada/hazard/tc_tracks.py Outdated Show resolved Hide resolved
climada/hazard/tc_tracks.py Outdated Show resolved Hide resolved
climada/hazard/test/test_trop_cyclone.py Outdated Show resolved Hide resolved
climada/hazard/trop_cyclone/trop_cyclone.py Outdated Show resolved Hide resolved
climada/hazard/trop_cyclone/trop_cyclone.py Outdated Show resolved Hide resolved
climada/hazard/trop_cyclone/__init__.py Show resolved Hide resolved
climada/hazard/trop_cyclone/__init__.py Show resolved Hide resolved
Copy link
Collaborator Author

@ThomasRoosli ThomasRoosli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your suggestions. I agree with them. I am happy to further discuss the exposed constants.

climada/hazard/test/test_trop_cyclone.py Outdated Show resolved Hide resolved
climada/hazard/trop_cyclone/__init__.py Show resolved Hide resolved
climada/hazard/trop_cyclone/__init__.py Show resolved Hide resolved
@peanutfun peanutfun merged commit b93842e into develop Jul 12, 2024
18 checks passed
@peanutfun peanutfun deleted the feature/split_TC branch July 12, 2024 09:31
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