[x] I have read and followed the guidelines in the CONTRIBUTING document
[x] I have checked to ensure there aren't other open Pull Requests for the same update/change
[x] I have updated the documentation accordingly.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
Pydov can be used to integrate DOV data in your own scripts and analysis. By
default it will execute a new search operation on every run, making it easy to
rerun your analysis at a later time using the latest data that might not have been
available before. This means your script and analysis will be reproducible.
For some projects or use-cases one might want to go a step further and want
full repeatability: when rerunning the script or analysis exactly the same
results should be returned. This PR adds support for this too, by allowing users to
save (record) a pydov session into an archive and replaying it afterwards.
CONTRIBUTINGdocumentPydov can be used to integrate DOV data in your own scripts and analysis. By default it will execute a new search operation on every run, making it easy to rerun your analysis at a later time using the latest data that might not have been available before. This means your script and analysis will be reproducible.
For some projects or use-cases one might want to go a step further and want full repeatability: when rerunning the script or analysis exactly the same results should be returned. This PR adds support for this too, by allowing users to save (record) a pydov session into an archive and replaying it afterwards.