docs/user_guide.md

HVAC Calculator User Guide

Introduction

Welcome to the HVAC Calculator, a comprehensive tool for calculating heating and cooling loads for buildings using ASHRAE methods. This user guide will help you navigate the application and perform accurate HVAC load calculations.

Table of Contents

1. Getting Started
2. Building Information
3. Climate Data
4. Building Components
5. Internal Loads
6. Calculation Results
7. Data Management
8. Export Options
9. Troubleshooting

Getting Started

System Requirements

• Modern web browser (Chrome, Firefox, Safari, or Edge)
• Internet connection (for initial loading)
• Screen resolution of at least 1280x720

Installation

The HVAC Calculator is a web-based application that can be accessed directly through your browser. No installation is required.

First-Time Setup

1. Open the application in your web browser
2. The sidebar navigation will guide you through the calculation process
3. Follow the steps in order: Building Information → Climate Data → Building Components → Internal Loads → Calculation Results

Building Information

The Building Information section is where you enter general information about your project and building.

Required Information

• Project Name: Name of your project
• Building Name: Name of the building
• Location: City or location of the building
• Climate Zone: ASHRAE climate zone (selected automatically based on location)
• Building Type: Type of building (e.g., Office, Residential, Educational)
• Floor Area: Total floor area in square meters
• Number of Floors: Number of floors in the building
• Floor Height: Average floor height in meters
• Building Orientation: Primary orientation of the building
• Occupancy: Number of occupants
• Operating Hours: Hours of operation

Design Conditions

• Summer Outdoor Dry-Bulb: Summer outdoor design temperature (°C)
• Summer Outdoor Wet-Bulb: Summer outdoor design wet-bulb temperature (°C)
• Summer Indoor Dry-Bulb: Summer indoor design temperature (°C)
• Summer Indoor RH: Summer indoor design relative humidity (%)
• Winter Outdoor Dry-Bulb: Winter outdoor design temperature (°C)
• Winter Outdoor RH: Winter outdoor design relative humidity (%)
• Winter Indoor Dry-Bulb: Winter indoor design temperature (°C)
• Winter Indoor RH: Winter indoor design relative humidity (%)

Tips

• Design conditions are automatically populated based on the selected location and climate zone
• You can override the default values if you have specific design requirements
• Click "Save Building Information" to proceed to the next step

Climate Data

The Climate Data section displays climate information for the selected location.

Available Data

• Design Conditions: Summer and winter design conditions
• Monthly Temperature Data: Average, maximum, and minimum temperatures for each month
• Humidity Data: Average relative humidity for each month
• Solar Radiation Data: Solar radiation data for different orientations

Tips

• Review the climate data to ensure it matches your project requirements
• The data is used in the cooling and heating load calculations
• Click "Confirm Climate Data" to proceed to the next step

Building Components

The Building Components section is where you define the building envelope components.

Component Types

• Walls: Exterior walls of the building
• Roofs: Roof surfaces of the building
• Floors: Floor surfaces in contact with the ground or unconditioned spaces
• Windows: Windows and glazed surfaces
• Doors: Exterior doors

Adding Components

1. Select the component type (Wall, Roof, Floor, Window, Door)
2. Choose a preset component or create a custom component
3. Enter the required information:
   • Name
   • Area
   • Orientation (for walls, windows, and doors)
   • U-value (thermal transmittance)
   • Additional properties specific to the component type
4. Click "Add Component" to add it to your project

U-Value Calculator

For custom components, you can use the U-Value Calculator:

1. Click "Calculate U-Value" to open the calculator
2. Add material layers one by one, specifying:
   • Material type
   • Thickness
3. The calculator will determine the overall U-value
4. Click "Use This U-Value" to apply it to your component

Editing and Deleting Components

• Click the edit icon next to a component to modify its properties
• Click the delete icon to remove a component from your project

Tips

• Add all exterior surfaces of the building
• Ensure that the total area of walls, roofs, and floors matches the building dimensions
• Windows and doors should be assigned to walls, and their area will be subtracted from the wall area
• Click "Save Components" to proceed to the next step

