Update app/intro.py

app/intro.py

@@ -16,7 +16,6 @@ import io
 import logging
 from datetime import datetime
 from typing import Dict, Any, Optional
-from app.m_c_data import SAMPLE_MATERIALS, SAMPLE_FENESTRATIONS, SAMPLE_CONSTRUCTIONS
 
 # Configure logging
 logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
@@ -51,31 +50,36 @@ def display_about_section():
     st.markdown("""
     ### Overview
     
-    BuildSustain is a comprehensive tool for calculating heating and cooling loads for buildings
-    using the ASHRAE Transfer Function Method (TFM) and Conduction Transfer Function (CTF) approaches.
+    BuildSustain is a web-based tool developed by Dr. Majed Abuseif at Deakin University’s School of 
+    Architecture and Built Environment. It enables students and professionals to perform energy 
+    simulations, calculate heating and cooling loads using ASHRAE-standard methods, and analyze 
+    embodied energy and material costs for sustainable building design.
     
-    ### Features
+    ### Purpose
     
-    * **Building Information**: Define basic building parameters
-    * **Climate Data**: Import EPW weather files for location-specific calculations
-    * **Material Library**: Access and customize building materials and fenestrations
-    * **Construction Library**: Create and manage multi-layer constructions
-    * **Building Components**: Define walls, roofs, floors, windows, doors, and skylights
-    * **Internal Loads**: Account for people, lighting, and equipment heat gains
-    * **HVAC Loads**: Calculate cooling and heating loads using ASHRAE methods
-    * **Building Energy**: Estimate energy consumption based on HVAC system efficiency
-    * **Renewable Energy**: Size PV systems for net-zero energy goals
-    * **Embodied Energy**: Calculate the embodied carbon of building materials
-    * **Materials Cost**: Estimate construction material costs
+    Designed as a learning platform, BuildSustain helps users understand building physics, apply 
+    industry-standard calculations, and explore sustainable design strategies. It bridges theoretical 
+    concepts with practical applications, preparing users for careers in architecture, engineering, 
+    and sustainability.
+    
+    ### Key Features
+    
+    - **Energy Simulations**: Calculate HVAC loads using ASHRAE Transfer Function Method (TFM) and 
+      Conduction Transfer Function (CTF).
+    - **Sustainability Analysis**: Estimate embodied carbon, renewable energy options, and material costs.
+    - **Climate Resilience**: Model future climate scenarios with RCP projections.
+    - **User-Friendly Interface**: Intuitive navigation for students to experiment with design parameters.
     
     ### Development
     
-    This app was developed by Dr. Majed Abuseif at Deakin University’s School of Architecture and Built Environment. 
-    It is a powerful tool for students and professionals, enabling precise building sustainability calculations with a focus on climate change projections and sustainable design.
+    Created by Dr. Majed Abuseif, BuildSustain is a powerful educational tool for precise sustainability 
+    calculations, focusing on climate change resilience and energy-efficient design.
     
     ### Version
     
     Beta Version 0.4.1 (2025)
+    
+    For detailed guidance, refer to the [BuildSustain Student User Guide](BuildSustain_Student_User_Guide.markdown).
     """)
 
 def display_instructions_section():
