ethology-test-data/README.md

ethology-test-data

Test data for the ethology Python package.

General guidelines

When adding test data to test a specific module, please include under a subdirectory with the following structure:

test_data/test_<module-name>/

This will allow us to make efficient use of the pooch library and the pytest fixtures.

Adding or editing data

Remember to update the file registry at files-registry.txt after adding or editing the data!

To do so, run the following from the root of the GIN repository:

1. Ensure all the content is downloaded locally:

gin download --content

2. After editing or adding any files, run the provided Python script to re-generate the file-registry.txt file:

python get_sha256_hashes.py

3. Commit and upload the changes to the GIN repository

gin commit -m "Update file and file-registry.txt" <path-to-edited-or-updated-file> file-registry.txt
gin upload <path-to-edited-or-updated-file> file-registry.txt

For more details on how to work with GIN data repositories, please see the GIN HowTo guide.