mabuseif commited on
Commit
e406acd
·
verified ·
1 Parent(s): 6cc22a6

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -80
README.md CHANGED
@@ -1,80 +1,13 @@
1
- # Enhanced HVAC Load Calculator
2
-
3
- ## Overview
4
- The Enhanced HVAC Load Calculator is a comprehensive tool for calculating cooling loads in buildings based on ASHRAE methods. This calculator provides accurate cooling load calculations, detailed visualizations, and multiple building comparison capabilities.
5
-
6
- ## Features
7
- - **Accurate ASHRAE Calculations**: Implements proper ASHRAE cooling load calculation methods with correction factors
8
- - **Internal Loads Improvements**: Properly accounts for activity levels in people heat gain calculations
9
- - **Enhanced Lighting Calculations**: Supports different lighting types with appropriate heat emission factors
10
- - **Improved Equipment Calculations**: Includes various equipment types with sensible and latent heat factors
11
- - **Monthly Breakdown**: Provides monthly cooling load and energy consumption calculations
12
- - **Interactive Visualizations**: Features multiple visualization options with Plotly charts
13
- - **Data Import/Export**: Supports JSON, CSV, PDF, and ZIP formats for data sharing
14
- - **Multiple Building Comparison**: Allows comparison of different building designs side by side
15
-
16
- ## Installation
17
-
18
- ### Requirements
19
- - Python 3.8 or higher
20
- - Streamlit 1.30.0 or higher
21
- - Other dependencies listed in requirements.txt
22
-
23
- ### Setup
24
- 1. Clone the repository or extract the ZIP archive
25
- 2. Install dependencies:
26
- ```
27
- pip install -r requirements.txt
28
- ```
29
- 3. Run the application:
30
- ```
31
- streamlit run app/main.py
32
- ```
33
-
34
- ## Usage
35
-
36
- ### Building Information
37
- 1. Create a new building or load an existing one
38
- 2. Enter building information (name, location, dimensions)
39
- 3. Add walls, roof, and glass components with appropriate properties
40
-
41
- ### Internal Loads
42
- 1. Configure people, lighting, and equipment loads
43
- 2. Select appropriate activity levels, lighting types, and equipment types
44
-
45
- ### Calculation
46
- 1. Navigate to the Results page
47
- 2. Click "Calculate Cooling Load" to perform calculations
48
- 3. View detailed results with interactive visualizations
49
-
50
- ### Multiple Buildings
51
- 1. Save multiple building configurations
52
- 2. Use the Building Manager to manage buildings
53
- 3. Compare buildings side by side with various visualization options
54
-
55
- ### Data Import/Export
56
- 1. Export building data, results, or complete projects
57
- 2. Import previously saved buildings or projects
58
-
59
- ## Project Structure
60
- - `app/`: Main application files
61
- - `models/`: Data models for building components
62
- - `controllers/`: Business logic and calculation methods
63
- - `views/`: UI components and visualization
64
- - `utils/`: Utility functions and helpers
65
- - `data/`: ASHRAE tables and reference data
66
- - `tests/`: Test cases and debugging scripts
67
-
68
- ## Testing
69
- Run the tests to verify the calculator's functionality:
70
- ```
71
- python tests/debug.py
72
- ```
73
-
74
- ## License
75
- This software is provided for educational and professional use.
76
-
77
- ## Acknowledgements
78
- - ASHRAE for providing the cooling load calculation methods and tables
79
- - Streamlit for the web application framework
80
- - Plotly for interactive visualizations
 
1
+ ---
2
+ name: hvac-calculator
3
+ title: HVAC Load Calculator
4
+ emoji: 🌡️
5
+ colorFrom: blue
6
+ colorTo: green
7
+ sdk: streamlit
8
+ sdk_version: 1.28.0
9
+ app_file: app/main.py
10
+ pinned: false
11
+ ---
12
+
13
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference