smill/otko

Watch

History

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
smillmorel cb4bf8fccd docs: quick guide, docs README, specifications and NOTICE		2026-09-16 12:03:07 -04:00
..
adr	feat: initial otko import	2026-09-08 02:12:15 -04:00
screenshots	feat: initial otko import	2026-09-08 02:12:15 -04:00
architecture.md	docs: rewrite READMEs dry and blunt, rename Studio to OTKO	2026-09-08 02:41:03 -04:00
gap-analysis-gidopensees.md	docs: rewrite READMEs dry and blunt, rename Studio to OTKO	2026-09-08 02:41:03 -04:00
logo.svg	docs: rewrite READMEs dry and blunt, rename Studio to OTKO	2026-09-08 02:41:03 -04:00
QUICK_GUIDE.md	docs: quick guide, docs README, specifications and NOTICE	2026-09-16 12:03:07 -04:00
README.md	docs: quick guide, docs README, specifications and NOTICE	2026-09-16 12:03:07 -04:00
roadmap.md	docs: rewrite READMEs dry and blunt, rename Studio to OTKO	2026-09-08 02:41:03 -04:00

README.md

OTKO Documentation

Index of the project documentation. Start with the quick guide if you just want to build and run a model; read the architecture page if you are changing code.

Document	What it covers
QUICK_GUIDE.md	Task-first walkthrough: cantilever model, modal analysis, report and script export, display units, undo/redo.
architecture.md	MVVM layering, package responsibilities, threading, persistence, and the fixed OpenSeesPy command order.
roadmap.md	Phase-by-phase feature status, from scaffolding through the earthquake-engineering primitives.
adr/	Architecture Decision Records — the "why" behind individual design choices.
screenshots/	Screenshots referenced by the docs and README.

Architecture Decision Records

../README.md — project overview, install, and quick start.
../CONTRIBUTING.md — dev setup, layering rules, commit style, and verify commands.
../AGENTS.md — condensed context for automated agents.
gap-analysis-gidopensees.md — gap analysis against the GiD/OpenSees reference.
../examples/README.md — the bundled example models.