Merge pull request #57 from danielballan/how-to-run

Explain how to launch executable tutorials.

Author: bsipocz

conf.py

@@ -14,6 +14,7 @@
 extensions = [
     "myst_nb",
     "sphinx_copybutton",
+    "sphinx_design",
 ]
 
 myst_enable_extensions = [

index.md

@@ -1,5 +1,53 @@
 # Executable Tutorials Repo setup best practices
 
+## How to Run The Code Yourself
+
+`````{tab-set}
+````{tab-item} Locally with pixi
+
+Clone the repository and launch JupyterLab.
+
+```sh
+git clone https://github.com/scientific-python/executable-tutorials
+cd executable-tutorials
+
+pixi run start
+```
+````
+
+````{tab-item} Locally with pip
+
+Clone the repository, create an enviornment, install the requirements, and
+launch JupyterLab.
+
+
+```sh
+git clone https://github.com/scientific-python/executable-tutorials
+cd executable-tutorials
+
+python -m venv .venv
+source .venv/bin/activate
+
+pip install -r requirements.txt
+jupyter lab
+```
+````
+
+````{tab-item} In Cloud with Binder
+
+[Open on Binder][].
+
+````
+
+````{tab-item} JupyterLite (experimental)
+
+[Open with JupyterLite][].
+
+````
+`````
+
+Or, instead of _running_ the code, you may view the code and results by
+following the links below.
 
 ## Example Tutorials
 
@@ -26,3 +74,6 @@ caption: Contributing
 contributing
 maintainer-guide
 ```
+
+[Open on Binder]: https://mybinder.org/v2/gh/scientific-python/executable-tutorials/main?urlpath=tree/tutorials/
+[Open with JupyterLite]: https://scientific-python.github.io/executable-tutorials/jupyterlite/lab/index.html

pixi.toml

@@ -46,6 +46,7 @@ myst-nb = ">=1.1"
 jupytext = ">=1.16"
 sphinx-book-theme = ">=1.1"
 sphinx-copybutton = ">=0.5"
+sphinx-design = "*"
 pytest-custom_exit_code = "*"
 
 [feature.py312.dependencies]

requirements.txt

@@ -2,6 +2,7 @@
 sphinx
 myst-nb
 sphinx-book-theme
+sphinx-design
 ipympl
 sphinx-copybutton
 # For tutorials