Skip to content

Commit

Permalink
Add "making test data files" section to contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpre committed Feb 28, 2024
1 parent 531dbf8 commit f1ed8d1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,32 @@ useful:
- give a minimal example demonstrating the bug,
- copy and paste the error traceback.

.. _making_test_files:

Making test data files
======================

Test data fales are typically generated using third party software, for example using a proprietary
software on a scientific instrument. These files are added to the `test suite <https://en.wikipedia.org/wiki/Test_suite>`_
of RosettaSciIO to make sure that future code development will not introduce bug or feature
regression. It is important that the test data files area as small as possible to avoid to work
with GBs large repository of test data. Indeed, the test suite is made of severals hundreds of
test data files and this number of files will keep growing as new features and formats are added
to RosettaSciIO.

User can contribute by generating these files on softwares they have access to and by making these
files available openly; then a RosettaSciIO developer will help with adding these data to the test suite.

What makes good test data files:

- Relevant features: the test data files doesn't need to contains any meaningfull data but they need to
cover as much as possible of the format functionalities.
- Small in size:

- Acquire minimum number of pixels or channels; in case of images or spectrum images, acquire "non-square".
- Generate containing no signal (e.g. zeros) as files containing only very few values will compress very well.


Pull Requests
=============

Expand Down

0 comments on commit f1ed8d1

Please sign in to comment.