Skip to content
This repository has been archived by the owner on May 6, 2024. It is now read-only.

Added radar/satellite segmentation #28

Closed

Conversation

freemansw1
Copy link
Member

Description

  • What kind of change does this PR introduce?
    A tutorial showing how to use the new transform points for segmentation feature introduced in Adding ability to track on one dataset, segment on another tobac#242 .

  • What is the current behavior? (You can also link to an open issue here)
    n/a

  • What is the new behavior (if this applies) or the new content?
    An example notebook showing feature detection on a radar grid and segmentation on a satellite grid.

  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    Note that this PR uses the tobac v1.x style, rather than v2.0_dev.

I should note that this tutorial notebook could be improved with more markdown, but I wanted to get something in for the main tobac PR.

Checklist for Requirements

General

  • Have you followed our guidelines in Section "Contributing" from README.md?

Style

  • Have you checked already existing notebooks to get an idea about our tutorial style?
  • Have you extensively used markdown elements to structure and explain your notebook?
  • Did you include your tutorial notebook in the index.rst file?

Data & Reproducibility

  • Have you uploaded your example data to zenodo (see README) if needed?

Concerning Tests

  • Have you self-reviewed your code / notebook and corrected any misspellings?
  • Have you checked if your notebook is running in the recommended standard conda enviroment [see here]((docs/RunningTutorials.md) and updates the list of required python packages if needed?
  • Have you carefully checked that sphinx-based rendering is still working correctly?

Git Aspects: To Make It Easier for Us!

  • Have you written descriptive commit messages?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes been merged into this branch?

Copy link
Member

@w-k-jones w-k-jones left a comment

Choose a reason for hiding this comment

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

A nice example overall, but I think a couple of changes would make it more approachable for users:

  1. Make it more consistent with the existing examples, particularly variable naming
  2. Rearrange into clear sections with documentation in markdown cells. In particular, separating the data processing for nexrad and goes would improve clarity
  3. Increase the time period so that it encompasses multiple goes files to demonstrate how features are mapped in time as well as space

@freemansw1 freemansw1 closed this May 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants