Skip to main content

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

Project description

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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

civix-0.0.20.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

civix-0.0.20-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file civix-0.0.20.tar.gz.

File metadata

  • Download URL: civix-0.0.20.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for civix-0.0.20.tar.gz
Algorithm Hash digest
SHA256 b80739d53b79fdce0501b8478daa4fc8bff1655b429297bcb8f557bf6b31456f
MD5 28e8d81cd6d1a9c7dc4cd960d33460a2
BLAKE2b-256 3f4129d7afc91678b4fd896f6ff18a2e1f77dbe46e1b41b3a3e2baccc04d297f

See more details on using hashes here.

Provenance

The following attestation bundles were made for civix-0.0.20.tar.gz:

Publisher: release.yml on mohamadalitellawi/civix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file civix-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: civix-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 37.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for civix-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 0d4a9e562e09d2ea060077a84e7ff2d61e315082c74117d5e32f887eddce5a1e
MD5 77e1b0ef3a12d8591dcfa72c938867cd
BLAKE2b-256 90578a7c40fce8ef6bf84e1df77c8daf54d623a753bb2b4968e8b5b93ea6d87c

See more details on using hashes here.

Provenance

The following attestation bundles were made for civix-0.0.20-py3-none-any.whl:

Publisher: release.yml on mohamadalitellawi/civix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page