Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,15 @@ core test suite.
*Planned (not in v0.8): Plotly interactivity, a `K(r, t)` time-slider
animation, and multi-file comparison — see [`app/README.md`](app/README.md).*

### Deploy (Streamlit Community Cloud)

The app deploys on [Streamlit Community Cloud](https://share.streamlit.io) with
no extra setup: point a new app at **`app/streamlit_app.py`** on the **`main`**
branch. Dependencies install from the repo-root **`requirements.txt`** (the
package + its `gui` extra; `runtime.txt` pins Python 3.12). The app resolves the
bundled `examples/*.npz` from its own file location, so the example dropdown
works in the cloud sandbox. Every push to `main` triggers an automatic redeploy.

## 2D kernels

2D input `K(x, y, t)` is handled by **radial reduction with full-2D moments**:
Expand Down
18 changes: 18 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Streamlit Community Cloud installs the app's dependencies from this file.
#
# Install the package itself with its `gui` extra, from the repo root. This
# pulls the runtime deps (numpy, scipy, matplotlib) + streamlit, plus the
# kernel_viewer / stateflow packages, in one line.
#
# yupi is intentionally NOT listed: it is only the `examples` extra used by the
# offline data generator (examples/generate_yupi_examples.py). The deployed app
# loads the committed examples/*.npz and never imports yupi.
#
# If a Streamlit Cloud image rejects the editable install, replace the line
# below with the explicit, non-editable form:
# numpy>=1.24
# scipy>=1.10
# matplotlib>=3.7
# streamlit>=1.30
# .
-e .[gui]
1 change: 1 addition & 0 deletions runtime.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
python-3.12
Loading