documentation/user_guide.md

User Guide

Getting Started

Installation

1. Ensure you have Python 3.8 or higher installed
2. Install the required dependencies:

   pip install -r requirements.txt
   

3. Run the application:

   streamlit run app.py
   

Navigation

The application has three main sections accessible from the sidebar:

• Cooling Load Calculator: Calculate cooling loads for buildings
• Heating Load Calculator: Calculate heating loads for buildings
• Scenario Comparison: Compare saved calculation scenarios

Using the Calculators

Building Information

1. Select a location from the dropdown
2. Enter the indoor design temperature
3. Enter the building volume
4. Enter the air changes per hour

Adding Components

1. Walls, Roofs, and Floors:

   • Enter component details (area, U-value, orientation)
   • Click "Add Component"
   • To edit or delete components, use the buttons next to each entry

2. Windows and Doors:

   • Enter details (orientation, area, U-value, glass type, shading)
   • Click "Add Window/Door"
   • To edit or delete windows/doors, use the buttons next to each entry

3. Internal Loads:

   • Enter occupancy information
   • Specify lighting details
   • Add appliances with quantities
   • Add custom heat sources if needed

Calculating Results

1. Navigate through all tabs to enter required information
2. Click "Calculate" on the final tab
3. View the results including:
   • Total load in kW
   • Recommended system size
   • Load breakdown by component
   • Visualizations of heat gains/losses

Saving Scenarios

After calculating results:

1. Enter a scenario name and description
2. Click "Save Scenario"
3. The scenario will be saved for future comparison

Comparing Scenarios

1. Navigate to the "Scenario Comparison" page
2. Select the calculator type (cooling, heating, or all)
3. Select at least two scenarios to compare
4. Click "Compare Selected Scenarios"
5. View the comparison results:
   • Total load comparison
   • Load breakdown comparison
   • Differences between scenarios
   • Interpretation of results
6. Download the comparison data as CSV if needed

Tips for Effective Use

1. Base Case Analysis:

   • Create a base case scenario first
   • Make incremental changes for subsequent scenarios
   • Compare to see the impact of each change

2. Custom Heat Sources:

   • Use the custom heat sources feature for equipment not in the predefined list
   • Enter the name and wattage for each custom source

3. Component Editing:

   • You can edit or delete components after adding them
   • This allows for quick adjustments without starting over

4. Scenario Management:

   • Give descriptive names to scenarios
   • Add detailed descriptions to remember what each scenario represents
   • Use the comparison tool to identify the most efficient building configuration