Upload README.md

README.md

@@ -1,53 +1,66 @@
-# HVAC Load Calculator - Enhanced Version
+---
+title: HVAC Load Calculator
+emoji: 🔥❄️
+colorFrom: blue
+colorTo: indigo
+sdk: streamlit
+sdk_version: 1.32.0
+app_file: app.py
+pinned: false
+---
 
-## Overview
-This enhanced HVAC Load Calculator is a comprehensive tool for calculating cooling and heating loads in buildings. It provides a user-friendly interface for students, professionals, and HVAC enthusiasts to perform accurate load calculations without manual calculations.
+# HVAC Load Calculator
 
-## Enhancements
-This version includes several enhancements to the original calculator:
-
-1. **Fixed Window Shading Calculation** - Resolved the error when using external awning shading options
-2. **Scenario Comparison Functionality** - Added ability to save calculation results as scenarios and compare multiple scenarios
-3. **Customizable Appliances** - Users can specify quantities for both residential and commercial appliances and add custom heat sources
-4. **Component Editing** - Users can edit or delete walls, windows, and doors after adding them
-5. **Separate Internal Loads Tab** - Reorganized the heating calculator to match the cooling calculator structure
-6. **Attribution Information** - Added proper attribution to Dr. Majed Abuseif and purpose statement
+A modern web tool for calculating HVAC cooling and heating loads based on the ASHRAE method.
 
 ## Features
-- Separate calculators for cooling and heating loads
-- Step-by-step input forms with validation
-- Reference data for materials and locations
-- Visual results with charts and tables
-- Scenario comparison for analyzing different building configurations
-- Downloadable input data and results
-
-## Getting Started
-1. Install the required dependencies:
-   ```
-   pip install -r requirements.txt
-   ```
-
-2. Run the application:
-   ```
-   streamlit run app.py
-   ```
-
-## Usage
+
+- **Separate Calculators**: Independent cooling and heating load calculators
+- **Step-by-Step Input Forms**: Guided process with validation
+- **Reference Data**: Comprehensive material properties and location data
+- **Visual Results**: Charts and tables for load components
+- **Smart Validation**: Proceed with warnings rather than blocking progress
+- **Downloadable Data**: Export results for student assignments
+- **ASHRAE Method**: Implementation based on industry-standard calculation methods
+- **Extensible Design**: Framework for adding other calculation methods or locations
+
+## How to Use
+
 1. Select either the Cooling Load Calculator or Heating Load Calculator from the sidebar
-2. Fill in the building information and component details
-3. Add walls, windows, doors, and internal loads as needed
-4. View the calculation results
-5. Save scenarios for future comparison
-6. Use the Scenario Comparison page to compare different building configurations
-
-## Documentation
-See the documentation folder for detailed information about:
-- Application structure
-- Calculation methods
-- Reference data
-- Enhancement details
-
-## Credits
-Created by Dr. Majed Abuseif
-
-This tool was created to facilitate HVAC calculation and understanding for Deakin University students, but has been enhanced to cover wider aspects to allow professionals and energy and HVAC enthusiasts to use it.
+2. Fill in the required information in each step
+3. Review any warnings that appear (you can proceed with warnings)
+4. Calculate results and analyze the output
+5. Export results for your assignments
+
+## Cooling Load Calculator
+
+The cooling load calculator helps determine the amount of heat that needs to be removed from a space to maintain comfort conditions. It accounts for:
+
+- Conduction through building envelope
+- Solar radiation through windows
+- Internal heat gains (people, equipment, lighting)
+- Infiltration and ventilation
+
+## Heating Load Calculator
+
+The heating load calculator helps determine the amount of heat that needs to be added to a space to maintain comfort conditions. It accounts for:
+
+- Conduction through building envelope
+- Infiltration and ventilation
+- Annual heating energy requirements based on heating degree days
+
+## Technical Details
+
+- Built with Python and Streamlit
+- Modular design for extensibility
+- Comprehensive reference data based on ASHRAE standards
+- Visualization using Plotly
+- Data export in CSV and JSON formats
+
+## Educational Purpose
+
+This tool is designed for educational purposes to help students understand the factors that influence HVAC load calculations. It provides a practical way to apply theoretical knowledge and see how different building parameters affect heating and cooling requirements.
+
+## Acknowledgements
+
+Based on ASHRAE calculation methods for heating and cooling loads.