Include instructions about renaming images

[annavik]

Currently, we require trap images to include timestamp in the filename. This makes it possible for us to do fast indexing of files, which is helpful when reading a large amount of images from a remote storage.

For the AMI systems, images include timestamp in the filename by default and users don't have to worry about it. For other cameras however, this is often not the case. For users, this means images have to be renamed before being uploaded.

We provide a Python utility to automate this process. In this PR, we include some instructions on how to install and use this utility.

[annavik]

@mihow I put this together based on our notes from helping Ariane. Maybe you can test and refine the instructions if you will do the same with Santiago? I also hope we can make a short video about this and include later on :)

[coderabbitai]

Warning

Rate limit exceeded

@annavik has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 1 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7c904e0 and 3e06a7c.

⛔ Files ignored due to path filters (1)

• poetry.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

• Makefile (1 hunks)
• docs/css/extra.css (1 hunks)
• docs/sections/user-guide/processing-data.md (1 hunks)
• docs/sections/user-guide/project-creation.md (1 hunks)
• docs/sections/user-guide/uploading-data.md (1 hunks)
• docs/sections/user-guide/validating-data.md (1 hunks)
• pyproject.toml (1 hunks)

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/include-rename-instructions

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[annavik]

@mihow I put this together based on our notes from helping Ariane. Maybe you can test and refine the instructions if you will do the same with Santiago? I also hope we can make a short video about this and include later on :)

Santiago said on Slack he successfully renamed files using the renaming tool. I will go ahead and merge this, please feel free to refine instructions later if needed.