EricCRX commited on
Commit
4d4b548
verified
1 Parent(s): 6b1660c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -0
README.md CHANGED
@@ -8,5 +8,46 @@ sdk_version: 5.47.2
8
  app_file: app.py
9
  pinned: false
10
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
8
  app_file: app.py
9
  pinned: false
10
  ---
11
+ # Simply Supported Beam Calculator (with Natural Language Explanation)
12
+
13
+ This Gradio app demonstrates a **deterministic first-principles calculator** for a simply supported beam with a **centered point load**.
14
+
15
+ ## Features
16
+ - Deterministic backend formulas:
17
+ - Maximum bending moment: M = P路L / 4
18
+ - Maximum stress: 蟽 = M路c / I
19
+ - Midspan deflection: 未 = P路L鲁 / (48路E路I)
20
+ - **Input validation** with clear ranges and units.
21
+ - **Structured JSON record** showing all assumptions, inputs, formulas, and results.
22
+ - **Natural language explanation**: results are contextualized by an LLM pipeline (Flan-T5) or fallback template.
23
+ - User-facing Gradio interface with:
24
+ - Numerical results table
25
+ - Explanation panel
26
+ - JSON record panel
27
+
28
+ ## Inputs
29
+ - L (m): span length
30
+ - P (kN): center point load
31
+ - E (GPa): elastic modulus
32
+ - I (cm^4): second moment of area
33
+ - c (cm): extreme fiber distance
34
+ - Optional: allowable stress (蟽_allow), yield strength (fy), safety factor (n)
35
+
36
+ ## Outputs
37
+ - Numerical results: bending moment, stress, deflection, utilization, pass/fail
38
+ - Explanation text
39
+ - Structured JSON (for reproducibility and transparency)
40
+
41
+ ## Limitations
42
+ - Only valid for simply supported beams with a single center load.
43
+ - Small deflection theory, linear elastic, prismatic section.
44
+ - Users must provide correct I and c (from section properties).
45
+
46
+ ---
47
+
48
+ ### How to run locally
49
+ ```bash
50
+ pip install -r requirements.txt
51
+ python app.py
52
 
53
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference