qanat-design 0.0.1__tar.gz

qanat_design-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 konnerhorton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qanat_design-0.0.1/PKG-INFO

@@ -0,0 +1,61 @@
+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.

qanat_design-0.0.1/README.md

@@ -0,0 +1,35 @@
+# 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.

qanat_design-0.0.1/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+name = "qanat-design"
+version = "0.0.1"
+description = "Closed-form and empirical design calculations for tunnels and shafts, traceable to their inputs and sources"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "tunnel",
+    "tunneling",
+    "shaft",
+    "support of excavation",
+    "underground construction",
+    "geotechnical engineering",
+    "TBM",
+    "microtunneling",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = ["pint>=0.24.4"]
+
+[[project.authors]]
+name = "Konner Horton"
+email = "konnerhorton@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/konnerhorton/qanat"
+Source = "https://github.com/konnerhorton/qanat"
+Issues = "https://github.com/konnerhorton/qanat/issues"
+Specification = "https://github.com/konnerhorton/qanat/blob/main/SPEC.md"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "ruff>=0.17",
+    "hypothesis>=6.100",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.10"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "qanat"
+
+[tool.ruff]
+target-version = "py312"
+
+[tool.ruff.format]
+exclude = ["*.md"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+    "RUF",
+    "D",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = [
+    "-ra",
+    "--strict-markers",
+    "--strict-config",
+    "--import-mode=importlib",
+]
+xfail_strict = true
+filterwarnings = ["error"]

qanat_design-0.0.1/pyproject.toml.orig

@@ -0,0 +1,72 @@
+[project]
+name = "qanat-design"
+version = "0.0.1"
+description = "Closed-form and empirical design calculations for tunnels and shafts, traceable to their inputs and sources"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Konner Horton", email = "konnerhorton@gmail.com" }]
+keywords = [
+    "tunnel",
+    "tunneling",
+    "shaft",
+    "support of excavation",
+    "underground construction",
+    "geotechnical engineering",
+    "TBM",
+    "microtunneling",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "pint>=0.24.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/konnerhorton/qanat"
+Source = "https://github.com/konnerhorton/qanat"
+Issues = "https://github.com/konnerhorton/qanat/issues"
+Specification = "https://github.com/konnerhorton/qanat/blob/main/SPEC.md"
+
+[dependency-groups]
+dev = ["pytest>=8.0", "ruff>=0.17", "hypothesis>=6.100"]
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.10"]
+build-backend = "uv_build"
+
+# The distribution is qanat-design (the bare name is taken on PyPI); the import name is qanat.
+[tool.uv.build-backend]
+module-name = "qanat"
+
+[tool.ruff]
+target-version = "py312"
+
+# Code blocks in the docs are hand-aligned sketches, not code to format.
+[tool.ruff.format]
+exclude = ["*.md"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF", "D"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = ["-ra", "--strict-markers", "--strict-config", "--import-mode=importlib"]
+xfail_strict = true
+filterwarnings = ["error"]

qanat_design-0.0.1/src/qanat/__init__.py

@@ -0,0 +1,12 @@
+"""qanat: closed-form and empirical design calculations for tunnels and shafts.
+
+Every result is traceable to its inputs, method and source, and flags where
+numerical analysis is needed. Published as ``qanat-design``; imported as
+``import qanat as qn``.
+"""
+
+from importlib.metadata import version
+
+__version__ = version("qanat-design")
+
+__all__ = ["__version__"]