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

[TASK] Utility package #506

Open
5 tasks
Andeshog opened this issue Dec 26, 2024 · 0 comments
Open
5 tasks

[TASK] Utility package #506

Andeshog opened this issue Dec 26, 2024 · 0 comments
Labels
ASV AUV feature New feature or request

Comments

@Andeshog
Copy link
Contributor

Description of task

Since there are quite a lot of functions that are being implemented and used in several different packages, creating a common utility package would be useful. An example is the ssa function by Fossen. The package could be called something like "vortex_utils", with the namespace "vortex_utils". Just a suggestion. It may be best to have it as a separete repository, like vortex_msgs, so that it can be used for both auv and asv.

Suggested Workflow

  • Find relevant utility methods.
  • Check out this guide on how to set up the library.

Specifications

No response

Contacts

Code Quality

  • Every function in header files are documented (inputs/returns/exceptions)
  • The project has automated tests that cover MOST of the functions and branches in functions (pytest/gtest)
  • The code is documented on the wiki (provide link)
@Andeshog Andeshog added feature New feature or request ASV AUV labels Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASV AUV feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant