Skip to main content

Utilities for civil engineering: concrete mix design, material-property calculators, unit conversions, and common structural helpers for analysis and design workflows.

Project description

civilutils

A lightweight Civil Engineering Python utility package.

PyPI - Downloads GitHub License PyPI - Status

Release CI PR Approval Code Quality

GitHub tag (with filter) Static Badge Static Badge

Overview

civilutils provides practical utilities for civil engineering workflows. The initial focus is a concrete mix design implementation based on Indian Standards (IS). The package is designed to be extended later to support other standards (e.g. ACI) and additional domains such as structural analysis and survey calculations.

Installation

Install from source (example):

pip install civilutils

Quick start

Example usage (basic):

from civilutils.indian_standards.concrete import (
    ConcreteMixDesign, ConcreteGrade, MaximumNominalSize,
    ExposureCondition, SpecificGravity, Materials
)

sg_list = [
    SpecificGravity(Materials.CEMENT, 3.15),
    SpecificGravity(Materials.FINE_AGGREGATE, 2.60),
    SpecificGravity(Materials.COARSE_AGGREGATE, 2.70),
    SpecificGravity(Materials.WATER, 1.00),
    SpecificGravity(Materials.ADMIXTURE, 1.145),
]

design = ConcreteMixDesign(
    concrete_grade=ConcreteGrade.M25,
    exposure_condition=ExposureCondition.MODERATE,
    specific_gravities=sg_list,
    maximum_nominal_size=MaximumNominalSize.SIZE_20,
    slump_mm=50.0
)

# compute and optionally print summary
result = design.compute_mix_design(display_result=True)

API and source

Detailed documentation is available at: https://civilutils.readthedocs.io/en/latest/. The documentation site provides downloadable formats — you can download the docs as PDF or EPUB from the Read the Docs site.

Running tests

Run unit tests:

python -m unittest discover -s tests -p "test_*.py"

Roadmap

  • Add support for other standards (ACI, Eurocode).
  • Extend modules for structural calculations (beams, columns, load combinations).
  • Add survey utilities (coordinate transforms, area/volume computations).
  • Improve documentation and examples.

Contributing

Contributions via PRs are welcome. Please:

  • Follow standard Python packaging practices.
  • Include tests for new features.
  • Keep changes small and documented.

License

MIT — see LICENSE

If you find this project useful, A small cup helps a lot!

Buy Me A Coffee

More from the developer

Reach out or explore other projects by the developer at: https://amraja.in/

If any link in this README does not redirect or returns "Not Found", please locate the referenced document in the parent GitHub repository: https://github.com/amrajacivil/civilutils

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

civilutils-0.1.1.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

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

civilutils-0.1.1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file civilutils-0.1.1.tar.gz.

File metadata

  • Download URL: civilutils-0.1.1.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for civilutils-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5485397d496766ba8c6d320ca19b0a0cf800b8bc8816ad24148ed8fa1701db24
MD5 fb61cd03f280f635a9c5c6aa425480a7
BLAKE2b-256 581f5dd139065add018e0c11fcc33886ee3ac832f2449c01919f956d91f9cc79

See more details on using hashes here.

Provenance

The following attestation bundles were made for civilutils-0.1.1.tar.gz:

Publisher: release.yaml on amrajacivil/civilutils

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

File details

Details for the file civilutils-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: civilutils-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for civilutils-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 249a5bcbf1238000d1e860607aad88c2651f3d5a3727cd043fcef6c7fd0928f4
MD5 c5e51ba5d87120cc8c6b0187a89932b5
BLAKE2b-256 a6b9ad996b6de99d6bde77670ceb919658d1648da3c549f85517647cbd55d423

See more details on using hashes here.

Provenance

The following attestation bundles were made for civilutils-0.1.1-py3-none-any.whl:

Publisher: release.yaml on amrajacivil/civilutils

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