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

Unit testing, error checking and debug mode #48

Open
bwmeyers opened this issue May 20, 2024 · 1 comment
Open

Unit testing, error checking and debug mode #48

bwmeyers opened this issue May 20, 2024 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@bwmeyers
Copy link
Contributor

There's a lack of error checking for various functions throughout. Further to that point, there are minimal (if any) unit tests for various critical functions, which is something we really should resolve if we want to save ourselves pain in the future.

Related, but not necessarily required here is that we can make better use of some debugging code in places where it makes sense. Unit tests will nominally help minimise the number we need, but they can be helpful when developing new features, etc. There are some examples already in the code, and simply requires an additional argument to the compiler.

@bwmeyers bwmeyers added enhancement New feature or request help wanted Extra attention is needed labels May 20, 2024
@bwmeyers
Copy link
Contributor Author

Here I'm ordering the three main tasks in (I think) order of increasing difficulty.

Debugging:

  • beam_psrfits.c
  • beam_vdif.c
  • buffer.c
  • calibration.c
  • filter.c
  • geometry.c
  • jones.c
  • metadata.c
  • performance.c
  • primary_beam.c
  • form_beam.cu (harder due to GPU component)
  • pfb.cu (harder due to GPU component)

Error checking:

  • beam_psrfits.c
  • beam_vdif.c
  • buffer.c
  • calibration.c
  • filter.c
  • geometry.c
  • jones.c
  • metadata.c
  • performance.c
  • primary_beam.c
  • form_beam.cu (harder due to GPU component)
  • pfb.cu (harder due to GPU component)
    This should also include ensuring that we utilise the defined error codes correctly (and add new ones if necessary).

Unit testing:

  • beam_psrfits.c
  • beam_vdif.c
  • buffer.c
  • calibration.c
  • filter.c
  • geometry.c
  • jones.c
  • metadata.c
  • performance.c
  • primary_beam.c
  • form_beam.cu (harder due to GPU component)
  • pfb.cu (harder due to GPU component)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant