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

docs: add JupyterLab integration docs #1147

Merged
merged 4 commits into from
Apr 17, 2024

Conversation

renan-r-santos
Copy link
Contributor

@renan-r-santos renan-r-santos commented Apr 9, 2024

What do you guys think about the Binder link? My idea was to help people who want to do a quick test of using Pixi + JupyterLab before adopting it.

@dhirschfeld
Copy link
Contributor

I always preferred manually specifying my kernels with conda/mamba rather than using nb_conda_kernels. It should be possible to do the same with pixi without any magic (though some people do prefer the magic!).

Manually creating a jupyter kernelspec like the below should do the job for people who like doing it the hard way! 😅

{
  "argv": [
    "pixi", "run", "--manifest-path", "~/pixi/envs/dev312",
    "python", "-m", "ipykernel_launcher",
    "-f", "{connection_file}"
  ],
  "display_name": "dev312",
  "language": "python",
  "env": {
    "A_VARIABLE": "true",
  },
  "metadata": {
    "debugger": true
  }
}


This will start JupyterLab and open it in your browser.

![JupyterLab launcher screen showing Pixi Kernel](https://raw.githubusercontent.com/renan-r-santos/pixi-kernel/main/assets/launch-light.png#only-light)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice that you already add this!

@renan-r-santos
Copy link
Contributor Author

I'm converting this to a draft for now. I released a new version of pixi-kernel and now it is capable of supporting in theory any other Jupyter kernels. It already supports Python, R, Bash and C++.
I need to update this PR to reflect that and also address some comments from Wolf. I'll let you guys know when this is ready for review again. Tks.

@renan-r-santos renan-r-santos marked this pull request as draft April 12, 2024 13:25
@renan-r-santos renan-r-santos marked this pull request as ready for review April 15, 2024 11:52
@renan-r-santos
Copy link
Contributor Author

@ruben-arts @wolfv I believe this is ready for another pass.
pixi-kernel 0.2.0 added support for additional kernels, such as R, C++ and Bash. I updated the pixi-kernel section accordingly and added a few words on when you might want to use it.

@ruben-arts ruben-arts requested a review from wolfv April 16, 2024 08:10
@wolfv wolfv merged commit 558b1fe into prefix-dev:main Apr 17, 2024
5 checks passed
@wolfv
Copy link
Member

wolfv commented Apr 17, 2024

Thanks @renan-r-santos!

@renan-r-santos renan-r-santos deleted the jupyterlab-docs branch July 11, 2024 23:20
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.

4 participants