Skip to content

Commit f5b4e10

Browse files
committed
docs: split windows and linux setup entirely
1 parent 1c7d666 commit f5b4e10

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

+31-10
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Python version 3.9, 3.10, or 3.11 (3.12 not yet supported).
1717
> This guide assists in setting up JupyterLab and Python dependencies.
1818
> If you're already comfortable with Python, feel free to use your preferred setup process.
1919
20-
First, fork and clone this repository, or download it manually to your computer.
20+
First, **fork and clone this repository**, or download it manually to your computer.
2121
Then open a terminal inside the repository and proceed.
2222

2323
### Linux / macOS setup
@@ -31,7 +31,7 @@ python3 --version
3131
2. Create a **virtual environment**:
3232

3333
```bash
34-
python3 -m virtualenv venv
34+
python3 -m venv venv
3535
```
3636

3737
3. **Activate** the virtual environment:
@@ -40,8 +40,30 @@ python3 -m virtualenv venv
4040
source venv/bin/activate
4141
```
4242

43+
4. **Install libraries**
44+
45+
With the virtual environment activated, **install the required dependencies**:
46+
47+
```
48+
pip install --upgrade pip
49+
pip install -r requirements.txt
50+
pip install jupyterlab
51+
```
52+
53+
5. **Start JupyterLab**:
54+
55+
```bash
56+
jupyter lab
57+
```
58+
59+
This should open a local web interface (or display a URL) for JupyterLab, where you can access the tutorial notebooks.
60+
61+
4362
### Windows setup
4463

64+
As an alternative **use WSL2** (Windows Subsystem for Linux) and apply the steps from the Linux step.
65+
Otherwise, continue:
66+
4567
1. Verify your **Python version**:
4668

4769
```shell
@@ -60,24 +82,23 @@ python -m venv venv
6082
venv\Scripts\activate
6183
```
6284

63-
As an alternative **use WSL2** (Windows Subsystem for Linux) and apply the steps from the Linux step.
64-
65-
### Installing libraries
85+
4. **Install libraries**
6686

6787
With the virtual environment activated, **install the required dependencies**:
6888

69-
```bash
89+
```
90+
pip install --upgrade pip
7091
pip install -r requirements.txt
7192
pip install jupyterlab
7293
```
7394

74-
To **start JupyterLab**:
95+
5. **Start JupyterLab**:
7596

7697
```bash
7798
jupyter lab
7899
```
79100

80-
This command should open a local web interface for JupyterLab, where you can access the tutorial notebooks.
101+
This command should open a local web interface (or display a URL) for JupyterLab, where you can access the tutorial notebooks.
81102

82103
### Docker
83104

@@ -103,7 +124,7 @@ If you are on Windows (without WSL), replace `"${PWD}"` with `%cd%`.
103124

104125
3. **Access** JupyterLab:
105126

106-
Open your browser and go to http://localhost:10000/lab?token=YOUR_TOKEN_IN_CONSOLE.
127+
Open your browser and go to http://localhost:10000/lab?token=YOUR_TOKEN_IN_CONSOLE (note the port `10000`).
107128
Replace `YOUR_TOKEN_IN_CONSOLE` with the token displayed in your terminal after running the container.
108129

109130

@@ -125,4 +146,4 @@ After completing the tutorials, create your own Jupyter notebook applying one of
125146

126147
1. **Select a domain**: choose a domain related to your group project (if already available) or a personal interest.
127148
2. **Create and name your notebook**: experiment with the chosen approach and save your notebook as `03_<YourProjectName>.ipynb`.
128-
3. **Push to your repository**: upload your completed notebook to your GitHub repository (including the output).
149+
3. **Push to your repository**: upload your completed notebook to your GitHub repository (_including_ the output).

0 commit comments

Comments
 (0)