ProfRick commited on
Commit
b2d4d27
·
verified ·
1 Parent(s): c8d233c

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -0
README.md ADDED
@@ -0,0 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: Homeostasis Explorer
3
+ emoji: 🫀
4
+ colorFrom: red
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ app_file: app.py
8
+ pinned: false
9
+ license: mit
10
+ ---
11
+
12
+ # Homeostasis Explorer
13
+
14
+ Interactive teaching app for visualizing how changes in **PaCO₂** affect **respiratory rate (RR)**, **pH**, and **cerebral blood flow (CBF)**. Designed for an online, asynchronous 300-level physiology course.
15
+
16
+ > **Student link (share this):**
17
+ > `https://<owner>-<space-name>.hf.space`
18
+ > Replace `<owner>-<space-name>` with your actual Space URL (e.g., `rick-hes-homeostasis-explorer.hf.space`).
19
+
20
+ ---
21
+
22
+ ## How to use (students)
23
+ 1. Open the link above.
24
+ 2. Move the **PaCO₂** slider (20–80 mmHg).
25
+ 3. Observe real-time updates to RR, pH, and CBF plus trend graphs.
26
+ 4. Use the display to answer guided questions in your worksheet or quiz.
27
+
28
+ ---
29
+
30
+ ## Instructor notes
31
+ - Coefficients are **illustrative** for teaching. Tweak them in `app.py` to match your model:
32
+ - RR: `RR = RR_base + 0.6 * (PaCO2 - 40)`
33
+ - pH: `pH = 7.40 - 0.01 * (PaCO2 - 40)`
34
+ - CBF (relative): `CBF = 1.0 * (1 + 0.015 * (PaCO2 - 40))`
35
+ - Suggested activities:
36
+ - Have students capture screenshots at PaCO₂ = 30, 40, 50, 60 mmHg and explain trends.
37
+ - Ask them to predict values before moving the slider, then verify and reflect on any mismatch.
38
+
39
+ ---
40
+
41
+ ## Files in this Space
42
+ - `app.py` — Streamlit app (main entry point).
43
+ - `requirements.txt` — minimal Python deps.
44
+ - `README.md` — this file.
45
+
46
+ If you see **“Welcome to Streamlit”** instead of the app:
47
+ - Ensure **Settings → SDK** is **Streamlit** and **App file** is exactly `app.py`.
48
+ - Confirm `app.py` exists at the repo root (or update **App file** to the correct path).
49
+
50
+ ---
51
+
52
+ ## Run locally (optional)
53
+ ```bash
54
+ python -m venv .venv && source .venv/bin/activate # Windows: .venv\Scripts\activate
55
+ pip install -r requirements.txt
56
+ streamlit run app.py