Skip to content

Add Dev Container + add tutorial + general updates to the Element#30

Merged
kushalbakshi merged 57 commits intodatajoint:mainfrom
MilagrosMarin:main
Jan 29, 2024
Merged

Add Dev Container + add tutorial + general updates to the Element#30
kushalbakshi merged 57 commits intodatajoint:mainfrom
MilagrosMarin:main

Conversation

@MilagrosMarin
Copy link
Collaborator

@MilagrosMarin MilagrosMarin commented Jan 3, 2024

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.yaml

    • Test Codespaces containerization on GitHub repository
  • Modifying the following files/updating with the following changes, primarily to align the Element more consistently with other DataJoint Elements:

    • Function param types and docstring in src files
    • .github, license, .gitignore, contributing, workflows, code of conduct and codespell
    • setup.py and fix extras_require
    • The packaging requirements of elements in setup.py will now install directly from GitHub instead of PyPI (no longer updated)
    • README
    • Color in the flowchart images according to other Elements
    • version.py and CHANGELOG
  • Add the following files:

    • Add tutorial pipeline
      • Set up of dj.config() for the tutorial / DevContainers in tutorial_pipeline.py
    • Add tutorial.ipynb
      • Validate the tutorial's functionality in both Codespaces and local environments.

Add 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.

@MilagrosMarin MilagrosMarin changed the title Add Dev Container and update images and README Add Dev Container + tutorial + general updates to the Element Jan 17, 2024
@MilagrosMarin MilagrosMarin changed the title Add Dev Container + tutorial + general updates to the Element Add Dev Container + add tutorial + general updates to the Element Jan 17, 2024
@MilagrosMarin MilagrosMarin marked this pull request as ready for review January 18, 2024 23:08
Copy link
Collaborator

@kushalbakshi kushalbakshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @MilagrosMarin. Just a few small things. I haven't gone through the notebook yet but will do so in the next round.

MilagrosMarin and others added 6 commits January 22, 2024 16:20
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>
@kushalbakshi kushalbakshi merged commit 9389ec4 into datajoint:main Jan 29, 2024
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

Successfully merging this pull request may close these issues.

2 participants