📐 floorplan

A lightweight, zero-dependency Python utility for structuring architectural floor plans, managing rooms, computing usable floor area (including attic slopes), and checking room distributions.

⚡ Installation

pip install floorplan

🚀 Quickstart

import floorplan

plan = floorplan.FloorPlan(name="Apartment 4B")

# Add standard rectangular rooms (length, width in meters)
plan.add_room("Living Room", length=5.5, width=4.0)
plan.add_room("Bedroom", length=4.0, width=3.2)
plan.add_room("Bathroom", length=2.5, width=2.0)

# Add attic room with sloped ceiling calculation
# (e.g. 20 sqm total floor area, but 5 sqm has height < 1.4m and 3 sqm is 1.4m - 2.2m)
plan.add_sloped_room(
    name="Attic Studio",
    total_floor_area=20.0,
    area_below_140cm=5.0,
    area_between_140_and_220cm=3.0
)

print(f"Total Gross Floor Area: {plan.total_gross_area:.2f} m²")
print(f"Total Usable Area: {plan.total_usable_area:.2f} m²")
print(plan.room_breakdown())

⚠️ Disclaimer

This package provides mathematical modeling for spatial layouts. It does not replace licensed architectural surveying, certified construction obmiar standards, or local building code verifications. Always consult a certified architect or surveyor for official legal documentation.