@@ -85,33 +89,38 @@ def display_instructions_section():
     st.markdown("""
     ### Getting Started
     
-    1. **Create a New Project**: Start by entering basic building information
-    2. **Import Climate Data**: Upload an EPW file or select from available locations
-    3. **Define Materials**: Use the library or create custom materials
-    4. **Create Constructions**: Define wall, roof, and floor assemblies
-    5. **Add Building Components**: Specify the building envelope components
-    6. **Define Internal Loads**: Add occupancy, lighting, and equipment
-    7. **Calculate Loads**: Generate cooling and heating load results
-    8. **Explore Additional Analyses**: Energy consumption, renewable energy, embodied carbon, and cost
+    BuildSustain is a step-by-step tool for sustainable building design. Follow the sidebar navigation 
+    to progress through the modules in order:
     
-    ### Navigation
+    1. **Start a Project**: Use the Project Management tab to create a new project or import an existing one.
+    2. **Enter Building Information**: Define project name, building type, dimensions, and indoor conditions.
+    3. **Manage Climate Data**: Upload an EPW file or select a future climate projection.
+    4. **Define Materials and Fenestrations**: Use or customize material and window properties.
+    5. **Create Constructions**: Build multi-layer assemblies for walls, roofs, and floors.
+    6. **Add Building Components**: Specify envelope elements like walls, windows, and skylights.
+    7. **Set Internal Loads**: Define occupant, lighting, and equipment heat gains with schedules.
+    8. **Calculate HVAC Loads**: Run simulations to analyze heating and cooling requirements.
     
-    Use the sidebar to navigate between different sections of the application. You can go back to previous
-    sections at any time to modify inputs.
+    ### Navigation
     
-    ### Saving Your Work
+    - Use the sidebar to access modules (e.g., Building Information, HVAC Loads).
+    - Follow “Back” and “Continue” buttons to move sequentially.
+    - Save progress using the Project Management tab (export as JSON).
     
-    Use the Project Management tab to save your project as a JSON file that can be imported later to
-    continue your work.
+    ### Learning Tips
     
-    ### Calculation Methods
+    - Experiment with inputs (e.g., insulation thickness, window SHGC) to see their impact on energy loads.
+    - Review the [BuildSustain Student User Guide](BuildSustain_Student_User_Guide.markdown) for detailed 
+      steps and equations.
+    - Use the ASHRAE Handbook link in the sidebar for reference.
     
-    BuildSustain uses the following ASHRAE-approved methods:
+    ### Key Methods
     
-    * **Conduction Transfer Function (CTF)**: For transient heat transfer through opaque surfaces
-    * **Transfer Function Method (TFM)**: For calculating cooling and heating loads
-    * **Sol-Air Temperature**: For solar radiation effects on opaque surfaces
-    * **Dynamic Solar Heat Gain**: For fenestration with angle-dependent properties
+    BuildSustain uses ASHRAE-approved methods:
+    - **Conduction Transfer Function (CTF)**: For heat transfer through opaque surfaces.
+    - **Transfer Function Method (TFM)**: For HVAC load calculations.
+    - **Solar Heat Gain**: For dynamic fenestration analysis.
+    - **Adaptive Comfort**: For energy-efficient indoor condition settings.
     """)
 
 def display_project_management_section():
@@ -144,7 +153,7 @@ def display_project_management_section():
                 st.warning("Please enter a project name in the Building Information section before exporting.")
 
 def start_new_project():
-    """Initialize a new project by resetting project-specific data while preserving library data."""
+    """Initialize a new project by resetting the project_data in session state."""
     # Keep a backup of the current project data in case user wants to recover
     if 'project_data_backup' not in st.session_state:
         st.session_state.project_data_backup = {}
@@ -154,78 +163,31 @@ def start_new_project():
         backup_timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
         st.session_state.project_data_backup[backup_timestamp] = st.session_state.project_data.copy()
     
