Skip to content

Commit 6b02239

Browse files
Merge branch 'main' into py_sdk
2 parents 55dcd07 + b53cda4 commit 6b02239

1 file changed

Lines changed: 4 additions & 29 deletions

File tree

python/README.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ A Python framework for building UMAA-compliant unmanned maritime systems on RTI
44

55
---
66

7+
**[Python SDK Documentation](https://rtidgreenberg.github.io/rti_umaa_py_docs/)**
8+
9+
10+
711
## Quick Start
812

913
### 1. Get an RTI License
@@ -64,35 +68,6 @@ For questions or issues, email **services_community@rti.com**.
6468

6569
---
6670

67-
## Architecture Documentation
68-
69-
Detailed design docs are in [architecture/](architecture/):
70-
71-
| Document | Description |
72-
|----------|-------------|
73-
| [System Architecture](architecture/system-architecture.md) | Design principles, threading model, tiered overview |
74-
| [Implementation Plan](architecture/implementation-plan.md) | 9-PR staged plan with acceptance criteria |
75-
| [DDSContext](architecture/dds-context.md) | DDS lifecycle, entity factories, QoS resolution |
76-
| [Command Services](architecture/command-services.md) | Tier 0 command pattern — 7 hooks, CFT, disposal |
77-
| [Report Services](architecture/report-services.md) | Tier 1 report pattern |
78-
| [Large Set Services](architecture/large-set-services.md) | Tier 2 set-valued reports with CRUD |
79-
| [Large List Services](architecture/large-list-services.md) | Tier 3 ordered list reports |
80-
| [Composite Services](architecture/composite-services.md) | Tier 4 one-off classes |
81-
| [Services Catalog](architecture/services-catalog.md) | Complete 350 service inventory |
82-
| [Error Handling](architecture/error-handling.md) | 4-layer exception strategy |
83-
84-
---
85-
86-
## C++ SDK References
87-
88-
Two C++ reference implementations inform this SDK's design:
89-
90-
| SDK | Organization | DDS Middleware |
91-
|-----|-------------|---------------|
92-
| **PSU/ARL** | Penn State Applied Research Lab | RTI Connext DDS |
93-
| **JHU/APL** | Johns Hopkins Applied Physics Lab | Eclipse Cyclone DDS |
94-
95-
`rtiumaapy` uses the same DDS middleware as PSU/ARL but replaces the poll-based `cycle()` model with Python's cooperative `asyncio` event loop via `rti.asyncio`.
9671

9772
---
9873

0 commit comments

Comments
 (0)