Add Dev Container + add tutorial + general updates to the Element#30
Merged
kushalbakshi merged 57 commits intodatajoint:mainfrom Jan 29, 2024
Merged
Add Dev Container + add tutorial + general updates to the Element#30kushalbakshi merged 57 commits intodatajoint:mainfrom
kushalbakshi merged 57 commits intodatajoint:mainfrom
Conversation
kushalbakshi
requested changes
Jan 19, 2024
Collaborator
kushalbakshi
left a comment
There was a problem hiding this comment.
Thank you @MilagrosMarin. Just a few small things. I haven't gone through the notebook yet but will do so in the next round.
Co-authored-by: Kushal Bakshi <52367253+kushalbakshi@users.noreply.github.com>
Co-authored-by: Kushal Bakshi <52367253+kushalbakshi@users.noreply.github.com>
Co-authored-by: Kushal Bakshi <52367253+kushalbakshi@users.noreply.github.com>
Co-authored-by: Kushal Bakshi <52367253+kushalbakshi@users.noreply.github.com>
Co-authored-by: Kushal Bakshi <52367253+kushalbakshi@users.noreply.github.com>
Updates to the tutorial and devcontainer
kushalbakshi
approved these changes
Jan 29, 2024
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 incorporates DevContainers configured to run Codespaces and introduces a tutorial notebook with a comprehensive overview of the Element, without delving into specifics such as data mounting or other detailed aspects.
The proposed changes cover the following:
Add DevContainer and
docker-compose-db.yamlModifying the following files/updating with the following changes, primarily to align the Element more consistently with other DataJoint Elements:
.github, license,.gitignore,contributing,workflows,code of conductandcodespellsetup.pyand fixextras_requiresetup.pywill now install directly from GitHub instead of PyPI (no longer updated)flowchartimages according to other Elementsversion.pyand CHANGELOGAdd the following files:
dj.config()for the tutorial / DevContainers intutorial_pipeline.pytutorial.ipynbAdd to the previous changes: This PR introduces the inclusion of S3 data mounting in the DevContainer as well. This modification is accompanied by corresponding updates to the proposed tutorial, aiming to enhance the tutorial by aligning it with the rest of the Elements.