plangeom 0.1.0a1__tar.gz

plangeom-0.1.0a1/MANIFEST.in

@@ -0,0 +1 @@
+include tests/synth.py

plangeom-0.1.0a1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: plangeom
+Version: 0.1.0a1
+Summary: Read construction floor plans from vector PDFs by geometry alone and write a checked JSON description. No model training.
+Keywords: pdf,floor plan,bim,cad,vector,geometry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.26
+Requires-Dist: scipy>=1.11
+Requires-Dist: shapely>=2.0
+Requires-Dist: opencv-python-headless>=4.8
+Requires-Dist: scikit-image>=0.22
+Requires-Dist: pypdfium2>=4.30
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: jsonschema>=4; extra == "dev"
+Requires-Dist: reportlab>=4; extra == "dev"
+
+# plangeom
+
+Reads construction floor plans from vector PDFs by geometry alone and writes a checked JSON description. No model training.
+
+```bash
+pip install plangeom
+plangeom plan.pdf --page 0 -o sheet.json
+```
+
+```python
+from plangeom import parse_page
+sheet = parse_page("plan.pdf", 0)
+print(sheet["verdict"], sheet["scale"]["mm_per_pt"], len(sheet["doors"]))
+```
+
+A whole set of drawings, one PDF or several volumes of a project:
+
+```bash
+plangeom ar.pdf kr.pdf --all -o building.json
+```
+
+```python
+from plangeom import parse_document
+result = parse_document(["ar.pdf", "kr.pdf"], workers=4)
+for building in result["buildings"]:
+    print(building["parts_named"], building["floors"]["storey_m"], len(building["sheets"]))
+```
+
+## What it does
+
+- **Scale from the axis grid.** Axes are found as circles of paper-fixed size with a long line through the centre. Values printed between axes give millimetres. With no text, axis spacing as multiples of a building module does, with door leaves and round wall thickness settling the harmonic.
+- **Walls** from filled bodies, thickness from opposite edges, centrelines from parallel edge pairs.
+- **Materials** as clusters of hatch geometry, without reading colour. Clusters have no names until a legend or a person names them.
+- **Doors** as a circular arc plus a radial leaf. The sweep angle is deliberately not a criterion.
+- **Rooms** as exact planar faces where walls close them, a watershed from room tags where they do not, and a clearance watershed when the sheet has no text.
+- **Repeated symbols** by D2 shape distribution and size, confirmed by modified Hausdorff distance.
+- **Windows and openings** as gaps between wall ends, in a belt along the slab edge, looking out.
+- **Stairs** as rows of treads, drawn or painted, with flights, landings and the hole in the slab.
+- **Fixtures and cars** by real sizes and shape; a room's type from its name or from what stands in it.
+- **Whole sets.** Stamps give the section, floor, typical floors and level. Sheets on one axis grid under one name are one building; risers, stair wells and lifts run through its floors, and what a floor could not read is taken from the floors around it and marked as taken. Structural sheets judge the wall roles of architectural ones.
+
+## It does not guess silently
+
+Every stroke ends in one row of a ledger. Whatever no rule owns goes to `queue`. Checks come from the sheet itself: printed values against axes, room areas against the schedule, thickness and door plausibility. A sheet that fails any of them gets `"verdict": "needs_review"`.
+
+## Status: alpha
+
+Tested on synthetic drawings in `tests/`, and by hand on a private corpus of real sheets. Known limits today:
+
+- Most real sheets end as `needs_review`: read them with their checks, not as finished models.
+- Room areas agree with schedules at a median error of 4 to 9 % on real projects, and much worse on garages.
+- Stamps are read in Russian.
+- The scale from axes without text can land on a harmonic of the true scale.
+- Scanned pages are not handled: a page with no vector strokes returns `not_a_vector_drawing`.
+- The plan for services in `plangeom.mep` is a first pass with planning defaults, not a design.
+
+## Output
+
+JSON Schema: `plangeom.schema.SCHEMA`. Lengths are millimetres in a sheet frame with y down.
+
+## License
+
+No license has been granted yet: all rights reserved.

