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

Update README.md #7601

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,105 @@ Launch with:
```bash
jupyter notebook
```
## Installation

### Platform-Specific Installation

#### Windows
1. **Using pip (recommended)**
- Install Python first from [Python Downloads](https://www.python.org/downloads/windows/)
- Be sure to check "Add Python to PATH" during installation.
- Open Command Prompt as Administrator and run:
```bash
pip install notebook
```
2. **Using Microsoft Store**
- Search for "Python" in the Microsoft Store
- Install Python 3.x
- Open Command Prompt and run:
```bash
pip install notebook
```

#### macOS
1. **Using pip**
Install Python first if not already installed
- **Option 1**: Download from [Python Downloads](https://www.python.org/downloads/mac-osx/)
- **Option 2**: Using Homebrew
```bash
brew install python
```
Then install Jupyter Notebook:
```bash
pip install notebook
```
2. **Using Homebrew directly**
```bash
brew install jupyter
```

#### Linux
1. **Debian/Ubuntu**
```bash
sudo apt update
sudo apt install python3-pip
pip3 install notebook
```
2. **Fedora/RHEL/CentOS**
```bash
sudo dnf install python3-pip
pip3 install notebook
```

### Using Conda

Conda is recommended if you need to manage multiple Python environments:
- Install Miniconda or Anaconda first from [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
- Create a new environment (recommended):
```bash
conda create -n jupyter-env python=3.9
conda activate jupyter-env
```
- Install Jupyter Notebook:
```bash
conda install -c conda-forge notebook
```

### Common Installation Issues and Solutions

1. **Permission Errors**
- **Windows**: Run Command Prompt as Administrator
- **macOS/Linux**: Use `sudo pip install notebook` or `pip install --user notebook`

2. **Outdated pip**
- Update pip before installation:
```bash
python -m pip install --upgrade pip
```

3. **"Command not found" after installation**
- Make sure Python's script directory is in your PATH
- **Windows**: Try `py -m notebook` instead of `jupyter notebook`
- **macOS/Linux**: Try `python3 -m notebook`

4. **Jupyter command not working after installation**
- Try running:
```bash
python -m notebook
```

5. **Dependency conflicts**
- Use virtual environments:
```bash
python -m venv jupyter-venv
# On Windows
jupyter-venv\Scripts\activate
# On macOS/Linux
source jupyter-venv/bin/activate
pip install notebook
```

For additional help, visit our [troubleshooting guide](https://jupyter-notebook.readthedocs.io/en/stable/troubleshooting.html) or ask questions on the [Jupyter Community Forum](https://discourse.jupyter.org/).

### Running in a remote installation

Expand Down Expand Up @@ -132,3 +231,4 @@ to indicate the copyright and license terms:
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
```
Add enhanced installation instructions
Loading