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

Documentation function does not exist #329

Closed
sortland33 opened this issue Aug 21, 2023 · 1 comment
Closed

Documentation function does not exist #329

sortland33 opened this issue Aug 21, 2023 · 1 comment
Labels
bug Code that is failing or producing the wrong result
Milestone

Comments

@sortland33
Copy link

sortland33 commented Aug 21, 2023

The documentation for merges/splits (https://tobac.readthedocs.io/en/latest/tobac.html?highlight=standardize_track_dataset) uses standardize_track_dataset in the "Example usage" section. This function does not exist. When I tried the example usage it says "module tobac.utils has no attribute 'standardize_track_dataset'.

The example usage should be changed to contain only current/valid tobac functions. It may also be useful to have a merge/split example in one of the example notebooks.

@freemansw1
Copy link
Member

Copying in @kelcyno here. That's definitely a bug and mistake. It seems like we inadvertently removed the function in #191. I've opened PR #330 to add this back, and hopefully we can get that merged into v1.5.1.

We have plans to include a merge/split example in the notebooks but haven't done so yet. I believe these notebooks will be released after the AMS Radar short course this weekend.

In the meantime, you can copy/paste the function from here: https://github.com/freemansw1/tobac/blob/c7b0401a93b881aae63e91ed19db5c154cfc8a04/tobac/utils/general.py#L793 and use it in your code.

@freemansw1 freemansw1 added the bug Code that is failing or producing the wrong result label Aug 21, 2023
@freemansw1 freemansw1 added this to the Version 1.5.x milestone Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Code that is failing or producing the wrong result
Projects
None yet
Development

No branches or pull requests

3 participants