tobac-project / tobac

Tracking and object-based analysis of clouds
BSD 3-Clause "New" or "Revised" License
102 stars 54 forks source link

Add Box Seeding Documentation to Segmentation Parameter Docs #406

Closed freemansw1 closed 9 months ago

freemansw1 commented 9 months ago

Resolves #399 and adds box seeding to our documentation for segmentation parameters.

Worked on with @RBhupi during the tobathon 2024

freemansw1 commented 9 months ago

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

github-actions[bot] commented 9 months ago

Linting results by Pylint:

Your code has been rated at 8.72/10 (previous run: 8.72/10, +0.00) The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the tobathon branch. A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (ed4c4bf) 56.91% compared to head (333778b) 56.91%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## tobathon #406 +/- ## ========================================= Coverage 56.91% 56.91% ========================================= Files 20 20 Lines 3440 3440 ========================================= Hits 1958 1958 Misses 1482 1482 ``` | [Flag](https://app.codecov.io/gh/tobac-project/tobac/pull/406/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/tobac-project/tobac/pull/406/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | `56.91% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

harrietgilmour commented 9 months ago

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

Yes no problem. I can do it next week

freemansw1 commented 9 months ago

@harrietgilmour and @w-k-jones, are you available to review this PR within the next week or so?

Yes no problem. I can do it next week

Thanks! Trying to be more deliberate with our review requests.

w-k-jones commented 9 months ago

Also the docstring are wrongly formatted for seed_3D_flag in segmentation.py which is causing the API reference to render incorrectly. I can fix that quickly and add it to this PR

freemansw1 commented 9 months ago

Thanks @w-k-jones @harrietgilmour !

@w-k-jones what is our policy on documentation-only PRs? We can merge these right into main, right?

w-k-jones commented 9 months ago

Thanks @w-k-jones @harrietgilmour !

@w-k-jones what is our policy on documentation-only PRs? We can merge these right into main, right?

Yes, looks like there's no issues with merging into main so I'm happy for you to do that directly