analyze-rooms

Analyze Revit Rooms & Spaces

Perform room/space analysis for:

"$ARGUMENTS"

Room data extraction script

Read-only — no model modifications.

import clr
clr.AddReference('RevitServices')
from RevitServices.Persistence import DocumentManager
clr.AddReference('RevitAPI')
from Autodesk.Revit.DB import *

doc = DocumentManager.Instance.CurrentDBDocument

# Unit conversion constants
SQ_FT_TO_SQ_M    = 0.092903   # Revit stores area in square feet internally
CUBIC_FT_TO_M3   = 0.0283168
FT_TO_M          = 0.3048

try:
    # Collect all placed rooms
    rooms = (FilteredElementCollector(doc)
             .OfCategory(BuiltInCategory.OST_Rooms)
             .WhereElementIsNotElementType()
             .ToElements())

    room_data = []
    unplaced   = []

    for room in rooms:
        area_sqft = room.Area

        if area_sqft <= 0:
            # Unplaced or unbounded room — flag it
            unplaced.append({
                'Id':     room.Id.IntegerValue,
                'Number': room.Number,
                'Name':   room.get_Parameter(BuiltInParameter.ROOM_NAME).AsString() or '',
                'Issue':  'Unplaced or Unbounded'
            })
            continue

        # Pull all useful fields
        dept_param  = room.get_Parameter(BuiltInParameter.ROOM_DEPARTMENT)
        phase_param = room.get_Parameter(BuiltInParameter.ROOM_PHASE)

        data = {
            'Room Number':   room.Number,
            'Room Name':     room.get_Parameter(BuiltInParameter.ROOM_NAME).AsString() or '',
            'Department':    dept_param.AsString()  if dept_param  else '',
            'Level':         room.Level.Name         if room.Level  else 'N/A',
            'Area (m2)':     round(area_sqft * SQ_FT_TO_SQ_M, 2),
            'Area (ft2)':    round(area_sqft, 2),
            'Volume (m3)':   round(room.Volume * CUBIC_FT_TO_M3, 2),
            'Perimeter (m)': round(room.Perimeter * FT_TO_M, 2),
            'Phase':         phase_param.AsValueString() if phase_param else '',
            'Element Id':    room.Id.IntegerValue,
        }
        room_data.append(data)

    # Sort by level, then room number
    room_data.sort(key=lambda x: (x['Level'], x['Room Number']))

    # Calculate totals
    gia_m2 = sum(r['Area (m2)'] for r in room_data)

    OUT = [
        room_data,                             # full data table
        unplaced,                              # rooms to fix
        round(gia_m2, 2),                      # total GIA in m²
        len(room_data),                        # placed room count
        len(unplaced),                         # unplaced count
    ]

except Exception as e:
    import traceback
    OUT = 'ERROR: ' + str(e) + '\n' + traceback.format_exc()