feat: create raw data loader and setup of repo#4
Open
arjunsridhar12345 wants to merge 13 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR attempts to address #3 by creating a module for loading the raw data using the data contract for the Dynamic Foraging experiment defined here: https://github.com/AllenNeuralDynamics/Aind.Behavior.DynamicForaging/blob/main/src/aind_behavior_dynamic_foraging/data_contract/_dataset.py.
Using this diagram as guidance: https://github.com/AllenNeuralDynamics/aind-software-docs/blob/main/diagrams/dynamic_foraging/low_level/dynamic-foraging-low-level-processing.svg
An initial example notebook has been made to try and show how to access the raw data:
https://github.com/AllenNeuralDynamics/dynamic-foraging-processing/blob/3-create-raw-data-loader/examples/raw_data_loader_example.ipynb
In addition, the PR does some setup for the repo so it tries to align with the coding standards that were recently merged by a group of engineers from SIPE and Sci Comp as the current package template has not been updated yet. There may be things I missed or maybe messed up but at a high level is the following: