Skip to content

Commit 2868d92

Browse files
committed
Add Jupyter installation information
1 parent ee95a62 commit 2868d92

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

wiki/New-Workspace-Setup.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Optionally, some functions will be limited without:
1414
1. [Doxygen](#doxygen)
1515
2. [ShellCheck](#shellcheck)
1616
3. [mdBook](#mdBook)
17+
4. [Jupyter](#jupyter)
1718

1819
**Notes**:
1920
1. It is [**recommended**](https://github.com/JacquesCarette/Drasil/issues/2913#issuecomment-987300398) for Windows users to install the following tools using Linux on Windows/Windows WSL. If you choose to install using Windows WSL, you can safely ignore all Windows installation notes (except for that regarding Unicode support), and follow the instructions for Linux machines with the *apt*-package manager (e.g., Debian, Ubuntu, etc). From experience, installations with Windows WSL over native installations provide better tools, quicker installs, and an overall smoother experience.
@@ -595,5 +596,21 @@ cargo install mdbook
595596

596597
</details>
597598

599+
## Jupyter
600+
601+
[Jupyter(Lab)](https://jupyter.org/) is a web-based integrated development environment for developing computational documents, well-suited for researchers and students. We do not necessarily use Jupyter ourselves in Drasil's development, but we currently generate Jupyter documents (including lesson plans) and intend to generate more.
602+
603+
### Installation Instructions
604+
605+
Installing Jupyter is fairly straightforward using Python's package manager, `pip`. You only need to run the following command:
606+
607+
```
608+
pip install jupyter
609+
```
610+
611+
Alternatively, you can use copies of Jupyter from other package managers (e.g., via Homebrew: `brew install jupyter`, via `apt`: `sudo apt-get install jupyter`, etc.). For more information, please see the official Jupyter [installation documentation](https://jupyter.org/install).
612+
613+
To test that your installation is working, you should be able to run `jupyter --help` and see basic usage information.
614+
598615
# Working with Drasil
599-
Congratulations! Now that you've successfully setup your workspace, you should move on to our [Contributer's Guide](https://github.com/JacquesCarette/Drasil/wiki/Contributor's-Guide).
616+
Congratulations! Now that you've successfully setup your workspace, you should move on to our [Contributer's Guide](https://github.com/JacquesCarette/Drasil/wiki/Contributor's-Guide).

0 commit comments

Comments
 (0)