From ba0dc18f176c0aa38c20e9cf4c6cf6de87ad775c Mon Sep 17 00:00:00 2001 From: sfmig <33267254+sfmig@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:19:31 +0100 Subject: [PATCH] Update docs --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 384638c4d..63a56e949 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -322,17 +322,20 @@ To add a new file, you will need to: 2. Ask to be added as a collaborator on the [movement data repository](gin:neuroinformatics/movement-test-data) (if not already) 3. Download the [GIN CLI](gin:G-Node/Info/wiki/GIN+CLI+Setup#quickstart) and set it up with your GIN credentials, by running `gin login` in a terminal. 4. Clone the movement data repository to your local machine, by running `gin get neuroinformatics/movement-test-data` in a terminal. -5. Add your new files to the `poses`, `videos`, and/or `frames` folders as appropriate. Follow the existing file naming conventions as closely as possible. -6. Determine the sha256 checksum hash of each new file by running `sha256sum ` in a terminal. For convenience, we've included a `get_sha256_hashes.py` script in the [movement data repository](gin:neuroinformatics/movement-test-data). If you run this from the root of the data repository, within a Python environment with `movement` installed, it will calculate the sha256 hashes for all files in the `poses`, `videos`, and `frames` folders and write them to files named `poses_hashes.txt`, `videos_hashes.txt`, and `frames_hashes.txt`, respectively. +5. Add your new files to the `poses`, `videos`, `frames` and/or `bboxes` folders as appropriate. Follow the existing file naming conventions as closely as possible. +6. Determine the sha256 checksum hash of each new file. You can do this in terminal by running `sha256sum ` in Ubuntu, or `shasum -a 256 ` in MacOS. For convenience, we've included a `get_sha256_hashes.py` script in the [movement data repository](gin:neuroinformatics/movement-test-data). If you run this from the root of the data repository, within a Python environment with `movement` installed, it will calculate the sha256 hashes for all files in the `poses`, `videos`, and `frames` folders and write them to files named `poses_hashes.txt`, `videos_hashes.txt`, and `frames_hashes.txt`, respectively. 7. Add metadata for your new files to `metadata.yaml`, including their sha256 hashes you've calculated. See the example entry below for guidance. 8. Commit a specific file with `gin commit -m `, or `gin commit -m .` to commit all changes. 9. Upload the committed changes to the GIN repository by running `gin upload`. Latest changes to the repository can be pulled via `gin download`. `gin sync` will synchronise the latest changes bidirectionally. + + ### `metadata.yaml` example entry ```yaml "SLEAP_three-mice_Aeon_proofread.analysis.h5": sha256sum: "82ebd281c406a61536092863bc51d1a5c7c10316275119f7daf01c1ff33eac2a" source_software: "SLEAP" + type: "poses" # "poses" or "bboxes" depending on the type of tracked data fps: 50 species: "mouse" number_of_individuals: 3