civix 0.0.22

useful tools for civil engineering that are needed regularly in the daily tasks for a civil engineer

civix

Python tools for civil and structural engineering.

civix is a flat collection of domain modules for day-to-day structural work — code-based design checks, BIM/model interop, and calc-sheet reporting. Design functions are pure and return typed result dataclasses that carry their own demand/capacity ratio and pass/fail verdict, so a calculation is auditable end to end.

What's inside

Module	Purpose
civix.design	ACI 318-25 structural design checks (concrete) — pure functions returning result dataclasses
civix.loads	Load combination generation
civix.etabs	ETABS .NET API automation via pythonnet (Windows)
civix.ifc	IFC model querying via ifcopenshell
civix.geom	Geometry helpers; reads/writes Rhino .3dm (rhino3dm)
civix.gh	Grasshopper snippet helpers
civix.reports	Quarto CLI wrapper: render .qmd/.ipynb to PDF/HTML
civix.notebook	Display helpers (show_check/show_report/calc_block) for Jupyter
civix.core	Config, logging, errors, paths

Units are carried in variable names (fck_MPa, As_mm2, Mu_Nmm); design compute is in N·mm internally and converts to display units only at the notebook/report boundary.

Installation

pip install civix                      # core only (numpy, loguru, pyyaml, plotly, openpyxl)
pip install "civix[etabs]"             # + ETABS automation (Windows)
pip install "civix[ifc]"               # + IFC parsing (ifcopenshell)
pip install "civix[geom]"              # + Rhino/Grasshopper geometry
pip install "civix[notebook]"          # + Jupyter notebook + handcalcs rendering
pip install "civix[streamlit]"         # + Streamlit app
pip install "civix[all]"               # everything

With uv:

uv add civix
uv add "civix[etabs,ifc,geom]"
uv add "civix[all]"

Quickstart

from civix.design.aci318_25.beams import design_flexure

# Singly-reinforced RC beam flexure (ACI 318-25), inputs in N·mm
res = design_flexure(
    b_mm=300, d_mm=540, fck_MPa=30, fy_MPa=420, As_mm2=1500, Mu_Nmm=220e6
)
print(f"phiMn = {res.phiMn_Nmm / 1e6:.1f} kN·m  DCR = {res.dcr:.3f}  "
      f"{'PASS' if res.passed else 'FAIL'}  ({res.code_ref})")

In a notebook, render the verdict as a card:

from civix.notebook import show_check
show_check("Beam B1 — flexure", res)

Check your environment and optional runtimes (real load-and-one-operation smoke checks):

civix-health          # dependency + environment check
civix-init-config     # write a default civix.yaml to the current directory

Logging

civix is silent by default — it calls logger.disable("civix") at import and never attaches a sink itself. To see its logs, opt in from your notebook or script:

import sys
from loguru import logger

logger.enable("civix")
logger.remove()
logger.add(sys.stderr, level="INFO")

Streamlit app

uv run streamlit run streamlit_app/app.py

Documentation

• docs/developer_manual.md — architecture, patterns, and design rationale
• CONTRIBUTING.md — branch strategy and release workflow
• CLAUDE.md — binding conventions (the single source of truth)