Skip to content

Fix README and install script to run on Windows #78

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.

Sign up for GitHub

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

Open
raffaelemancuso wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix README and install script to run on Windows #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,17 @@ To download and run it, first ensure `uv` is installed (see Prerequisites above)

```bash
curl -LO https://raw.githubusercontent.com/intro-stat-learning/ISLP_labs/main/setup_notebook_env.py
uv run python setup_notebook_env.py --outdir ISLP_v2.2.2 --commit v2.2.2 --python-version 3.12
```

### 2. Run the setup script

Open your terminal and run the following command to set up the environment for version `v2.2.2` of the labs with Python `3.12`. You can also specify one or more notebooks to run automatically after setup.
Open your terminal and run the following command to set up the environment for version `v2.2.2` of the labs with Python `3.12`.

```
uv run python setup_notebook_env.py --outdir ISLP_v2.2.2 --commit v2.2.2 --python-version 3.12
```

You can also specify one or more notebooks to run automatically after setup.

* `--outdir ISLP_v2.2.2`: This will create a directory named `ISLP_v2.2.2` for your labs.
* `--commit v2.2.2`: This specifies that you want to use version `v2.2.2` of the labs.
Expand Down
7 changes: 4 additions & 3 deletions setup_notebook_env.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,11 @@ def setup_env(outdir,
run_command([uv_executable, 'venv', '--python', python_version, '--seed'], cwd=str(outdir))

print("Installing requirements...")
venv_dir = Path('.venv')
uv_bin = venv_dir / 'Scripts' if sys.platform == 'win32' else venv_dir / 'bin'
venv_dir = outdir / '.venv'
uv_bin = venv_dir / 'Scripts' if sys.platform == 'win32' else venv_dir / 'bin'
uv_pip = (uv_bin / 'pip').resolve()

run_command([str(uv_bin / 'pip'), 'install', '-r', 'requirements.txt', 'jupyterlab'], cwd=str(outdir))
run_command([str(uv_pip), 'install', '-r', 'requirements.txt', 'jupyterlab'], cwd=str(outdir))

if nbfiles:
if allow_errors:
Expand Down