Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tweag/jupyenv
Declarative and reproducible Jupyter environments - powered by Nix
https://github.com/tweag/jupyenv
jupyter jupyter-notebooks jupyterlab nix reproducibility
Last synced: about 2 months ago
JSON representation
Declarative and reproducible Jupyter environments - powered by Nix
- Host: GitHub
- URL: https://github.com/tweag/jupyenv
- Owner: tweag
- License: mit
- Created: 2018-12-18T10:10:58.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-09T00:10:53.000Z (4 months ago)
- Last Synced: 2024-06-12T08:27:58.872Z (3 months ago)
- Topics: jupyter, jupyter-notebooks, jupyterlab, nix, reproducibility
- Language: Nix
- Homepage: https://jupyenv.io/
- Size: 10.1 MB
- Stars: 619
- Watchers: 31
- Forks: 131
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 9% open · ⏱️ 22.08.2022): (Jupyter-Notebook工具)
- best-of-jupyter - GitHub - 24% open · ⏱️ 17.10.2023): (Notebook Tools)
README
# Jupyter :heart: Nix
This repository provides a Nix-based framework for the definition of
declarative and reproducible Jupyter environments. These environments
include JupyterLab - configurable with extensions - the classic notebook,
and configurable Jupyter kernels.
## Getting started
The following snippet will create a new project directory, initialize the project with a flake template, enable a Python kernel, and start the JupyterLab environment.
```shell
mkdir my-project
cd my-project
nix flake init --template github:tweag/jupyenv
nix run
```
After some time, you should see the following in your terminal. Your default web browser should open and enter the JupyterLab environment. If it does not, use one of the suggested URLs.
```shell
...
[I 2022-10-11 18:47:30.346 ServerApp] Jupyter Server 1.17.1 is running at:
[I 2022-10-11 18:47:30.346 ServerApp] http://localhost:8888/lab?token=8f2261a45601848bd79eda97d8d39c3d0f4978bc61fbe346
[I 2022-10-11 18:47:30.346 ServerApp] or http://127.0.0.1:8888/lab?token=8f2261a45601848bd79eda97d8d39c3d0f4978bc61fbe346
[I 2022-10-11 18:47:30.346 ServerApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 2022-10-11 18:47:30.359 ServerApp]
To access the server, open this file in a browser:
file:///home/bakerdn/.local/share/jupyter/runtime/jpserver-286971-open.html
Or copy and paste one of these URLs:
http://localhost:8888/lab?token=8f2261a45601848bd79eda97d8d39c3d0f4978bc61fbe346
or http://127.0.0.1:8888/lab?token=8f2261a45601848bd79eda97d8d39c3d0f4978bc61fbe346
```
## Documentation
See the [website](https://jupyenv.io/) for further instructions about the environment, kernels, and extensions.
## Contributing
PRs are welcome!
This project provides a development shell which you can enter with `nix develop`. Please run `pre-commit run -all` before submitting your pull request for review. This will run a nix formatter for consistency.
If you are new to contributing to open source, [this guide](https://opensource.guide/how-to-contribute/) helps explain why, what, and how to successfully get involved.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.