# ethology-test-data

Test data for the [ethology](https://github.com/neuroinformatics-unit/ethology) Python package. For a description of the available test data, see the [description of available data](test_data/README.md).

## Adding or editing data

### Folder structure
When adding data for a specific test module, please include it under the subdirectory with the same name as the test module:

```bash
test_data/test_<module-name>/
```

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

⚠️**IMPORTANT**⚠️:

Please ensure that the filenames are unique across the whole repository. This is because during testing, we currently use the files' names as keys to access the data, and having duplicate names will cause (silent) conflicts.

### Steps
Remember to update the file registry at `files-registry.txt` after adding or editing any data. To do so, run the following from the root of the GIN repository:

**1.** Ensure all the content is downloaded locally:

```bash
gin download --content
```

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

```bash
python get_sha256_hashes.py
```

**3.** Commit and upload the changes to the GIN repository

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

For more details on how to work with GIN data repositories, please see the [GIN HowTo guide](https://howto.neuroinformatics.dev/open_science/GIN-repositories.html).