Skip to content

Revise tutorial instructions in getting-started.md #91

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

Merged
beykyle merged 1 commit into from
Sep 8, 2026
Merged

Revise tutorial instructions in getting-started.md #91

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
13 changes: 9 additions & 4 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,21 +47,26 @@ python -c "import jitr; print(jitr.__version__)"

## Examples and tutorials

Tutorials live in [`examples/notebooks/`](https://github.com/beykyle/jitr/tree/main/examples/notebooks) in the repository, and rendered copies are listed on the [examples page](examples/index.md). The best way to run them is to clone the repo and open them with the default `Python 3 (ipykernel)` kernel, which lives inside the uv-managed environment. This way, you can be sure that all the dependencies are correct and that the notebooks will run as expected. No kernel registration is needed.
Tutorials live in [`examples/notebooks/`](https://github.com/beykyle/jitr/tree/main/examples/notebooks) in the repository, and rendered copies are listed on the [examples page](examples/index.md). First, clone the repository and navigate to the project directory:

There are some additional requirements to run the examples. Once you've cloned the repo, from the main directory, run:
```
git clone https://github.com/beykyle/jitr.git
cd jitr
```

Before you can run the notebooks, there are some additional requirements which need to be installed into the environment. They live in the `examples` dependency group. To install them, from the main project directory, run:

```
uv sync --group examples
```

and start a JupyterLab server from the same directory:
Then, you can launch `jupyter` inside the uv-managed environment. For example, to spin up a JupyterLab server:

```
uv run --group examples jupyter lab
```

Then, you can run the notebooks.
Then, you can run the notebooks in-browser. See the [Advanced users and developers](advanced-users.md) page for more information about setting up a local editable installation of `jitr`, about [`uv`](https://docs.astral.sh/uv/), and other environment management related things.

### Quick start

Expand Down