Skip to content

chore: add startup script for jupyter image #470

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

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

vishwa2710
Copy link
Contributor

@vishwa2710 vishwa2710 commented Dec 6, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced Jupyter Notebook environment with additional installations for improved functionality.
    • Added support for JupyterLab shortcuts extension.
    • Cloned Open Space Toolkit data repository for easier access to necessary datasets.
    • Introduced a startup script for streamlined initialization of the environment.
  • Bug Fixes

    • Improved compatibility with the Open Space Toolkit by installing required libraries conditionally.
  • Chores

    • Updated Dockerfile to include essential tools and configurations for a better user experience.

@vishwa2710 vishwa2710 self-assigned this Dec 6, 2024
Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on enhancing the Dockerfile for a Jupyter Notebook environment and the associated startup script. Modifications include the installation of additional packages such as curl and git-lfs, the addition of JupyterLab extensions, and cloning of the Open Space Toolkit data repository. Furthermore, a new startup script is introduced to set the LD_PRELOAD environment variable for library loading, along with user restoration and token disabling for easier notebook access.

Changes

File Change Summary
docker/jupyter/Dockerfile - Added installation of curl and git-lfs.
- Installed @jupyterlab/shortcuts-extension.
- Cloned Open Space Toolkit data repository.
- Installed libstdc++6 conditionally based on Ubuntu version.
- Created directory for startup scripts and added startup.sh.
- Restored user to non-root and disabled notebook token.
docker/jupyter/startup.sh - Set environment variable LD_PRELOAD to load libstdc++.so.6 before others.

Poem

In the Docker realm, we dance and play,
With curl and git-lfs, we brighten the day.
Jupyter's shortcuts, oh what a delight,
Open Space data, ready for flight!
A startup script whispers, "Let's load with grace,"
In our coding burrow, we find our place! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fba3e5e and 8fa66d2.

📒 Files selected for processing (2)
  • docker/jupyter/Dockerfile (1 hunks)
  • docker/jupyter/startup.sh (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vishwa2710 vishwa2710 merged commit cd88494 into main Dec 6, 2024
1 check was pending
@vishwa2710 vishwa2710 deleted the chore/fix-jupyter-startup branch December 6, 2024 06:42
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.13%. Comparing base (fba3e5e) to head (8fa66d2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #470   +/-   ##
=======================================
  Coverage   91.13%   91.13%           
=======================================
  Files          85       85           
  Lines        8644     8644           
=======================================
  Hits         7878     7878           
  Misses        766      766           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant