Blame for ORCASat/ORCASat_CAD/source/finalize_docs.py

"""Write release documentation using the measured delivery inventory."""
from pathlib import Path
from collections import Counter
import json


def main():
    out=Path(__file__).resolve().parent.parent
    summary=json.loads((out/'build_summary.json').read_text())
    report=json.loads((out/'validation_report.json').read_text())
    manifest=json.loads((out/'EXPORT/manifest.json').read_text())
    assert report['version']==summary['version']==manifest['version']=='2.1'
    assert not report['targeted_fit_checks']['failures']
    kinds=Counter(x['kind'] for x in manifest['files'])
    n=len(manifest['files']);parts=manifest['components_defined'];solids=manifest['solids_defined']
    states='\n'.join(f"| {name} | {next(x['solids'] for x in report['STEP'] if x['path']=='ORCASat_'+name+'.step')} |" for name in ['Stowed','Deployed','Internal','Exploded'])
    (out/'README.md').write_text(f'''# ORCASat CAD — v2.1

2 listopada 2026. Jednostki STEP: **milimetry**. Jednostki GLB: **metry**.

Zacznij od **START_HERE_PL.md**. Rozpakuj całe archiwum do nowego, pustego folderu. W SolidWorks otwórz `ORCASat_Stowed.step` i poczekaj na zakończenie importu. Pojawienie się drzewa złożenia może poprzedzać wyświetlenie geometrii. Wcześniejszy pusty widok w tej rozmowie wynikał z długiego ładowania.

## Zawartość jednego pakietu

| Plik / folder | Zawartość |
| --- | --- |
| ORCASat_Stowed.step | Cały satelita ze złożonym magnetometrem i zwiniętą anteną |
| ORCASat_Deployed.step | Rozłożona antena i magnetometr; położenia poglądowe |
| ORCASat_Internal.step | Wnętrze w stanie złożonym, bez paneli zewnętrznych i ich osprzętu |
| ORCASat_Exploded.step | Rozsunięte moduły oraz panele w stanie rozłożonym; bez wiązek łączących |
| modules/ | Dziewięć kolorowych modułów STEP oraz dwa warianty rozłożone |
| compatibility/ | Cztery płaskie warianty AP203 Multibody, alias Exploded Legacy i sześciany kontrolne 20 mm |
| EXPORT/ | **{n} GLB**: {kinds['assembly']} pełne sceny, {kinds['module']} modułów, {kinds['panel']} paneli, {kinds['part']} części i {kinds['solid']} brył |
| previews/ oraz ORCASat_Overview.png | Bieżące podglądy wszystkich wariantów |
| CHANGELOG_V2_1_PL.md | Poprawki po audycie filmu z odnośnikami czasowymi |
| CHANGELOG_V2_PL.md | Historia poprzedniego wydania |
| verification/ | Podglądy wynikowych GLB, porównanie z filmem i historyczny audyt v2.0 |
| component_manifest.csv | Każdy komponent, jego stan, liczba brył, objętość i obwiednia |
| dimension_sources.csv | Źródła wymiarów i wartości oszacowane |
| fit_checks.json | Kontrola wybranych styków poprawianych elementów |
| validation_report.json | Rzeczywiste wyniki ponownych importów STEP i kontroli GLB |
| source/ | Edytowalny model CadQuery, eksporter, renderer i skrypty kontroli |
| source_assets/ | Oryginalne pliki, rysunki i kompletne niezmienione archiwum źródłowej anteny |

W stanie Stowed model zawiera **{summary['components_stowed']} nazwanych komponentów i {summary['solids_stowed']} brył**. Łącznie, z definicjami obu stanów, jest {parts} komponentów i {solids} brył. Elementy wspólne stanom zapisano jednokrotnie w osobnych GLB części i brył; gotowe sceny zawierają właściwy zestaw.

## Poprawki v2.1

Połączono okno serwisowe OBC/EPS w kształt schodkowy, skorygowano strony złączy i położenie USB, poprawiono balast ze zlicowanymi śrubami i izolacją. Usunięto wskazane kolizje nośnika magnetometru z ogniwami i balastu ze wspornikiem. Uzupełniono FSS, GNSS, wiązki, opaski balunu, ciągłe zwinięte taśmy antenowe i detale paneli. Dokładne pochodzenie oraz zakres zmian opisuje `CHANGELOG_V2_1_PL.md`.

Źródłowa antena wnosi **162 nieprzeskalowane bryły** w stanie Stowed, obejmujące płytkę, obudowy, drzwi, elementy burn-wire, balun, linki i śruby. Jej globalna pozycja oraz dodatkowe odtworzone taśmy i opaski są oszacowane.

## Otwieranie i edycja

Główne pliki STEP są kolorowymi złożeniami AP214 z nazwanymi modułami i komponentami. Po imporcie dopasuj widok klawiszem F i zapisz model w swoim formacie SolidWorks. Warianty płaskie AP203 znajdują się w `compatibility/`.

Cztery sceny to **cztery osobne pliki**, a nie natywne konfiguracje jednego SLDASM. STEP zachowuje bryły i położenia; nie zawiera natywnej historii operacji, wiązań, mechanizmu ruchu ani mas materiałów. Oryginalne pliki SLDPRT/SLDASM źródłowej anteny pozostają w `source_assets/`.

## Skala i osie

Nominalna obwiednia szyn wynosi **100 × 100 × 227 mm**; początkiem układu jest jej środek. Czujniki, łby śrub i elementy rozkładane mogą wystawać poza tę obwiednię.

| Oś STEP | Strona dodatnia | Strona ujemna |
| --- | --- | --- |
| X | Ram / moduł optyczny | Wake / antena |
| Y | Starboard | Port |
| Z | Nadir / otwór optyczny | Zenith / FSS i GNSS |

GLB używa prawoskrętnego układu Y-up: `glTF = (−STEP_Y, STEP_X, STEP_Z) / 1000`. Pełne sceny, moduły i panele zachowują wspólny początek satelity. Osobne części i bryły są wycentrowane lokalnie; `EXPORT/placement_manifest.csv` i `manifest.json` podają przesunięcia przywracające położenia.

## Weryfikacja tego wydania

Wszystkie zdefiniowane kształty są poprawnymi bryłami według Open CASCADE. Sprawdzono **{report['targeted_fit_checks']['tested_pairs']} wybranych par** z audytu i ich sąsiedztwa; nie stwierdzono kolizji powyżej progu 0,00001 mm³. Zakres każdej pary i zmierzony wynik znajdują się w `fit_checks.json`.

Każdy odrębny STEP ponownie wczytano i sprawdzono: poprawność brył, milimetry i właściwy schemat AP214/AP203. Cztery główne sceny mają zgodną liczbę brył i objętość w tolerancji względnej 1e−6 (całkowanie adaptacyjne 1e−8).

| Scena STEP | Bryły po ponownym imporcie |
| --- | ---: |
{states}

Sprawdzono wszystkie **{n} GLB**: nagłówki, bufory, indeksy trójkątów, liczby skończone, normalne, pokrycie komponentów i brył oraz sumy SHA-256. Wszystkie 21 scen satelity/modułów/paneli wczytano także przez niezależny czytnik {report['GLB']['independent_loader']}. Nie wykonywano tutaj testu aplikacyjnego w SolidWorks.

To rekonstrukcja referencyjna. Film i rendery nie dostarczają kompletu wymiarów. Poza wskazanymi danymi źródłowymi wiele wymiarów, styków, tras wiązek i położeń pozostaje oszacowanych. Nie wykonano pełnej kontroli wszystkich par, tolerancji, mas ani kwalifikacji mechanizmów. Nie jest to dokumentacja produkcyjna lub potwierdzona konfiguracja lotna.

## Regeneracja

Python 3.12, CadQuery 2.7.0, NumPy, Pillow i trimesh 5.2.0. Zależności: `source/requirements.txt`. Renderowanie CPU wymaga kompilatora C++17 (`g++`).

```bash
python source/release.py
python source/finalize_docs.py
```

Regeneruje pliki STEP, warianty AP203, wewnętrzny folder EXPORT, podglądy oraz kontrole. Dla samych GLB: `python source/export_glb.py`.

## Źródła i licencja

- https://www.orcasat.ca/design
- https://www.orcasat.ca/mission
- https://www.orcasat.ca/updates/solar-panels
- https://www.youtube.com/watch?v=5zbTj0-B4_Y — przekazany film montażu analizowany w audycie.
- Przekazane rendery, fotografie PHOTOS(1).zip i oryginalne źródła anteny orcasat-antenna-master.zip.
- Dokument etapu projektu (2020), obwiednia nominalna: https://fenix.tecnico.ulisboa.pt/downloadFile/844820067126344/Resumo_Alargado_Joao_Duarte_81865.pdf

Źródła anteny: Levente Buzas i Tristan Tarnowski, 2023, CERN-OHL-S v2. Zachowano ich źródła i licencję; zobacz `LICENSING.md`. Rekonstrukcja nie jest oficjalnym wydaniem CAD zespołu ORCASat.
''')
    (out/'EXPORT/README_PL.md').write_text(f'''# EXPORT — ORCASat v2.1 / GLB

Kompletny eksport z geometrii STEP v2.1: **{n} samodzielnych plików glTF 2.0 (.glb)** z geometrią, nazwami i kolorami. Bez zewnętrznych tekstur lub plików binarnych.

| Folder | Zawartość |
| --- | --- |
| assemblies/ | {kinds['assembly']} sceny: Stowed, Deployed, Internal i Exploded |
| modules/ | {kinds['module']} scen modułów: dziewięć złożonych oraz rozłożone TT&C i czujniki |
| panels/ | {kinds['panel']} zespołów paneli z ich osprzętem |
| parts/ | {parts} zdefiniowanych komponentów, w tym elementy obu stanów |
| solids/ | {solids} brył, w tym osobno styki i elementy zgrupowane |
| manifest.json | Spis plików, sumy SHA-256, pokrycie części i brył |
| placement_manifest.csv | Położenia osobnych części i brył |
| validation_report.json | Wyniki kontroli każdego GLB i niezależnego odczytu scen |

Komponent `both` występuje w obu stanach; jego osobny plik jest eksportowany raz. Pełne sceny mają już prawidłowe położenia i zestaw elementów.

## Skala i umiejscowienie

Jednostką jest **metr**, +Y wskazuje Ram, +Z Nadir, −X Starboard. Nominalne szyny mają obwiednię 0,100 × 0,100 × 0,227 m. Przeliczenie z osi STEP: `glTF = (−STEP_Y, STEP_X, STEP_Z) / 1000`.

Sceny `assemblies/`, `modules/` i `panels/` mają wspólny początek w środku nominalnej obwiedni szyn. Pliki `parts/` i `solids/` są wycentrowane w środku własnej obwiedni, a nie w środku masy. Przesunięcia `origin_X_m`, `origin_Y_m`, `origin_Z_m` w CSV i `origin_gltf_m` w JSON przywracają umiejscowienie w satelicie. Dla elementu rozłożonego zapisano jego położenie rozłożone.

Exploded pokazuje rozsunięte moduły w stanie Deployed; tylko w tej scenie pominięto wiązki łączące. Są dostępne w innych scenach, w `modules/09_Harness.glb` i jako części/bryły. Nie dodano animacji mechanizmu.

## Zakres

Źródłowa antena rev2 zachowuje nieprzeskalowaną geometrię. Wiele innych wymiarów, tras przewodów i położeń pozostaje oszacowanych z filmu oraz dokumentacji. GLB nie zawiera historii SolidWorks, wiązań, pinoutu ani zweryfikowanych mas. Pliki CAD STEP znajdują się w tym samym pakiecie, jeden folder wyżej.

Zmiany i źródła: `../CHANGELOG_V2_1_PL.md`, `../dimension_sources.csv` oraz `../LICENSING.md`. Oryginalne źródła anteny: CERN-OHL-S v2, Levente Buzas i Tristan Tarnowski, 2023; pełna kopia w `../source_assets/`.
''')
    print('Documentation updated:',n,'GLBs',parts,'parts',solids,'solids')


if __name__=='__main__':main()