Internal Loads

The Internal Loads section is where you define the internal heat sources in the building.

Load Types

• People: Occupants in the building
• Lighting: Lighting systems
• Equipment: Electrical and mechanical equipment

Adding Internal Loads

1. Select the load type (People, Lighting, Equipment)
2. Enter the required information:
   • Name
   • Quantity (number of people or power in watts)
   • Activity level (for people)
   • Usage factor (for lighting and equipment)
   • Schedule (operating hours)
3. Click "Add Internal Load" to add it to your project

Tips

• Consider different zones or rooms with different occupancy or equipment
• The usage factor represents the percentage of time the load is active
• Click "Save Internal Loads" to proceed to the next step

Calculation Results

The Calculation Results section displays the results of the cooling and heating load calculations.

Summary Results

• Total Cooling Load: Total cooling capacity required (kW)
• Sensible Cooling Load: Sensible cooling capacity required (kW)
• Latent Cooling Load: Latent cooling capacity required (kW)
• Cooling Load per Area: Cooling load per unit area (W/m²)
• Total Heating Load: Total heating capacity required (kW)
• Heating Load per Area: Heating load per unit area (W/m²)

Detailed Results

• Component Breakdown: Contribution of each component to the total load
• Hourly Load Profiles: Variation of loads throughout the day
• Psychrometric Analysis: Psychrometric chart showing the cooling and heating processes

Visualization Options

• Summary: Overview of the calculation results
• Component Breakdown: Detailed breakdown by component
• Psychrometric Analysis: Psychrometric chart and analysis
• Time Analysis: Hourly and monthly load profiles
• Scenario Comparison: Comparison with saved scenarios

Tips

• Review the results to ensure they are reasonable
• Use the visualization options to better understand the load distribution
• Save the current results as a scenario for future comparison
• Click "Export Results" to export the results in various formats

Data Management

The Data Management section allows you to save and load projects.

Saving Projects

1. Enter a project name
2. Add a description (optional)
3. Click "Save Project"
4. Download the project file (.hvac) to your computer

Loading Projects

1. Click "Load Project"
2. Upload a previously saved project file (.hvac)
3. Click "Load Project Data" to restore the project

Project History

The Project History tab shows previously saved projects in the current session:

1. Click on a project in the history
2. View the project details
3. Click "Load Project" to restore the project
4. Click "Delete from History" to remove it from the history

Tips

• Save your project regularly to avoid losing work
• Use descriptive names and add detailed descriptions for easier identification
• The project history is only available in the current session

Export Options

The Export Options section allows you to export the calculation results in various formats.

Available Formats

• CSV: Export individual tables as CSV files
• Excel: Export comprehensive reports as Excel files
• JSON: Export scenarios as JSON files

Export Options

• CSV Export: Export individual tables (cooling load, heating load, component details)
• Excel Export: Export comprehensive reports with multiple sheets
• Scenario Export: Export saved scenarios for sharing or archiving

Batch Export

The Batch Export option allows you to export all saved scenarios at once:

1. Click "Export All Scenarios"
2. Download the ZIP file containing all scenarios

Tips

• Use CSV export for importing data into other applications
• Use Excel export for comprehensive reports
• Use JSON scenario export for sharing with other users of the HVAC Calculator

Troubleshooting

Common Issues

• Missing Inputs: Ensure all required fields are filled in
• Invalid Values: Check for unreasonable values (e.g., negative areas)
• Calculation Errors: Verify that all components are properly defined
• Export Issues: Check that you have permission to download files in your browser

Validation Messages

The application provides validation messages to help you identify and fix issues:

• Errors: Must be fixed before proceeding
• Warnings: Indicate potential issues but allow you to proceed

Getting Help

If you encounter issues not covered in this guide:

1. Check the Technical Documentation for more detailed information
2. Review the Code Documentation for implementation details
3. Contact support for assistance

Conclusion

This user guide provides an overview of the HVAC Calculator's features and functionality. For more detailed information, please refer to the Technical Documentation.

Thank you for using the HVAC Calculator!