-    # Preserve library data from current session state or initialize with defaults
-    library_data = {
-        "materials": st.session_state.project_data.get("materials", {}).get("library", dict(SAMPLE_MATERIALS)),
-        "fenestrations": st.session_state.project_data.get("fenestrations", {}).get("library", dict(SAMPLE_FENESTRATIONS)),
-        "constructions": st.session_state.project_data.get("constructions", {}).get("library", dict(SAMPLE_CONSTRUCTIONS))
-    }
-    
-    # Reset project data to match main.py structure
+    # Reset project data to default values
     st.session_state.project_data = {
         "project_name": "",
         "building_info": {
             "project_name": "",
             "floor_area": 100.0,
             "building_height": 3.0,
-            "building_type": "Office",
-            "summer_indoor_design_temp": 24.0,
-            "summer_indoor_design_rh": 50.0,
-            "winter_indoor_design_temp": 20.0,
-            "winter_indoor_design_rh": 50.0,
-            "orientation_angle": 0.0
-        },
-        "climate_data": {
-            "id": "",
-            "location": {
-                "city": "",
-                "state_province": "",
-                "country": "",
-                "source": "",
-                "wmo": "",
-                "latitude": 0.0,
-                "longitude": 0.0,
-                "timezone": 0.0,
-                "elevation": 0.0
-            },
-            "design_conditions": {
-                "winter_design_temp": 0.0,
-                "summer_design_temp_db": 30.0,
-                "summer_design_temp_wb": 25.0,
-                "heating_degree_days": 0,
-                "cooling_degree_days": 0,
-                "monthly_average_temps": [20.0] * 12,
-                "monthly_average_radiation": [150.0] * 12,
-                "summer_daily_range": 8.0,
-                "wind_speed": 3.0,
-                "pressure": 101325.0
-            },
-            "climate_zone": "",
-            "hourly_data": [],
-            "epw_filename": "",
-            "typical_extreme_periods": {
-                "summer_extreme": {"start": {"month": 7, "day": 1}, "end": {"month": 7, "day": 7}},
-                "summer_typical": {"start": {"month": 6, "day": 1}, "end": {"month": 6, "day": 7}},
-                "winter_extreme": {"start": {"month": 1, "day": 1}, "end": {"month": 1, "day": 7}},
-                "winter_typical": {"start": {"month": 12, "day": 1}, "end": {"month": 12, "day": 7}}
-            },
-            "ground_temperatures": {
-                "0.5": [20.0] * 12,
-                "2": [18.0] * 12,
-                "4": [16.0] * 12
-            },
-            "ground_reflectivity": 0.2
+            "indoor_design_temp": 24.0,
+            "indoor_design_rh": 50.0,
+            "ventilation_rate": 0.1,
+            "orientation_angle": 0.0,
+            "operation_hours": 8,
+            "building_type": "Office"
         },
+        "climate_data": {},
         "materials": {
-            "library": library_data["materials"],
+            "library": {},
             "project": {}
         },
         "fenestrations": {
-            "library": library_data["fenestrations"],
+            "library": {},
             "project": {}
         },
         "constructions": {
-            "library": library_data["constructions"],
+            "library": {},
             "project": {}
         },
         "components": {
@@ -233,74 +195,27 @@ def start_new_project():
             "roofs": [],
             "floors": [],
             "windows": [],
+            "doors": [],
             "skylights": []
         },
         "internal_loads": {
-            "schedules": {},
             "people": [],
-            "lighting": [],
-            "equipment": [],
-            "ventilation": [],
-            "infiltration": []
-        },
-        "internal_loads_conditions": {
-            "air_velocity": 0.1,
-            "lighting_convective_fraction": 0.5,
-            "lighting_radiative_fraction": 0.5,
-            "equipment_convective_fraction": 0.5,
-            "equipment_radiative_fraction": 0.5
+            "lighting": {},
+            "equipment": {}
         },
         "hvac_loads": {
             "cooling": {
                 "hourly": [],
-                "peak": 0.0,
+                "peak": 0,
                 "summary_tables": {},
-                "charts": {
-                    "pie_by_component": {},
-                    "pie_by_orientation": {}
-                },
-                "breakdown": {
-                    "conduction": 0.0,
-                    "solar": 0.0,
-                    "internal": 0.0,
-                    "ventilation_sensible": 0.0,
-                    "ventilation_latent": 0.0,
-                    "infiltration_sensible": 0.0,
-                    "infiltration_latent": 0.0
-                }
+                "charts": {}
             },
             "heating": {
                 "hourly": [],
-                "peak": 0.0,
+                "peak": 0,
                 "summary_tables": {},
-                "charts": {
-                    "pie_by_component": {},
-                    "pie_by_orientation": {}
-                },
-                "breakdown": {
-                    "conduction": 0.0,
-                    "ventilation": 0.0,
-                    "infiltration": 0.0
-                }
-            },
-            "monthly_summary": {}
-        },
-        "hvac_settings": {
-            "operating_hours": [{"start": 8, "end": 18}],
-            "system_type": "Default"
-        },
-        "sim_period": {
-            "type": "Full Year",
-            "start_date": datetime(2025, 1, 1),
-            "end_date": datetime(2025, 12, 31),
-            "base_temp": 18.3
-        },
-        "indoor_conditions": {
-            "type": "Fixed Setpoints",
-            "cooling_setpoint": {"temperature": 24.0, "rh": 50.0},
-            "heating_setpoint": {"temperature": 20.0, "rh": 50.0},
-            "adaptive_acceptability": "90",
-            "schedule": []
+                "charts": {}
+            }
         },
         "building_energy": {
             "hvac_type": "",
@@ -324,18 +239,16 @@ def start_new_project():
         "embodied_energy": {
             "total_embodied_carbon_kgco2e": 0,
             "breakdown_by_component": {},
-            "charts": {},
-            "material_inventory": []
+            "charts": {}
         },
         "materials_cost": {
             "total_cost_usd": 0,
             "breakdown_by_component": {},
-            "charts": {},
-            "material_inventory": []
+            "charts": {}
         }
     }
     
