deploy: 397553f

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3af787d1d2c65c3178cea64fdf7ef74e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/index.rst.txt

@@ -0,0 +1,28 @@
+.. zap documentation master file, created by
+   sphinx-quickstart on Mon Nov 25 13:42:49 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. Add your content using ``reStructuredText`` syntax. See the
+   `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+   documentation for details.
+
+zap documentation
+=================
+
+**Zap**  is a Python library for for differentiable electricity system modeling.
+It provides a modular, component-based approach to building electricity models.
+Models can be solved using a GPU-accelerated ADMM solver, integrated into PyTorch-based deep learning models, or iteratively planned using gradient algorithms.
+
+.. note::
+
+   This project is under active development.
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   Home<self>
+   Quick Start<quickstart>
+   Basic Usage<basic>

_sources/quickstart.md.txt

@@ -0,0 +1,15 @@
+# Quickstart
+
+## 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
+```
+
+Alternatively, if you want to install zap with `pypsa` support, then run the following command (instead of the above).
+
+```zsh
+python3 -m pip install "zap[pypsa] @ git+https://github.com/degleris1/zap.git"  # With PyPSA
+```