plangeom-0.1.0a1/README.md

@@ -0,0 +1,63 @@
+# plangeom
+
+Reads construction floor plans from vector PDFs by geometry alone and writes a checked JSON description. No model training.
+
+```bash
+pip install plangeom
+plangeom plan.pdf --page 0 -o sheet.json
+```
+
+```python
+from plangeom import parse_page
+sheet = parse_page("plan.pdf", 0)
+print(sheet["verdict"], sheet["scale"]["mm_per_pt"], len(sheet["doors"]))
+```
+
+A whole set of drawings, one PDF or several volumes of a project:
+
+```bash
+plangeom ar.pdf kr.pdf --all -o building.json
+```
+
+```python
+from plangeom import parse_document
+result = parse_document(["ar.pdf", "kr.pdf"], workers=4)
+for building in result["buildings"]:
+    print(building["parts_named"], building["floors"]["storey_m"], len(building["sheets"]))
+```
+
+## What it does
+
+- **Scale from the axis grid.** Axes are found as circles of paper-fixed size with a long line through the centre. Values printed between axes give millimetres. With no text, axis spacing as multiples of a building module does, with door leaves and round wall thickness settling the harmonic.
+- **Walls** from filled bodies, thickness from opposite edges, centrelines from parallel edge pairs.
+- **Materials** as clusters of hatch geometry, without reading colour. Clusters have no names until a legend or a person names them.
+- **Doors** as a circular arc plus a radial leaf. The sweep angle is deliberately not a criterion.
+- **Rooms** as exact planar faces where walls close them, a watershed from room tags where they do not, and a clearance watershed when the sheet has no text.
+- **Repeated symbols** by D2 shape distribution and size, confirmed by modified Hausdorff distance.
+- **Windows and openings** as gaps between wall ends, in a belt along the slab edge, looking out.
+- **Stairs** as rows of treads, drawn or painted, with flights, landings and the hole in the slab.
+- **Fixtures and cars** by real sizes and shape; a room's type from its name or from what stands in it.
+- **Whole sets.** Stamps give the section, floor, typical floors and level. Sheets on one axis grid under one name are one building; risers, stair wells and lifts run through its floors, and what a floor could not read is taken from the floors around it and marked as taken. Structural sheets judge the wall roles of architectural ones.
+
+## It does not guess silently
+
+Every stroke ends in one row of a ledger. Whatever no rule owns goes to `queue`. Checks come from the sheet itself: printed values against axes, room areas against the schedule, thickness and door plausibility. A sheet that fails any of them gets `"verdict": "needs_review"`.
+
+## Status: alpha
+
+Tested on synthetic drawings in `tests/`, and by hand on a private corpus of real sheets. Known limits today:
+
+- Most real sheets end as `needs_review`: read them with their checks, not as finished models.
+- Room areas agree with schedules at a median error of 4 to 9 % on real projects, and much worse on garages.
+- Stamps are read in Russian.
+- The scale from axes without text can land on a harmonic of the true scale.
+- Scanned pages are not handled: a page with no vector strokes returns `not_a_vector_drawing`.
+- The plan for services in `plangeom.mep` is a first pass with planning defaults, not a design.
+
+## Output
+
+JSON Schema: `plangeom.schema.SCHEMA`. Lengths are millimetres in a sheet frame with y down.
+
+## License
+
+No license has been granted yet: all rights reserved.

plangeom-0.1.0a1/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=70"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plangeom"
+version = "0.1.0a1"
+description = "Read construction floor plans from vector PDFs by geometry alone and write a checked JSON description. No model training."
+readme = "README.md"
+requires-python = ">=3.10"
+keywords = ["pdf", "floor plan", "bim", "cad", "vector", "geometry"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "numpy>=1.26",
+    "scipy>=1.11",
+    "shapely>=2.0",
+    "opencv-python-headless>=4.8",
+    "scikit-image>=0.22",
+    "pypdfium2>=4.30",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "jsonschema>=4", "reportlab>=4"]
+
+[project.scripts]
+plangeom = "plangeom.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

