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

Add DevContainers + Codespaces tutorial #173

Merged
merged 29 commits into from
Nov 9, 2023

Conversation

kushalbakshi
Copy link
Collaborator

@kushalbakshi kushalbakshi commented Oct 25, 2023

This PR adds DevContainers configured to run Codespaces for tutorials and workshops. The proposed changes will include the following:

  • DevContainer configuration that builds a Codespace on the GitHub repository with S3 mounted sample data
  • Tutorial pipeline
  • 60 min tutorial notebook
  • Short demo notebook
  • Updated setup.py
  • Updated version.py and CHANGELOG

The scope for this PR has been altered slightly. Documentation updates will be included in a separate PR since the scope of updates is very large.

@kushalbakshi kushalbakshi marked this pull request as ready for review October 27, 2023 16:07
Copy link
Contributor

Choose a reason for hiding this comment

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

I think all of these new changes should belong in tutorial_pipeline.py
Same is true for the calcium-imaging and deeplabcut elements - let's discuss further

@@ -22,19 +21,66 @@ to assemble a fully functional pipeline.

![datajoint](https://raw.githubusercontent.com/datajoint/element-array-ephys/main/images/attached_array_ephys_element_acute.svg)

+ We have designed variations of the pipeline to handle different use cases. Displayed
above is the `ephys_acute` schema for acute electrophysiology recordings. Details on
all `ephys` schemas can be found in the documentation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The documentation can be hyperlinked here to https://datajoint.com/docs/elements/element-array-ephys/0.2/


+ [Documentation](https://datajoint.com/docs/elements/element-array-ephys)

## Support

+ If you need help getting started or run into any errors, please contact our team by email at support@datajoint.com.
+ If you need help getting started or run into any errors, please contact our team by
email at support@datajoint.com.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we not including the "open a GitHub Issue" option here?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Given that this is a jupyter notebook, it will be more convenient to create a minor PR to be merged into this PR for the review for this tutorial.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I am working on it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you, @MilagrosMarin. That sounds good.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I will merge this PR and updates on the proposed tutorial will be included in an upcoming PR since the scope of updates is very large.

Copy link
Collaborator

@MilagrosMarin MilagrosMarin 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 @kushalbakshi for this PR!

@MilagrosMarin
Copy link
Collaborator

I've checked the creation of a codespace and have run the entire tutorial notebook with successful results.

@MilagrosMarin MilagrosMarin merged commit 140384e into datajoint:main Nov 9, 2023
7 checks passed
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.

3 participants