Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update internal data model to Camtrap DP v1.0 #251

Open
peterdesmet opened this issue Jul 15, 2023 · 1 comment
Open

Update internal data model to Camtrap DP v1.0 #251

peterdesmet opened this issue Jul 15, 2023 · 1 comment
Milestone

Comments

@peterdesmet
Copy link
Member

Suggested in camtraptor July 2023 coding sprint

Camtraptor v0.20 and earlier use Camtrap DP v0.1.6 for the internal data model. You can recognize this model by e.g. the use of sequenceID over eventID, but it has many other differences with the latest Camtrap DP version. Version v0.1.6 was implemented in camtraptor, since that was the (first) Camtrap DP version supported as export format in Agouti and Trapper. Both Agouti and Trapper are now changing to Camtrap DP v1.0, which camtraptor v0.20 will be able to read (#223) by internally converting to the legacy v0.1.6 version. This is done so that users are not faced with breaking changes in column names etc.

We should however move to Camtrap DP v1.0 as the internal model for camtraptor, since that is first version to officially support. It will also take away the discrepancy between Camtrap DP v1.0 files and how it looks inside camtraptor (because of the silent conversion to the legacy format by read_camtrap_dp()). Since it is a breaking change, it requires a major version bump (camtraptor 1.0).

This change will affect all functions, but those will undergo substantial (breaking) changes anyway as part of milestone v1.0.

Camtrap DP will also not stay at version 1.0 indefinitely, and camtraptor should be ready for (minor) versions updates. We suggest:

  • Always supporting the latest version of Camtrap DP in camtraptor (each update in Camtrap DP will require an update in camtraptor)
  • Supporting all legacy versions of Camtrap DP from version 1.0-rc.1 onwards. This means we will drop support for v0.1.6. Users will be able to recreate their exports in the latest version of Camtrap DP in Agouti and Trapper.
@damianooldoni
Copy link
Member

We leave this issue open until camtraptor v1.0 will be released.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants