|
|
@@ -1,8 +1,6 @@
|
|
|
# ethology-test-data
|
|
|
|
|
|
-Test data for the ethology Python package.
|
|
|
-
|
|
|
-For a description of the available test data, please see the [DATA_DESCRIPTION.md](test_data/DATA_DESCRIPTION.md) file.
|
|
|
+Test data for the [ethology](https://github.com/neuroinformatics-unit/ethology) Python package. For a description of the available test data, please see the [DATA_DESCRIPTION.md](test_data/DATA_DESCRIPTION.md) file.
|
|
|
|
|
|
## Adding or editing data
|
|
|
|
|
|
@@ -15,7 +13,8 @@ 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 test data 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.
|
|
|
+> [!WARNING]
|
|
|
+> Please ensure that the filenames are unique across the whole test data 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:
|
sfmig