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

Add section to developer guide on testing operations on images, etc. #212

Closed
khughitt opened this issue Aug 8, 2012 · 1 comment
Closed
Labels
Documentation Affects the documentation Refactoring Code changes without affecting API (generally)

Comments

@khughitt
Copy link
Member

khughitt commented Aug 8, 2012

Often we will want to write a unit test for some function that operates on a large structure, such as an image.

A place has been provided to include test data (sunpy.data.test) for these kinds of operations, but so far now rules have been created about what should be included there.

It would therefore be helpful to decide on such rules and include a section in the developers guide on the topic.

Things to consider:

  1. When should a new data file be added to sunpy.data.test?
  2. What about hard-coding "fake data" (e.g. a 2-dimensional ndarray) instead of reading in a file each time? For example,
    we could include some sample 32x32 pixel image data, base64-encoded in sunpy.data.test.
  3. Limits on filesize?
  4. Optimal dimensions to ensure accurate testing? (16x16? 32x32?)

It's important to work this out early on so that developers can write good test code for data operations.

@khughitt
Copy link
Member Author

khughitt commented Aug 8, 2012

First step: discuss rules in meeting or on mailing list.

@Cadair Cadair modified the milestones: 0.6, 0.5 Jun 13, 2014
@Cadair Cadair modified the milestones: 0.7, 0.6 Sep 1, 2014
@Cadair Cadair modified the milestone: 0.8 Dec 5, 2016
@dpshelio dpshelio added this to TODO in Docathon - 2017 Mar 6, 2017
@dpshelio dpshelio self-assigned this Jul 6, 2017
@nabobalis nabobalis assigned nabobalis and unassigned dpshelio Jan 22, 2019
@nabobalis nabobalis removed their assignment Apr 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Affects the documentation Refactoring Code changes without affecting API (generally)
Projects
No open projects
Development

No branches or pull requests

4 participants