docs: rewrite READMEs dry and blunt, rename Studio to OTKO
Some checks failed
CI / lint (pull_request) Has been cancelled
CI / test (macos-latest, 3.10) (pull_request) Has been cancelled
CI / test (macos-latest, 3.11) (pull_request) Has been cancelled
CI / test (macos-latest, 3.12) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.10) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.11) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.12) (pull_request) Has been cancelled
CI / test (windows-latest, 3.10) (pull_request) Has been cancelled
CI / test (windows-latest, 3.11) (pull_request) Has been cancelled
CI / test (windows-latest, 3.12) (pull_request) Has been cancelled
Some checks failed
CI / lint (pull_request) Has been cancelled
CI / test (macos-latest, 3.10) (pull_request) Has been cancelled
CI / test (macos-latest, 3.11) (pull_request) Has been cancelled
CI / test (macos-latest, 3.12) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.10) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.11) (pull_request) Has been cancelled
CI / test (ubuntu-latest, 3.12) (pull_request) Has been cancelled
CI / test (windows-latest, 3.10) (pull_request) Has been cancelled
CI / test (windows-latest, 3.11) (pull_request) Has been cancelled
CI / test (windows-latest, 3.12) (pull_request) Has been cancelled
This commit is contained in:
parent
612936a00b
commit
3d809ca301
11 changed files with 233 additions and 263 deletions
159
README.md
159
README.md
|
|
@ -3,14 +3,13 @@
|
|||
</p>
|
||||
|
||||
<p align="center">
|
||||
A modern, SAP2000-style desktop GUI for
|
||||
<a href="https://openseespydoc.readthedocs.io/">OpenSeesPy</a> —
|
||||
built for structural and earthquake engineers who want a visual
|
||||
modeling environment without leaving the OpenSees ecosystem.
|
||||
A SAP2000-style desktop GUI for
|
||||
<a href="https://openseespydoc.readthedocs.io/">OpenSeesPy</a>.
|
||||
Draw the model, click run, look at the diagrams.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<em>Status: Pre-alpha. Active development. APIs and file formats will change.</em>
|
||||
<em>Pre-alpha. Under active development. APIs and file formats will change.</em>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
|
@ -19,21 +18,20 @@
|
|||
|
||||
## Why
|
||||
|
||||
OpenSees is the gold-standard nonlinear FEM solver for earthquake
|
||||
engineering, but its native interface is Tcl/Python scripts.
|
||||
OTKO adds a visual front-end so you can:
|
||||
OpenSees does nonlinear FEM well. Its user interface is a script.
|
||||
OTKO puts a visual front-end on it:
|
||||
|
||||
- Click to draw nodes, frames, supports, and loads on a snapped grid.
|
||||
- Draw nodes, frames, supports, and loads on a snapped grid.
|
||||
- Assign materials, sections, and load patterns through dialogs.
|
||||
- Run static, modal, pushover, and time-history analyses with progress
|
||||
and cancel support.
|
||||
- Inspect results visually — deformed shape, mode shapes, force
|
||||
and cancel.
|
||||
- Look at the results — deformed shape, mode shapes, force
|
||||
diagrams, pushover curves, time-history plots, hysteresis loops.
|
||||
- Save the model as a single `.osmodel` JSON file that round-trips
|
||||
cleanly (diff-able in Git, scriptable from Python).
|
||||
- Save the model as one `.osmodel` JSON file. Diffs cleanly in Git,
|
||||
builds cleanly from Python.
|
||||
|
||||
Behind the GUI, the same `core` Pydantic model is fully usable from a
|
||||
script or Jupyter notebook — the GUI is one frontend, not the only one.
|
||||
Underneath, the `core` Pydantic model works fine from a script or
|
||||
notebook. The GUI is a front-end, not the whole product.
|
||||
|
||||
## What works today
|
||||
|
||||
|
|
@ -53,11 +51,11 @@ script or Jupyter notebook — the GUI is one frontend, not the only one.
|
|||
mode shapes, axial / shear / moment diagrams, pushover curves
|
||||
(in display units), time-history plots, hysteresis loops,
|
||||
response-spectrum SRSS / CQC, snapshot + video export.
|
||||
- **Persistence** — projects save as a single JSON `.osmodel` file
|
||||
(Pydantic-validated, round-trip-clean).
|
||||
- **Examples** — 20+ verified examples bundled, including the OpenSees
|
||||
Wiki Examples-1 through Example-4 family and a fiber-section RC frame
|
||||
pushover. See [`examples/README.md`](examples/README.md).
|
||||
- **Persistence** — one JSON `.osmodel` per project, Pydantic-validated,
|
||||
round-trips clean.
|
||||
- **Examples** — 20+ verified examples, including OpenSees
|
||||
Wiki Examples 1–4 and a fiber-section RC frame pushover.
|
||||
See [`examples/README.md`](examples/README.md).
|
||||
|
||||
## Tech stack
|
||||
|
||||
|
|
@ -74,22 +72,22 @@ script or Jupyter notebook — the GUI is one frontend, not the only one.
|
|||
|
||||
## Architecture
|
||||
|
||||
Strict MVVM + service layer. The `core` package is pure Python — no Qt,
|
||||
no OpenSeesPy imports — and is fully unit-testable in isolation.
|
||||
Strict MVVM + service layer. `core` is pure Python — no Qt,
|
||||
no OpenSeesPy imports — and unit-tests in isolation.
|
||||
|
||||
```
|
||||
views (Qt) → viewmodels → services (OpenSeesRunner, Persistence) → core (model)
|
||||
```
|
||||
|
||||
See [`docs/architecture.md`](docs/architecture.md) for the long form,
|
||||
including the canonical OpenSeesPy command sequence the runner emits.
|
||||
Long version in [`docs/architecture.md`](docs/architecture.md),
|
||||
including the OpenSeesPy command order the runner emits.
|
||||
|
||||
## Install (development)
|
||||
|
||||
**Desktop GUI** (includes Qt, PyVista, pyqtgraph, imageio):
|
||||
**Desktop GUI** (Qt, PyVista, pyqtgraph, imageio):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ogunc/otko.git
|
||||
git clone ssh://git@smill-home.ddns.net/smill/otko.git
|
||||
cd otko
|
||||
|
||||
python -m venv .venv
|
||||
|
|
@ -99,22 +97,21 @@ source .venv/bin/activate # Linux / macOS
|
|||
pip install -e ".[gui,dev]"
|
||||
```
|
||||
|
||||
**Headless / web reuse** (core + services only, no Qt pulled in):
|
||||
**Headless** (core + services only, no Qt):
|
||||
|
||||
```bash
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
This installs only the headless base set (pydantic, numpy, h5py, openseespy).
|
||||
It is the correct install for web backends, scripts, and Jupyter notebooks that
|
||||
reuse `otko.core` or `otko.services` without the GUI.
|
||||
That pulls pydantic, numpy, h5py, openseespy and nothing else.
|
||||
Use it for scripts, notebooks, and web backends that reuse
|
||||
`otko.core` or `otko.services` without the GUI.
|
||||
|
||||
Python 3.10+ is required. On Windows use **3.12+** — the `openseespywin==3.8.0.0`
|
||||
wheel has no 3.11 build (`Requires-Python >=3.12`). Pin both
|
||||
`openseespy==3.8.0.0` and `openseespywin==3.8.0.0` (already pinned
|
||||
in `pyproject.toml`).
|
||||
Python 3.10+. On Windows use **3.12+** — `openseespywin==3.8.0.0`
|
||||
has no 3.11 wheel (`Requires-Python >=3.12`). Both pins already
|
||||
live in `pyproject.toml`.
|
||||
|
||||
## Quick start — the 60-second tour
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
python -m otko
|
||||
|
|
@ -122,22 +119,20 @@ python -m otko
|
|||
|
||||
Then:
|
||||
|
||||
1. **File → Open** → pick `examples/cantilever.osmodel`.
|
||||
1. **File → Open** → `examples/cantilever.osmodel`.
|
||||
2. **Analyze → Cases** → run `Tip-Load`.
|
||||
3. **Display → Show Force Diagram** → component **M3** → linear moment
|
||||
peaking at 50 kN·m at the fixed end. Component **V2** → constant
|
||||
-10 kN.
|
||||
4. **Display → Show Deformed Shape** → the classic cantilever curve.
|
||||
3. **Display → Show Force Diagram** → **M3**: linear moment,
|
||||
50 kN·m at the fixed end. **V2**: constant -10 kN.
|
||||
4. **Display → Show Deformed Shape** → cantilever curve, as advertised.
|
||||
|
||||
For a nonlinear walkthrough, open `examples/portal_pushover.osmodel`,
|
||||
run the `Push-X` case, then **Display → Show Pushover Curve** — you'll
|
||||
see the elastic ramp followed by a yield plateau as the fiber-section
|
||||
hinges form at the column bases.
|
||||
Nonlinear version: open `examples/portal_pushover.osmodel`,
|
||||
run `Push-X`, **Display → Show Pushover Curve**. Elastic ramp,
|
||||
then a yield plateau as the base hinges form.
|
||||
|
||||
## Run the test suite
|
||||
|
||||
```bash
|
||||
pytest tests/unit # pure-logic tests, milliseconds
|
||||
pytest tests/unit # pure logic, milliseconds
|
||||
pytest tests/gui # Qt event-loop tests (pytest-qt)
|
||||
pytest tests/integration # real OpenSeesPy runs on bundled examples
|
||||
```
|
||||
|
|
@ -147,57 +142,47 @@ CI runs lint + the non-`slow` subset on Linux / macOS / Windows
|
|||
|
||||
## Roadmap
|
||||
|
||||
See [`docs/roadmap.md`](docs/roadmap.md) for the phase-by-phase plan.
|
||||
Phases 0–7 (modeling, analysis, post-processing) are largely done.
|
||||
Phase 8 (earthquake-engineering primitives — isolators, ground-motion
|
||||
library, IDA, fiber-section editor polish) is the active edge.
|
||||
[`docs/roadmap.md`](docs/roadmap.md) has the phase-by-phase plan.
|
||||
Phases 0–7 (modeling, analysis, post-processing) are mostly done.
|
||||
Phase 8 (isolators, ground-motion library, IDA, fiber-section
|
||||
editor polish) is where the open work is.
|
||||
|
||||
## We're looking for collaborators
|
||||
## Collaborators wanted
|
||||
|
||||
This project is most useful to researchers and engineers who already
|
||||
work with OpenSees and want a faster path from "idea" to "model" —
|
||||
**and who would rather build that path together than alone.**
|
||||
Most useful to people who already work with OpenSees and want a
|
||||
shorter path from idea to model — and would rather build it together
|
||||
than alone. Open an issue or say hi if you are:
|
||||
|
||||
If any of the following sounds like you, please open an issue or
|
||||
say hi:
|
||||
- A **structural / earthquake engineer** who knows OpenSees Tcl
|
||||
or OpenSeesPy and can tell us when a feature is almost right
|
||||
but not quite.
|
||||
- A **researcher** running pushover, IDA, or response-spectrum studies
|
||||
who can check the GUI against hand-built scripts.
|
||||
- A **Python / Qt developer** into scientific desktop apps,
|
||||
VTK rendering, or Pydantic schema design.
|
||||
- A **student** learning FEM and GUI architecture at the same time —
|
||||
the examples and tests are meant to read as documentation.
|
||||
- A **UX / icon designer** willing to argue about dialogs, toolbar
|
||||
icons, and visual language.
|
||||
|
||||
- 🌉 **Structural / earthquake engineers** comfortable with OpenSees Tcl
|
||||
or OpenSeesPy who can spot when a feature is "almost right but not
|
||||
quite" — that calibration feedback is gold.
|
||||
- 🧪 **Researchers** running pushover, IDA, or response-spectrum studies
|
||||
who want to validate the GUI against their hand-built scripts.
|
||||
- 🐍 **Python / Qt developers** interested in scientific desktop apps,
|
||||
PyVista / VTK rendering, or Pydantic-driven schema design.
|
||||
- 📚 **Students** who want to learn structural FEM and modern GUI
|
||||
architecture at the same time — example walkthroughs and tests are
|
||||
designed to read as documentation.
|
||||
- 🎨 **UX / icon designers** willing to help shape the dialog set,
|
||||
toolbar icons, and overall visual language.
|
||||
|
||||
Open issues, bug reports, and reproducible test cases are just as
|
||||
valuable as code. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the dev
|
||||
setup and the architectural rules enforced in review.
|
||||
Bug reports and reproducible test cases count as contributions.
|
||||
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for setup and the rules
|
||||
enforced in review.
|
||||
|
||||
## License
|
||||
|
||||
OTKO is released under the **GNU Affero General Public
|
||||
License v3.0** ([`LICENSE`](LICENSE)).
|
||||
OTKO is **GNU Affero General Public License v3.0**
|
||||
([`LICENSE`](LICENSE)). Read the license itself, not just this:
|
||||
|
||||
Plain-language summary (not legal advice — read the license itself):
|
||||
|
||||
- ✅ Use it for **research, education, and personal projects** with no
|
||||
obligation other than keeping the copyright notice intact.
|
||||
- ✅ Modify and fork it freely.
|
||||
- ⚠️ If you **distribute** it, modified or not, you must release your
|
||||
full source under AGPL-3.0.
|
||||
- ⚠️ If you **run it as a network service** (e.g. host a modified
|
||||
version as a SaaS), you must release your modifications under
|
||||
- Research, education, personal projects: fine, keep the copyright
|
||||
notice.
|
||||
- Fork and modify: fine.
|
||||
- Distribute it (modified or not): release your full source under
|
||||
AGPL-3.0.
|
||||
- Run a modified version as a network service: release your
|
||||
modifications under AGPL-3.0.
|
||||
|
||||
In other words: anyone is free to learn from and build on this code,
|
||||
but commercial forks and proprietary derivatives must contribute their
|
||||
changes back to the community. If your use case needs a different
|
||||
arrangement (e.g. a closed-source commercial license), please open an
|
||||
issue to discuss.
|
||||
Commercial forks stay open. If you need a different arrangement
|
||||
(e.g. closed-source commercial license), open an issue.
|
||||
|
||||
Copyright © 2026 Ozan and contributors.
|
||||
|
|
|
|||
Loading…
Reference in a new issue