aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Harrison <paul@harrison.sh>2025-08-18 13:25:01 +0100
committerPaul Harrison <paul@harrison.sh>2025-08-18 13:25:01 +0100
commitae7ba4c8cbdfa772e9c6eddc5af4f313872957a0 (patch)
tree49c7de811214d8e1de3fa71da3b2dd1d549c81ac /README.md
parent12241dbc3852415867f0b9e16c115cfe26c3476a (diff)
Switch from Jupyter to isolated Marimo notebooksHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 639d953..466aaff 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
# Analysis
A collection of one-off analyses on a variety of topics.
+
+## Usage
+
+Edit a notebook with
+
+```shell
+uvx marimo edit --sandbox --headless notebooks/notebook.py
+```
+
+Run a notebook as an app with
+
+```shell
+uvx marimo run --sandbox --headless notebooks/notebook.py
+```
+
+Convert a notebook to HTML with
+
+```shell
+uvx marimo export html notebooks/notebook.py -o outputs/notebook.html --sandbox --no-include-code
+```