Merge remote-tracking branch 'origin/main' into power_target

.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+# name: "Sphinx: Render docs"
+
+name: documentation
+
+on: push
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pandoc
+        uses: r-lib/actions/setup-pandoc@v2
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Setup Poetry
+        uses: snok/install-poetry@v1
+      - name: Install Dependencies
+        run: poetry install --with=docs --without=experiment
+
+      - name: Sphinx build
+        run: poetry run sphinx-build docs/source _build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

.gitignore

@@ -3,6 +3,7 @@ data/
 data
 wandb/
 wandb
+build/
 
 # Ray
 .prometheus*/

README.md

@@ -1,24 +1,14 @@
 # zap ⚡
 
 
+## Documentation
 
+See the [documentation page](https://degleris1.github.io/zap/) for installation, basic usage, and examples.
 
-## Installation
 
-We recommend using `pip` to install directly from Github.
 
-```zsh
-python3 -m pip install "zap @ git+https://github.com/degleris1/zap.git"  # No PyPSA
-```
-
-Dependency on `pypsa` is optional.
-This can be installed by running the following command (instead of the above).
-
-```zsh
-python3 -m pip install "zap[pypsa] @ git+https://github.com/degleris1/zap.git"  # With PyPSA
-```
 
-### Developer Setup
+## Developer Setup
 
 For developers, we recommend installing [poetry](https://python-poetry.org/docs/).
 Then clone the repo and install depedencies:
@@ -35,13 +25,6 @@ Then run Python from the subshell.
 
 
 
-## Basic Usage
-
-Please download the Marimo notebook [here](https://github.com/degleris1/zap/blob/main/demo/01_basics.html).
-
-
-
-
 ## Reproducing Experiments
 
 To reproduce experiments from our published work, use the [developer setup](#developer-setup).