Repository navigation
docs: add input data requirements for tracking algorithms - #277
Merged
robert-edwin-rouse merged 1 commit intoOct 22, 2026
Merged
robert-edwin-rouse merged 1 commit into
robert-edwin-rouse merged 1 commit into
Conversation
Contributor
Author
|
Hi @admg26 , I've opened PR documenting input data requirements and grid specifications across all four tracking algorithms ( |
Collaborator
|
@robert-edwin-rouse Please take a look at this and merge if appropriate. |
robert-edwin-rouse
approved these changes
Oct 22, 2026
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
4 participants
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.
Overview
Closes #100.
This PR documents the specific input data requirements and spatial/temporal structure expected by each tracking algorithm in TCTrack.
Changes Made
Updated tracker documentation across four tracking algorithms:
docs/tracking-algorithms/machine_learning.rst: Clarified ML tracker dataset input formats and expected dimensions.docs/tracking-algorithms/tempest_extremes.rst: Added detailed input field specifications and grid structure requirements.docs/tracking-algorithms/track.rst: Documented mandatory variable names and atmospheric level parameters.docs/tracking-algorithms/tstorms.rst: Specified resolution, variable formatting, and step constraints.