civix 0.0.21

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

Release workflow

1. Pre-release checks (run locally)

Ruff is not enforced in CI — run manually before merging:

uv tool run ruff check .        # lint (Pyflakes F-rules)
uv tool run ruff format .       # auto-format
uv run pytest                   # all tests green

2. Merge feature branch → develop (squash)

git checkout develop
git merge --squash feature/<branch-name>
git commit -m "squashed: <short description>"

3. Bump version

uv version --bump patch          # e.g. 0.0.18 → 0.0.19
git add pyproject.toml uv.lock
git commit -m "bump version to $(uv version)"

4. Merge develop → main

git checkout main
git merge develop
git push origin main

CI detects the version change on main, creates the tag, runs tests, builds, and publishes to PyPI automatically.

Starting a new feature

1. Clean up the old feature branch

git branch -d feature/<old-branch>                # delete local
git push origin --delete feature/<old-branch>     # delete remote

2. Create a new branch from develop

git checkout develop
git pull origin develop                            # make sure develop is up to date
git checkout -b feature/<new-branch>

3. Work, commit, repeat

git add <files>
git commit -m "<description>"

When ready, follow the Release workflow steps above (squash merge → bump version → merge to main).

---

Syncing all local branches with remote

Run this at the start of each session to stay up to date:

git fetch --all --prune              # fetch all remotes, remove deleted remote branches
git checkout main && git pull
git checkout develop && git pull
git push origin develop              # push any local develop commits not yet on remote

---

Streamlit app

uv run streamlit run streamlit_app/app.py

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]"

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")