Skip to content

overview.md

Latest commit

 

History

History
27 lines (21 loc) · 1.39 KB

overview.md

File metadata and controls

27 lines (21 loc) · 1.39 KB
Raw

API Overview

The carbcomn package is organised into four sub-packages. Each section in this chapter documents the public classes and functions in one sub-package.

Sub-package Contents
carbcomn.datastructures RefMesh, RefBlock, FloorFormDiagram, Pattern
carbcomn.model All structural element types: blocks, beams, columns; FloorModel, StructuralGrid, TrimModifier
carbcomn.templates Parametric geometry templates: ArchTemplate, FlatBarrelTemplate, BarrelTemplate
carbcomn.session WorkflowSession

Import conventions

All public classes are importable directly from the sub-package:

from carbcomn.datastructures import RefMesh, RefBlock, FloorFormDiagram, Pattern
from carbcomn.model import BlockModel, Column, TieBeam, FloorModel, StructuralGrid, TrimModifier
from carbcomn.model.elements.blocks.standard_block import StandardBlock
from carbcomn.model.elements.blocks.ridge_voussoir import RidgeVoussoir
from carbcomn.model.elements.blocks.carbcomn_voussoir import CarbcomnVoussoir
from carbcomn.templates.barrel import FlatBarrelTemplate
from carbcomn.templates.arch import ArchTemplate
from carbcomn.session import WorkflowSession

Note: The API is under active development. Class signatures and method names may change between versions.