brennen/App_Mode_Jupyter_Environment_and_Shortcut
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README.md to add reasons why one might use this instead of JupyterLab desktop

Browse Source
This commit is contained in:
Brennen Raimer
2024-10-31 12:13:28 -04:00
parent cb081651e9
commit 0753a0d64c
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,6 +1,6 @@
# App Mode Jupyter Environment and Shortcut
Adds a shortcut for running [JupyterLab](https://jupyter.org/) in a Chromium-based browser's "app" mode (i.e. The application takes up the full browser window and has no browser UI e.g. the address bar, as if Jupyter Lab were a native application) for an existing environment with Jupyter Lab installed or creating one for you.
Adds a shortcut for running [JupyterLab](https://jupyter.org/) in a Chromium-based browser's "app" mode (i.e. The application takes up the full browser window and has no browser UI e.g. the address bar, as if Jupyter Lab were a native application) for an existing environment with JupyterLab installed or creating one for you. This is useful if you do not want to run an Electron app in addition to your browser or if you wish to use Jupyter like a desktop app, but do not have administrator access to install the JupyterLab desktop app.
## Requirements
@@ -54,3 +54,11 @@ To remove the shortcut created by this script, run `python ./setup_jupyter.py --
8. How should I update my Jupyter environment?
That's up to you. I will periodically run `conda update -n jupyter --all && conda update -n jupyter python` to update everything in my Jupyter environment (named `jupyter`).
9. Why not just use the JupyterLab desktop app?
The JupyterLab desktop app is based on the Electron framework, which has relatively high memory usage. Your chromium-based browser also has relatively high memory usage. Running JupyterLab in an app mode browser window allows it to share resources with your browser, which is you also probably have open anyway. JupyterLab desktop also requires administrator privileges to install (at least on Windows), but not all organizations permit their employees to have administrator privileges to install software. If you can install a conda-based Python distribution with only user privileges, then you can also use JupyterLab like a desktop app by opening it in a browser "app" window.
10. What about setting JupyterLab as the default app for .ipynb files? The JupyterLab desktop app can do that.
If I knew how to set file type associations, I would add that functionality to this script, but I don't currently have the necessary knowledge, nor do I have a MacBook to test it on MacOS.