Repository navigation
Docs/readme agents - #1049
Merged
Merged
Docs/readme agents#1049
Conversation
README: - Fix minimum GiD version (16.1.10d, matching kratos.xml) - Fix duplicated step numbering and typos; update Codacy and Docker Hub links - Execution modes as a table; point to PyPI for supported Python versions - Add Linux/macOS link instructions, applications list, repository layout, testing (CI + safe-to-test label), contributing and license sections AGENTS.md: - Repository and per-app layout, app.json conventions - Version bump checklist and kratos.transform compatibility rule - How testing works (kratos-gid-tester) and repository rules Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
TODO.md still misclassifies registered callbacks, runtime-generated routes, and valid Tcl namespace resolution as defects or unused code, creating misleading findings and unsafe cleanup recommendations.
4 open issues
What changed in this PR
This documentation-only PR expands onboarding and contributor guidance for the Kratos–GiD interface and adds a phased code-audit backlog.
Changes:
- Reorganizes the README around installation, execution modes, applications, testing, and contributions.
- Adds
AGENTS.mdwith repository structure, conventions, compatibility rules, and validation guidance. - Adds
TODO.mdwith prioritized audit findings and proposed cleanup and refactoring work.
| File | Description |
|---|---|
TODO.md |
Adds a phased audit backlog, distinguishing code-checked items from unconfirmed reports. |
README.md |
Expands user setup and contributor documentation and updates the stated minimum GiD version. |
AGENTS.md |
Documents development conventions, versioning, model compatibility, and testing procedures. |
Review effort: Balanced
| - [ ] 🟢 [A] `scripts/Controllers/ApplicationMarketWindow.tcl:310` — `set must_open_init_window 0` sin `variable` (sin efecto); L138 usa `$root` posiblemente indefinido. Mismo patrón con `initwind` en `CreateLauncherWindow`/`CreateDimensionWindow`. | ||
| - [ ] 🟢 [A] `scripts/Writing/WriteConditions.tcl:38` — `ne $groups` en vez de `ni` (no deduplica; lo usa MPM). | ||
| - [ ] 🟢 [A] `scripts/Controllers/MdpaImportMesh.tcl:127` — `if {$id in [dict exists ...]} {next}` → `if {[dict exists ...]} {continue}`; cerrar `$fp` y `EndWaitState` con `try/finally`. | ||
| - [ ] 🟢 [A] Errores de una línea: `ConstitutiveLaw.tcl:398` (`set $cl`), `ConstitutiveLaw.tcl:351`, `Writing.tcl:61` (`configutation`), `Writing.tcl:90` (`]` suelto), `WriteProjectParameters.tcl:142` (ignora `cut_planes_UN`), `TreeInjections.tcl:988`, `TreeInjections.tcl:962` (`get_materials_list_simple` vs `ProcGet_materials_list_simple`). |
|
|
||
| ### Apps | ||
| - [ ] 🔴 [V] `apps/PfemThermic/xml/NodalConditions.xml:72` — `INLET` usa `AssignInletProcess` (renombrado a `AssignLagrangianInletProcess` solo en PfemFluid, commit `48f4290ef`) → `TreeInjections.tcl:231` lanza error. | ||
| - [ ] 🔴 [V] `apps/GeoMechanics/app.json:37-45` — `unique_names` (`GEOMParts`, `GEOMNodalConditions`, `GEOMBC`, `GEOMResults`, `GEOMTimeParameters`) no existen; el árbol usa `STParts`, `STNodalConditions`, `STLoads,GEOMLoads`, `STResults`. |
| ### Apps | ||
| - [ ] 🔴 [V] `apps/PfemThermic/xml/NodalConditions.xml:72` — `INLET` usa `AssignInletProcess` (renombrado a `AssignLagrangianInletProcess` solo en PfemFluid, commit `48f4290ef`) → `TreeInjections.tcl:231` lanza error. | ||
| - [ ] 🔴 [V] `apps/GeoMechanics/app.json:37-45` — `unique_names` (`GEOMParts`, `GEOMNodalConditions`, `GEOMBC`, `GEOMResults`, `GEOMTimeParameters`) no existen; el árbol usa `STParts`, `STNodalConditions`, `STLoads,GEOMLoads`, `STResults`. | ||
| - [ ] 🔴 [V] `apps/GeoMechanics/write/write.tcl:64` — llama a `write::writeModelPartFileOld`; el proc es `::GeoMechanics::write::writeModelPartFileOld` (L125). |
| - Launch: `InstallAllPythonDependencies` (y `exec/install_python.win.bat`, `exec/global_pip.win.bat`), `InstallPip`, `GetMissingPipPackagesGiDsPython_old`, `CreateModeCombo`, `CheckDependenciesLocalPipMode`. | ||
| - Utils: `SetMeshCriteria`/`ResetMeshCriteria`, `GetExecVersion`, `proc ?`. | ||
| - Model: `GetAllCLInputs`, `GetAllCondInputs`, `GetAllCondOutputs`, `GetAllElemInputs`, `GetAllSchemeParams`, `GetAllSolStratParams`, `GetAvailableConditions`, `CheckCondOutputState`, `DeleteRepeatedConditions`, `getAllProcs`, `Element::getNodalCondition`. | ||
| - apps/spdAux: `apps::ClearActiveApp`, `spdAux::ExploreAllRoutes`, `ForceExtremeLoad`, `insertDependenciesSoft`, `InsertMaterialsSimple`; `Proc*` sin referencia: `ProcRefreshTree`, `ProcgetStateFromXPathValue2`, `ProcCambioMat`, `ProcEdit_database_list`, `ProcGetIntervals`, `ProcGet_materials_list_simple`, `ProcPartParamValue`, `ProcShowInMode` (ojo: `.spd` de usuario antiguos). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.