plangeom-0.1.0a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

plangeom-0.1.0a1/src/plangeom/__init__.py

@@ -0,0 +1,14 @@
+"""plangeom: read construction floor plans from vector PDFs by geometry alone."""
+__version__ = "0.1.0a1"
+
+
+def parse_page(path, number=0, drop_styles=None):
+    """Describe one PDF page as a JSON-ready dict; see plangeom.schema for its shape."""
+    from .sheet import parse_page as _p
+    return _p(path, number, drop_styles)
+
+
+def parse_document(path, pages=None, sections=None, workers=2, timeout_s=300.0):
+    """Read every plan of a PDF, each sheet in a process of its own, and assemble the buildings: floors, risers, stair wells, what the structure says about the walls."""
+    from .document import parse_document as _p
+    return _p(path, pages=pages, sections=sections, workers=workers, timeout_s=timeout_s)

plangeom-0.1.0a1/src/plangeom/cli.py

@@ -0,0 +1,48 @@
+"""plangeom FILE.pdf --page 0 -o sheet.json, or plangeom FILE.pdf --all -o building.json"""
+import argparse
+import json
+import sys
+
+from .document import parse_document
+from .sheet import parse_page
+
+
+def main(argv=None) -> int:
+    ap = argparse.ArgumentParser(prog="plangeom", description="Describe a page of a vector PDF drawing as JSON, by geometry alone.")
+    ap.add_argument("pdf", nargs="+", help="one file, or with --all several volumes of one project")
+    ap.add_argument("--page", type=int, default=0, help="page number from 0")
+    ap.add_argument("-o", "--out", help="output JSON file; stdout when omitted")
+    ap.add_argument("--all", action="store_true", help="read every plan of the file and assemble the buildings")
+    ap.add_argument("--workers", type=int, default=2, help="sheets read at the same time with --all")
+    ap.add_argument("--sections", help="with --all: only these sections of the documentation, comma separated, for example АР,КР")
+    a = ap.parse_args(argv)
+    if a.all:
+        def said(n, d):
+            print(f"page {n}: {d.get('failed') or d.get('verdict')}", file=sys.stderr)
+        res = parse_document(a.pdf, sections=tuple(a.sections.split(",")) if a.sections else None, workers=a.workers, on_sheet=said)
+        text = json.dumps(res, ensure_ascii=False, indent=1)
+        if a.out:
+            with open(a.out, "w", encoding="utf8") as f:
+                f.write(text)
+        else:
+            sys.stdout.write(text + "\n")
+        print(f"{res['pages']} pages, {res['read']} read, {len(res['failed'])} failed, {len(res['buildings'])} buildings on their own grids, {len(res['plans_on_no_grid'])} plans on no grid", file=sys.stderr)
+        return 0
+    if len(a.pdf) > 1:
+        ap.error("several files need --all")
+    doc = parse_page(a.pdf[0], a.page)
+    text = json.dumps(doc, ensure_ascii=False, indent=1)
+    if a.out:
+        with open(a.out, "w", encoding="utf8") as f:
+            f.write(text)
+    else:
+        sys.stdout.write(text + "\n")
+    s = doc["scale"]
+    print(f"{doc['verdict']}: scale {s.get('mm_per_pt')} mm/pt by {s.get('method')}, walls {len(doc['walls'])}, doors {len(doc['doors'])}, rooms {len(doc['rooms'])}, symbol classes {len(doc['symbols'])}, unowned {doc['queue']['count']}", file=sys.stderr)
+    for c in doc["checks"]:
+        print(f"  {'ok ' if c['passed'] else 'NO '} {c['name']}: {c['detail']}", file=sys.stderr)
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())