Skip to content

Commit dd7f8c7

Browse files
committed
docs(readme)📝: improve quick start instructions for running notebooks
- Add step-by-step quick start guide for installing uv and running notebooks. - Clarify use of the --sandbox flag for isolated environments. - Update website reference for more detailed information.
1 parent 44d8152 commit dd7f8c7

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,26 @@ in a variety of formats (ranging from 1.5 hr to 4 hour long workshops).
1010
The material is designed for a live tutorial presentation,
1111
with the code available for you to reference afterwards.
1212

13-
## Getting Started
13+
## Quick Start
14+
15+
To get started with the notebooks, follow these simple steps:
16+
17+
1. **Install uv** (the Python package manager):
18+
Follow the installation instructions at [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/)
19+
20+
2. **Navigate to the notebook directory**:
21+
```bash
22+
cd notebooks/subdir/
23+
```
24+
25+
3. **Run the notebook**:
26+
```bash
27+
uvx marimo edit --sandbox <notebook_name>.py
28+
```
29+
30+
That's it! The `--sandbox` flag ensures a clean, isolated environment for running the notebooks.
1431

15-
Head over to [the official website][nams]!
32+
For more detailed information, head over to [the official website][nams]!
1633

1734
[nams]: https://ericmjl.github.io/Network-Analysis-Made-Simple
1835

0 commit comments

Comments
 (0)