-    logger.info("New project initialized with preserved library data")
+    logger.info("New project initialized")
 
 def load_project(uploaded_file) -> bool:
     """
@@ -366,12 +279,6 @@ def load_project(uploaded_file) -> bool:
             backup_timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
             st.session_state.project_data_backup[backup_timestamp] = st.session_state.project_data.copy()
         
-        # Convert datetime strings back to datetime objects if necessary
-        if project_data.get("sim_period", {}).get("start_date"):
-            project_data["sim_period"]["start_date"] = datetime.fromisoformat(project_data["sim_period"]["start_date"])
-        if project_data.get("sim_period", {}).get("end_date"):
-            project_data["sim_period"]["end_date"] = datetime.fromisoformat(project_data["sim_period"]["end_date"])
-        
         # Update session state with the loaded project data
         st.session_state.project_data = project_data
         
@@ -394,7 +301,6 @@ def validate_project_data(project_data: Dict[str, Any]) -> bool:
     """
     # Check for required top-level keys
     required_keys = [
-        "project_name",
         "building_info",
         "climate_data",
         "materials",
@@ -402,11 +308,7 @@ def validate_project_data(project_data: Dict[str, Any]) -> bool:
         "constructions",
         "components",
         "internal_loads",
-        "internal_loads_conditions",
         "hvac_loads",
-        "hvac_settings",
-        "sim_period",
-        "indoor_conditions",
         "building_energy",
         "renewable_energy",
         "embodied_energy",
@@ -423,12 +325,11 @@ def validate_project_data(project_data: Dict[str, Any]) -> bool:
         "project_name",
         "floor_area",
         "building_height",
-        "building_type",
-        "summer_indoor_design_temp",
-        "summer_indoor_design_rh",
-        "winter_indoor_design_temp",
-        "winter_indoor_design_rh",
-        "orientation_angle"
+        "indoor_design_temp",
+        "indoor_design_rh",
+        "orientation_angle",
+        "operation_hours",
+        "building_type"
     ]
     
     for key in building_info_keys:
@@ -436,26 +337,8 @@ def validate_project_data(project_data: Dict[str, Any]) -> bool:
             logger.error(f"Missing required key in building_info: {key}")
             return False
     
-    # Check climate_data structure
-    climate_data_keys = [
-        "id",
-        "location",
-        "design_conditions",
-        "climate_zone",
-        "hourly_data",
-        "epw_filename",
-        "typical_extreme_periods",
-        "ground_temperatures",
-        "ground_reflectivity"
-    ]
-    
-    for key in climate_data_keys:
-        if key not in project_data["climate_data"]:
-            logger.error(f"Missing required key in climate_data: {key}")
-            return False
-    
     # Check components structure
-    component_types = ["walls", "roofs", "floors", "windows", "skylights"]
+    component_types = ["walls", "roofs", "floors", "windows", "doors", "skylights"]
     for component_type in component_types:
         if component_type not in project_data["components"]:
             logger.error(f"Missing component type in components: {component_type}")
@@ -472,20 +355,11 @@ def validate_project_data(project_data: Dict[str, Any]) -> bool:
 def export_project():
     """Export the current project as a downloadable JSON file."""
     try:
-        # Create a deep copy of project data to avoid modifying session state
-        project_data = st.session_state.project_data.copy()
-        
-        # Convert datetime objects to ISO format strings for JSON serialization
-        if project_data.get("sim_period", {}).get("start_date"):
-            project_data["sim_period"]["start_date"] = project_data["sim_period"]["start_date"].isoformat()
-        if project_data.get("sim_period", {}).get("end_date"):
-            project_data["sim_period"]["end_date"] = project_data["sim_period"]["end_date"].isoformat()
-        
         # Convert project data to JSON
-        project_json = json.dumps(project_data, indent=2)
+        project_json = json.dumps(st.session_state.project_data, indent=2)
         
         # Generate filename based on project name
-        project_name = project_data.get("project_name", "unnamed_project")
+        project_name = st.session_state.project_data.get("project_name", "unnamed_project")
         safe_project_name = "".join(c if c.isalnum() else "_" for c in project_name)
         timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
         filename = f"{safe_project_name}_{timestamp}.json"