Skip to content

Conversation

@jatkinson1000
Copy link
Member

@jatkinson1000 jatkinson1000 commented Sep 5, 2025

Closes #55

Adds basic documentation on:

  • Code structure
  • Data formats
  • Packaging
  • Testing

This is intended to provide a starting point that can be added to as users go through the experience of adding algorithms.

@jatkinson1000 jatkinson1000 force-pushed the add_algorithm branch 2 times, most recently from 74b9a50 to fb339d1 Compare September 5, 2025 16:55
@jatkinson1000 jatkinson1000 self-assigned this Sep 5, 2025
@jatkinson1000
Copy link
Member Author

This will need overhauling now that I have opened #69 to provide Abstract Base Classes for the TCTracker and TCTrackerParameters. These provide a skeleton from which new algorithms can be added, and enforce implementation of certain methods to ensure a consistency between trackers.

I'll aim to re-write this when I get some time, but @admg26 it would be good to have you cast and eye over #69 to check that you're happy with this approach.

@admg26
Copy link
Collaborator

admg26 commented Oct 15, 2025

@jatkinson1000 I have looked at the refactored code and am generally happy with this.

Copy link
Collaborator

@admg26 admg26 left a comment

Choose a reason for hiding this comment

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

This all looks good.

@jatkinson1000
Copy link
Member Author

I have rebased on top of main and updated to reflect the changes to using base classes.

I believe this is ready for review in the new year @admg26 and @sjavis

Copy link
Collaborator

@sjavis sjavis left a comment

Choose a reason for hiding this comment

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

The documentation looks good - I can't think of anything missing. I have a few suggestions for improving the clarity.

@jatkinson1000 jatkinson1000 requested a review from sjavis January 5, 2026 14:25
Copy link
Collaborator

@sjavis sjavis 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 the changes. It all looks good to me.

@jatkinson1000 jatkinson1000 merged commit 9d806db into main Jan 5, 2026
6 of 7 checks passed
@jatkinson1000 jatkinson1000 deleted the add_algorithm branch January 5, 2026 14:33
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.

Documentation for adding new algorithms to TCTRACK

4 participants