timoshenko-engine 2.0.1__tar.gz

timoshenko_engine-2.0.1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Ayberk Korkmaz
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

timoshenko_engine-2.0.1/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: timoshenko-engine
+Version: 2.0.1
+Summary: Composable structural engineering calculations and analysis primitives for Python applications.
+Author: Ayberk Korkmaz
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Ayberkrk/timoshenko
+Project-URL: Repository, https://github.com/Ayberkrk/timoshenko
+Project-URL: Issues, https://github.com/Ayberkrk/timoshenko/issues
+Project-URL: Documentation, https://github.com/Ayberkrk/timoshenko/tree/main/docs
+Keywords: civil engineering,structural engineering,structural health monitoring,modal analysis,digital twin
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Provides-Extra: mqtt
+Requires-Dist: paho-mqtt<3,>=2.1; extra == "mqtt"
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material<10,>=9.5; extra == "docs"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Ayberkrk/timoshenko/main/assets/timoshenko-logo.png" alt="Timoshenko Engine logo" width="920">
+</p>
+
+<h1 align="center">Timoshenko Engine</h1>
+
+<p align="center">
+  Reusable structural engineering building blocks for Python applications.
+</p>
+
+<p align="center">
+  <img alt="Version 2.0.1" src="https://img.shields.io/badge/version-2.0.1-orange?style=for-the-badge">
+  <img alt="Alpha" src="https://img.shields.io/badge/stage-alpha-orange?style=for-the-badge">
+  <img alt="Python 3.10 to 3.13" src="https://img.shields.io/badge/python-3.10%20to%203.13-blue?style=for-the-badge">
+  <img alt="Apache 2.0 license" src="https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge">
+  <a href="https://github.com/Ayberkrk/timoshenko/actions/workflows/tests.yml"><img alt="Tests" src="https://github.com/Ayberkrk/timoshenko/actions/workflows/tests.yml/badge.svg"></a>
+</p>
+
+Timoshenko packages common structural calculations, modal analysis, sensor
+workflows, and monitoring components so applications can reuse them instead
+of rebuilding the same foundations for every project. It is an embeddable
+Python library and engine core, not a hosted monitoring service or a general
+finite-element solver.
+
+> **Alpha:** the API may still change between releases. Timoshenko is not yet
+> published on PyPI; install it from GitHub or from a checkout as shown below.
+
+## Install
+
+From GitHub:
+
+```bash
+python -m pip install "timoshenko-engine @ git+https://github.com/Ayberkrk/timoshenko"
+```
+
+Or from the root of a checkout:
+
+```bash
+python -m pip install .
+```
+
+The distribution package is named `timoshenko-engine`. The Python import
+package is named `timoshenko`:
+
+```python
+import timoshenko as tm
+print(tm.__version__)
+```
+
+To install optional MQTT support, use:
+
+```bash
+python -m pip install '.[mqtt]'
+```
+
+A future published release can be installed with
+`python -m pip install timoshenko-engine`. That command is only usable after a
+release is available from the selected package index.
+
+## Quick start
+
+```python
+import timoshenko as tm
+
+structure = tm.Structure(
+    structure_id="building-01",
+    story_masses_kg=[120_000.0, 110_000.0],
+    story_stiffness_n_m=[85_000_000.0, 70_000_000.0],
+)
+
+sensors = tm.load_sensors(
+    "acceleration.csv",
+    sampling_hz=100.0,
+    column="acceleration_m_s2",
+    unit="m/s^2",
+)
+
+modal = tm.modal.identify(sensors)
+updated = tm.update(structure, modal)
+health = tm.health.assess(structure=updated, observations=sensors)
+
+print(health.to_dict())
+```
+
+For a one-shot pipeline, `tm.monitor(structure, sensors)` performs the same
+analysis sequence and returns a serializable result. The model update applies
+one global stiffness multiplier and keeps the analytical reference frequencies
+separate from measured frequencies.
+
+## What it provides
+
+| Area | Reusable components |
+|---|---|
+| Structural models | Lumped-mass shear-building models and analytical natural frequencies |
+| Modal analysis | Single-channel peak picking, damping estimates when resolvable, and multi-channel FDD with complex mode shapes |
+| Model comparison | Log-frequency mode pairing, global stiffness updating, and evidence-oriented health assessment |
+| Monitoring | Caller-fed bounded sessions, batch validation, source adapters, and optional plugins |
+| Data workflow | Sensor CSV loading, project manifests, local SQLite history, and CSV replay |
+| Reporting | Standalone HTML reports with an embedded SVG frequency comparison |
+| Engineering calculations | Beam cases, section properties, mechanics, vibration, stability, stress, pressure, torsion, and uncertainty helpers |
+
+Timoshenko can be used module by module or embedded in a larger product such as
+Cauren. Sensor collection, application-specific risk rules, and engineering
+interpretation remain with the integrating application.
+
+## Multi-channel modal screening
+
+FDD requires synchronized channels with a common sample rate and unit:
+
+```python
+signals = tm.load_multichannel_csv(
+    "aligned_accelerometers.csv",
+    columns=["deck_left", "deck_center", "deck_right"],
+    sampling_hz=100.0,
+    units=["m/s^2"] * 3,
+)
+fdd = tm.identify_fdd(signals, nperseg=1024, max_modes=5)
+print(fdd.to_dict())
+```
+
+This first FDD implementation returns candidate frequencies and complex mode
+shapes. It does not estimate damping or issue a damage or safety conclusion.
+
+## Bounded monitoring session
+
+A caller supplies timestamped observation batches. The session aligns samples,
+waits for a fresh contiguous analysis window after gaps, and emits reports after
+each configured hop:
+
+```python
+session = tm.MonitoringSession(
+    structure,
+    sensor_ids=["deck-left", "deck-right"],
+    units=["m/s^2", "m/s^2"],
+    sampling_hz=100.0,
+    window_samples=2048,
+    hop_samples=512,
+    analysis_options={"nperseg": 512, "max_modes": 4},
+)
+result = session.ingest(batch)
+for report in result.reports:
+    tm.report.save_html(report, "reports/latest.html")
+```
+
+A gateway remains responsible for collecting data and handling transport
+reconnection. Timoshenko does not run a background collector or select an alarm
+policy.
+
+## Further examples and documentation
+
+- [Documentation home](docs/index.md)
+- [Architecture](docs/architecture.md)
+- [Data contract](docs/data-contract.md)
+- [Historical CSV replay](docs/csv-source.md)
+- [Plugin contract](docs/plugin-contract.md)
+- [Rayleigh damping](docs/rayleigh-damping.md)
+- [Section properties](docs/section-properties.md)
+- [Polygon section properties](docs/polygon-sections.md)
+- [Equation uncertainty](docs/uncertainty.md)
+- [Numerical methods and limits](docs/numerical-methods.md)
+- [Monitoring sessions](docs/live-sessions.md)
+- [Source adapters](docs/adapters.md)
+- [Project manifests](docs/project-manifest.md)
+- [Local storage](docs/storage.md)
+- [Reports](docs/reporting.md)
+- [Optional MQTT adapter](docs/mqtt-adapter.md)
+- [SensorThings adapter](docs/sensorthings-adapter.md)
+- [Engineering calculations](examples/engineering_primitives.py)
+- [Runnable examples](examples/)
+- [Publishing and citation](docs/publishing.md)
+
+## Limits and engineering posture
+
+- Timoshenko is alpha software and is not a structural safety certification tool.
+- Its shear-building model is a small lumped-mass reference model, not a full FEM solver.
+- Modal identification is a screening estimate. A single sensor may miss a mode near a modal node.
+- Damping is reported only when the averaged spectrum resolves the half-power bandwidth; otherwise it is `None`.
+- FDD requires synchronized channels and does not estimate damping.
+- The model update applies a single stiffness scale. It cannot locate or size local damage.
+- A frequency shift is evidence for human review, not a damage verdict. Temperature, sensor placement, boundary conditions, and other effects can shift measurements.
+- A monitoring session consumes data supplied by the caller. It does not implement a broker subscription, reconnect loop, scheduler, hosted dashboard, or alarm policy.
+- Closed-form mechanics and section functions rely on their documented ideal assumptions. They are not code-compliance checks.
+
+## Development
+
+```bash
+python -m pip install -e ".[test]"
+python -m pytest
+```
+
+To build the documentation locally, install the optional documentation tools
+and run MkDocs:
+
+```bash
+python -m pip install -e ".[docs]"
+python -m mkdocs serve
+```
+
+The test suite checks analytical cases, input validation, adapters, storage,
+monitoring sessions, and reports. Package distributions should be built and
+installed in a clean environment before a release is uploaded.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

