Metadata-Version: 2.4
Name: qanat-design
Version: 0.0.1
Summary: Closed-form and empirical design calculations for tunnels and shafts, traceable to their inputs and sources
Keywords: tunnel,tunneling,shaft,support of excavation,underground construction,geotechnical engineering,TBM,microtunneling
Author: Konner Horton
Author-email: Konner Horton <konnerhorton@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Dist: pint>=0.24.4
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/konnerhorton/qanat
Project-URL: Source, https://github.com/konnerhorton/qanat
Project-URL: Issues, https://github.com/konnerhorton/qanat/issues
Project-URL: Specification, https://github.com/konnerhorton/qanat/blob/main/SPEC.md
Description-Content-Type: text/markdown

# qanat

Closed-form and empirical design calculations for tunnels and shafts: support of excavation, ground support, segmental linings, face pressure, groundwater inflow, basal heave, TBM and MTBM thrust. Every result is traceable to its inputs, method and source, and flags where numerical analysis is needed.

In early design: there are no calculations yet. See [`SPEC.md`](SPEC.md) for the scope and roadmap.

## Install

qanat isn't on PyPI yet. It will be published as `qanat-design` and imported as `qanat`:

```python
import qanat as qn
```

Until then, install from source with [uv](https://docs.astral.sh/uv/):

```bash
git clone https://github.com/konnerhorton/qanat.git
cd qanat
uv sync
```

Python 3.12 or later.

## Development

```bash
uv sync                                                            # install, with the dev tools
uv run pytest                                                      # tests
uv run ruff check . && uv run ruff format --check . && uv run pytest  # what CI runs
```

## License

MIT.