timoshenko_engine-2.0.1/README.md

@@ -0,0 +1,205 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Ayberkrk/timoshenko/main/assets/timoshenko-logo.png" alt="Timoshenko Engine logo" width="920">
+</p>
+
+<h1 align="center">Timoshenko Engine</h1>
+
+<p align="center">
+  Reusable structural engineering building blocks for Python applications.
+</p>
+
+<p align="center">
+  <img alt="Version 2.0.1" src="https://img.shields.io/badge/version-2.0.1-orange?style=for-the-badge">
+  <img alt="Alpha" src="https://img.shields.io/badge/stage-alpha-orange?style=for-the-badge">
+  <img alt="Python 3.10 to 3.13" src="https://img.shields.io/badge/python-3.10%20to%203.13-blue?style=for-the-badge">
+  <img alt="Apache 2.0 license" src="https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge">
+  <a href="https://github.com/Ayberkrk/timoshenko/actions/workflows/tests.yml"><img alt="Tests" src="https://github.com/Ayberkrk/timoshenko/actions/workflows/tests.yml/badge.svg"></a>
+</p>
+
+Timoshenko packages common structural calculations, modal analysis, sensor
+workflows, and monitoring components so applications can reuse them instead
+of rebuilding the same foundations for every project. It is an embeddable
+Python library and engine core, not a hosted monitoring service or a general
+finite-element solver.
+
+> **Alpha:** the API may still change between releases. Timoshenko is not yet
+> published on PyPI; install it from GitHub or from a checkout as shown below.
+
+## Install
+
+From GitHub:
+
+```bash
+python -m pip install "timoshenko-engine @ git+https://github.com/Ayberkrk/timoshenko"
+```
+
+Or from the root of a checkout:
+
+```bash
+python -m pip install .
+```
+
+The distribution package is named `timoshenko-engine`. The Python import
+package is named `timoshenko`:
+
+```python
+import timoshenko as tm
+print(tm.__version__)
+```
+
+To install optional MQTT support, use:
+
+```bash
+python -m pip install '.[mqtt]'
+```
+
+A future published release can be installed with
+`python -m pip install timoshenko-engine`. That command is only usable after a
+release is available from the selected package index.
+
+## Quick start
+
+```python
+import timoshenko as tm
+
+structure = tm.Structure(
+    structure_id="building-01",
+    story_masses_kg=[120_000.0, 110_000.0],
+    story_stiffness_n_m=[85_000_000.0, 70_000_000.0],
+)
+
+sensors = tm.load_sensors(
+    "acceleration.csv",
+    sampling_hz=100.0,
+    column="acceleration_m_s2",
+    unit="m/s^2",
+)
+
+modal = tm.modal.identify(sensors)
+updated = tm.update(structure, modal)
+health = tm.health.assess(structure=updated, observations=sensors)
+
+print(health.to_dict())
+```
+
+For a one-shot pipeline, `tm.monitor(structure, sensors)` performs the same
+analysis sequence and returns a serializable result. The model update applies
+one global stiffness multiplier and keeps the analytical reference frequencies
+separate from measured frequencies.
+
+## What it provides
+
+| Area | Reusable components |
+|---|---|
+| Structural models | Lumped-mass shear-building models and analytical natural frequencies |
+| Modal analysis | Single-channel peak picking, damping estimates when resolvable, and multi-channel FDD with complex mode shapes |
+| Model comparison | Log-frequency mode pairing, global stiffness updating, and evidence-oriented health assessment |
+| Monitoring | Caller-fed bounded sessions, batch validation, source adapters, and optional plugins |
+| Data workflow | Sensor CSV loading, project manifests, local SQLite history, and CSV replay |
+| Reporting | Standalone HTML reports with an embedded SVG frequency comparison |
+| Engineering calculations | Beam cases, section properties, mechanics, vibration, stability, stress, pressure, torsion, and uncertainty helpers |
+
+Timoshenko can be used module by module or embedded in a larger product such as
+Cauren. Sensor collection, application-specific risk rules, and engineering
+interpretation remain with the integrating application.
+
+## Multi-channel modal screening
+
+FDD requires synchronized channels with a common sample rate and unit:
+
+```python
+signals = tm.load_multichannel_csv(
+    "aligned_accelerometers.csv",
+    columns=["deck_left", "deck_center", "deck_right"],
+    sampling_hz=100.0,
+    units=["m/s^2"] * 3,
+)
+fdd = tm.identify_fdd(signals, nperseg=1024, max_modes=5)
+print(fdd.to_dict())
+```
+
+This first FDD implementation returns candidate frequencies and complex mode
+shapes. It does not estimate damping or issue a damage or safety conclusion.
+
+## Bounded monitoring session
+
+A caller supplies timestamped observation batches. The session aligns samples,
+waits for a fresh contiguous analysis window after gaps, and emits reports after
+each configured hop:
+
+```python
+session = tm.MonitoringSession(
+    structure,
+    sensor_ids=["deck-left", "deck-right"],
+    units=["m/s^2", "m/s^2"],
+    sampling_hz=100.0,
+    window_samples=2048,
+    hop_samples=512,
+    analysis_options={"nperseg": 512, "max_modes": 4},
+)
+result = session.ingest(batch)
+for report in result.reports:
+    tm.report.save_html(report, "reports/latest.html")
+```
+
+A gateway remains responsible for collecting data and handling transport
+reconnection. Timoshenko does not run a background collector or select an alarm
+policy.
+
+## Further examples and documentation
+
+- [Documentation home](docs/index.md)
+- [Architecture](docs/architecture.md)
+- [Data contract](docs/data-contract.md)
+- [Historical CSV replay](docs/csv-source.md)
+- [Plugin contract](docs/plugin-contract.md)
+- [Rayleigh damping](docs/rayleigh-damping.md)
+- [Section properties](docs/section-properties.md)
+- [Polygon section properties](docs/polygon-sections.md)
+- [Equation uncertainty](docs/uncertainty.md)
+- [Numerical methods and limits](docs/numerical-methods.md)
+- [Monitoring sessions](docs/live-sessions.md)
+- [Source adapters](docs/adapters.md)
+- [Project manifests](docs/project-manifest.md)
+- [Local storage](docs/storage.md)
+- [Reports](docs/reporting.md)
+- [Optional MQTT adapter](docs/mqtt-adapter.md)
+- [SensorThings adapter](docs/sensorthings-adapter.md)
+- [Engineering calculations](examples/engineering_primitives.py)
+- [Runnable examples](examples/)
+- [Publishing and citation](docs/publishing.md)
+
+## Limits and engineering posture
+
+- Timoshenko is alpha software and is not a structural safety certification tool.
+- Its shear-building model is a small lumped-mass reference model, not a full FEM solver.
+- Modal identification is a screening estimate. A single sensor may miss a mode near a modal node.
+- Damping is reported only when the averaged spectrum resolves the half-power bandwidth; otherwise it is `None`.
+- FDD requires synchronized channels and does not estimate damping.
+- The model update applies a single stiffness scale. It cannot locate or size local damage.
+- A frequency shift is evidence for human review, not a damage verdict. Temperature, sensor placement, boundary conditions, and other effects can shift measurements.
+- A monitoring session consumes data supplied by the caller. It does not implement a broker subscription, reconnect loop, scheduler, hosted dashboard, or alarm policy.
+- Closed-form mechanics and section functions rely on their documented ideal assumptions. They are not code-compliance checks.
+
+## Development
+
+```bash
+python -m pip install -e ".[test]"
+python -m pytest
+```
+
+To build the documentation locally, install the optional documentation tools
+and run MkDocs:
+
+```bash
+python -m pip install -e ".[docs]"
+python -m mkdocs serve
+```
+
+The test suite checks analytical cases, input validation, adapters, storage,
+monitoring sessions, and reports. Package distributions should be built and
+installed in a clean environment before a release is uploaded.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

timoshenko_engine-2.0.1/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "timoshenko-engine"
+version = "2.0.1"
+description = "Composable structural engineering calculations and analysis primitives for Python applications."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = ["numpy>=1.24"]
+authors = [{ name = "Ayberk Korkmaz" }]
+keywords = [
+  "civil engineering",
+  "structural engineering",
+  "structural health monitoring",
+  "modal analysis",
+  "digital twin",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+
+[project.optional-dependencies]
+mqtt = ["paho-mqtt>=2.1,<3"]
+test = ["pytest>=7"]
+docs = ["mkdocs-material>=9.5,<10"]
+
+[project.entry-points."timoshenko.plugins"]
+mqtt = "timoshenko.mqtt:MqttPlugin"
+sensorthings = "timoshenko.sensorthings:SensorThingsPlugin"
+
+[project.urls]
+Homepage = "https://github.com/Ayberkrk/timoshenko"
+Repository = "https://github.com/Ayberkrk/timoshenko"
+Issues = "https://github.com/Ayberkrk/timoshenko/issues"
+Documentation = "https://github.com/Ayberkrk/timoshenko/tree/main/docs"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+xfail_strict = true