orbitoby 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. orbitoby-0.1.0/AI_USAGE.md +23 -0
  2. orbitoby-0.1.0/CONTRIBUTING.md +32 -0
  3. orbitoby-0.1.0/LICENSE +202 -0
  4. orbitoby-0.1.0/NOTICE +15 -0
  5. orbitoby-0.1.0/PKG-INFO +181 -0
  6. orbitoby-0.1.0/README.md +151 -0
  7. orbitoby-0.1.0/SECURITY.md +25 -0
  8. orbitoby-0.1.0/docs/ORBITOBY_ARCHITECTURE_V0.1.0.md +5 -0
  9. orbitoby-0.1.0/docs/ORBITOBY_CURRENT_STATE_AND_CLEANUP.md +5 -0
  10. orbitoby-0.1.0/docs/ORBITOBY_MASTER_PLAN.md +192 -0
  11. orbitoby-0.1.0/docs/ORBITOBY_MASTER_PLAN_RECONCILIATION.md +5 -0
  12. orbitoby-0.1.0/docs/ORBITOBY_SEPTEMBER_RELEASE_PLAN.md +5 -0
  13. orbitoby-0.1.0/docs/ORBITOBY_V0.1.0_CHECKLIST.md +5 -0
  14. orbitoby-0.1.0/docs/ORBITOBY_V0.1.0_READINESS_REVIEW.md +5 -0
  15. orbitoby-0.1.0/docs/RELEASE_0_1_0_REPORT.md +89 -0
  16. orbitoby-0.1.0/docs/adr/2026-10-02-native-svg-plotting.md +29 -0
  17. orbitoby-0.1.0/docs/adr/2026-10-04-release-freeze.md +19 -0
  18. orbitoby-0.1.0/docs/architecture.md +5 -0
  19. orbitoby-0.1.0/docs/assets/orbitoby_banner.png +0 -0
  20. orbitoby-0.1.0/docs/audit/2026-09-28/artifact_path_recovery.json +122 -0
  21. orbitoby-0.1.0/docs/audit/2026-09-28/audit_results.json +87 -0
  22. orbitoby-0.1.0/docs/audit/2026-09-28/cleanup_manifest.json +32 -0
  23. orbitoby-0.1.0/docs/audit/2026-09-28/plan_review_item_status.json +2259 -0
  24. orbitoby-0.1.0/docs/audit/2026-09-28/plan_review_source_matrix.json +187 -0
  25. orbitoby-0.1.0/docs/audit/2026-09-28/plan_review_verification.json +343 -0
  26. orbitoby-0.1.0/docs/audit/2026-09-28/ruff_results.json +556 -0
  27. orbitoby-0.1.0/docs/audit/2026-09-28/source_inventory.json +102 -0
  28. orbitoby-0.1.0/docs/audit/2026-09-28/warehouse_readonly.json +511 -0
  29. orbitoby-0.1.0/docs/catalogue.md +5 -0
  30. orbitoby-0.1.0/docs/handoffs/2026-09-29/01_archive_recovery.py +383 -0
  31. orbitoby-0.1.0/docs/handoffs/2026-09-29/02_ARCHITECTURE_CONTRACTS.md +5 -0
  32. orbitoby-0.1.0/docs/handoffs/2026-09-29/03_CHECKLIST_BATCH.md +5 -0
  33. orbitoby-0.1.0/docs/handoffs/2026-09-29/04_GCAT_FAILURE_DIAGNOSIS.md +9 -0
  34. orbitoby-0.1.0/docs/handoffs/2026-09-29/README.md +26 -0
  35. orbitoby-0.1.0/docs/handoffs/2026-09-29/test_01_archive_recovery.py +161 -0
  36. orbitoby-0.1.0/docs/handoffs/2026-09-30/CHAT_HANDOFF.md +5 -0
  37. orbitoby-0.1.0/docs/index.md +3 -0
  38. orbitoby-0.1.0/docs/installation.md +5 -0
  39. orbitoby-0.1.0/docs/licensing.md +5 -0
  40. orbitoby-0.1.0/docs/models.md +5 -0
  41. orbitoby-0.1.0/docs/plotting.md +5 -0
  42. orbitoby-0.1.0/docs/plugins.md +5 -0
  43. orbitoby-0.1.0/docs/provenance.md +5 -0
  44. orbitoby-0.1.0/docs/quickstart.md +5 -0
  45. orbitoby-0.1.0/docs/release.md +54 -0
  46. orbitoby-0.1.0/docs/timeseries.md +5 -0
  47. orbitoby-0.1.0/docs/wiki/api-inventory.md +232 -0
  48. orbitoby-0.1.0/docs/wiki/catalogue.md +47 -0
  49. orbitoby-0.1.0/docs/wiki/discovery.md +23 -0
  50. orbitoby-0.1.0/docs/wiki/extensions.md +25 -0
  51. orbitoby-0.1.0/docs/wiki/index.md +25 -0
  52. orbitoby-0.1.0/docs/wiki/installation.md +30 -0
  53. orbitoby-0.1.0/docs/wiki/licensing.md +17 -0
  54. orbitoby-0.1.0/docs/wiki/limitations.md +19 -0
  55. orbitoby-0.1.0/docs/wiki/models.md +54 -0
  56. orbitoby-0.1.0/docs/wiki/orbit.md +31 -0
  57. orbitoby-0.1.0/docs/wiki/overview.md +29 -0
  58. orbitoby-0.1.0/docs/wiki/plotting.md +21 -0
  59. orbitoby-0.1.0/docs/wiki/population.md +28 -0
  60. orbitoby-0.1.0/docs/wiki/schema.md +23 -0
  61. orbitoby-0.1.0/docs/wiki/science-day.md +19 -0
  62. orbitoby-0.1.0/docs/wiki/security.md +18 -0
  63. orbitoby-0.1.0/docs/wiki/storage.md +21 -0
  64. orbitoby-0.1.0/docs/wiki/swarm.md +24 -0
  65. orbitoby-0.1.0/docs/wiki/timeseries.md +35 -0
  66. orbitoby-0.1.0/docs/wiki/troubleshooting.md +28 -0
  67. orbitoby-0.1.0/docs/wiki/window.md +22 -0
  68. orbitoby-0.1.0/examples/science_day.py +165 -0
  69. orbitoby-0.1.0/pyproject.toml +58 -0
  70. orbitoby-0.1.0/scripts/check_connections.py +199 -0
  71. orbitoby-0.1.0/scripts/live_e2e_smoke.py +300 -0
  72. orbitoby-0.1.0/src/orbitoby/__init__.py +11 -0
  73. orbitoby-0.1.0/src/orbitoby/archive/__init__.py +0 -0
  74. orbitoby-0.1.0/src/orbitoby/archive/raw.py +94 -0
  75. orbitoby-0.1.0/src/orbitoby/auth.py +320 -0
  76. orbitoby-0.1.0/src/orbitoby/canonical.py +1157 -0
  77. orbitoby-0.1.0/src/orbitoby/catalogue.py +1096 -0
  78. orbitoby-0.1.0/src/orbitoby/cli.py +0 -0
  79. orbitoby-0.1.0/src/orbitoby/config.py +35 -0
  80. orbitoby-0.1.0/src/orbitoby/http.py +315 -0
  81. orbitoby-0.1.0/src/orbitoby/models/__init__.py +11 -0
  82. orbitoby-0.1.0/src/orbitoby/models/msis.py +547 -0
  83. orbitoby-0.1.0/src/orbitoby/plotting.py +563 -0
  84. orbitoby-0.1.0/src/orbitoby/research.py +906 -0
  85. orbitoby-0.1.0/src/orbitoby/service.py +1496 -0
  86. orbitoby-0.1.0/src/orbitoby/settings.py +258 -0
  87. orbitoby-0.1.0/src/orbitoby/source_api.py +816 -0
  88. orbitoby-0.1.0/src/orbitoby/sources/__init__.py +21 -0
  89. orbitoby-0.1.0/src/orbitoby/sources/base.py +122 -0
  90. orbitoby-0.1.0/src/orbitoby/sources/cdaweb.py +33 -0
  91. orbitoby-0.1.0/src/orbitoby/sources/celestrak.py +158 -0
  92. orbitoby-0.1.0/src/orbitoby/sources/declarative.py +225 -0
  93. orbitoby-0.1.0/src/orbitoby/sources/discos.py +249 -0
  94. orbitoby-0.1.0/src/orbitoby/sources/donki.py +315 -0
  95. orbitoby-0.1.0/src/orbitoby/sources/gcat.py +233 -0
  96. orbitoby-0.1.0/src/orbitoby/sources/gfz.py +331 -0
  97. orbitoby-0.1.0/src/orbitoby/sources/hapi.py +496 -0
  98. orbitoby-0.1.0/src/orbitoby/sources/latis.py +385 -0
  99. orbitoby-0.1.0/src/orbitoby/sources/launchlibrary.py +116 -0
  100. orbitoby-0.1.0/src/orbitoby/sources/lisird.py +168 -0
  101. orbitoby-0.1.0/src/orbitoby/sources/metadata.py +857 -0
  102. orbitoby-0.1.0/src/orbitoby/sources/noaa.py +195 -0
  103. orbitoby-0.1.0/src/orbitoby/sources/nrcan.py +638 -0
  104. orbitoby-0.1.0/src/orbitoby/sources/plugins.py +96 -0
  105. orbitoby-0.1.0/src/orbitoby/sources/registry.py +137 -0
  106. orbitoby-0.1.0/src/orbitoby/sources/satnogs.py +151 -0
  107. orbitoby-0.1.0/src/orbitoby/sources/silso.py +262 -0
  108. orbitoby-0.1.0/src/orbitoby/sources/spacetrack.py +256 -0
  109. orbitoby-0.1.0/src/orbitoby/sources/swarm.py +54 -0
  110. orbitoby-0.1.0/src/orbitoby/sources/wdc_kyoto.py +33 -0
  111. orbitoby-0.1.0/src/orbitoby/warehouse/__init__.py +0 -0
  112. orbitoby-0.1.0/src/orbitoby/warehouse/coverage.py +87 -0
  113. orbitoby-0.1.0/src/orbitoby/warehouse/db.py +89 -0
  114. orbitoby-0.1.0/src/orbitoby/warehouse/identity.py +600 -0
  115. orbitoby-0.1.0/src/orbitoby/warehouse/products.py +949 -0
  116. orbitoby-0.1.0/src/orbitoby/warehouse/scientific.py +1543 -0
  117. orbitoby-0.1.0/tests/test_archive_stores.py +55 -0
  118. orbitoby-0.1.0/tests/test_auth.py +116 -0
  119. orbitoby-0.1.0/tests/test_canonical.py +298 -0
  120. orbitoby-0.1.0/tests/test_canonical_semantics.py +78 -0
  121. orbitoby-0.1.0/tests/test_catalogue_discovery.py +176 -0
  122. orbitoby-0.1.0/tests/test_connection_check.py +73 -0
  123. orbitoby-0.1.0/tests/test_coverage.py +80 -0
  124. orbitoby-0.1.0/tests/test_declarative_source.py +89 -0
  125. orbitoby-0.1.0/tests/test_discos.py +222 -0
  126. orbitoby-0.1.0/tests/test_discovery_http_policy.py +93 -0
  127. orbitoby-0.1.0/tests/test_gcat.py +110 -0
  128. orbitoby-0.1.0/tests/test_gfz_silso.py +222 -0
  129. orbitoby-0.1.0/tests/test_hapi.py +340 -0
  130. orbitoby-0.1.0/tests/test_hapi_timeout_policy.py +15 -0
  131. orbitoby-0.1.0/tests/test_http.py +54 -0
  132. orbitoby-0.1.0/tests/test_http_body_retry.py +193 -0
  133. orbitoby-0.1.0/tests/test_identity.py +194 -0
  134. orbitoby-0.1.0/tests/test_identity_routing.py +61 -0
  135. orbitoby-0.1.0/tests/test_latis.py +193 -0
  136. orbitoby-0.1.0/tests/test_live_discovery_performance.py +335 -0
  137. orbitoby-0.1.0/tests/test_msis_archive.py +303 -0
  138. orbitoby-0.1.0/tests/test_msis_forcing.py +276 -0
  139. orbitoby-0.1.0/tests/test_msis_model.py +234 -0
  140. orbitoby-0.1.0/tests/test_noaa_donki.py +253 -0
  141. orbitoby-0.1.0/tests/test_nrcan.py +252 -0
  142. orbitoby-0.1.0/tests/test_orbit_conflicts.py +59 -0
  143. orbitoby-0.1.0/tests/test_orbit_summary.py +387 -0
  144. orbitoby-0.1.0/tests/test_period_population.py +397 -0
  145. orbitoby-0.1.0/tests/test_plotting.py +139 -0
  146. orbitoby-0.1.0/tests/test_plugin_canonical.py +124 -0
  147. orbitoby-0.1.0/tests/test_plugins.py +19 -0
  148. orbitoby-0.1.0/tests/test_product_store.py +445 -0
  149. orbitoby-0.1.0/tests/test_provider_security.py +210 -0
  150. orbitoby-0.1.0/tests/test_registry_extensions.py +45 -0
  151. orbitoby-0.1.0/tests/test_research.py +294 -0
  152. orbitoby-0.1.0/tests/test_research_cache.py +298 -0
  153. orbitoby-0.1.0/tests/test_scientific_store.py +667 -0
  154. orbitoby-0.1.0/tests/test_settings.py +75 -0
  155. orbitoby-0.1.0/tests/test_source_api.py +276 -0
  156. orbitoby-0.1.0/tests/test_source_metadata.py +32 -0
  157. orbitoby-0.1.0/tests/test_swarm.py +171 -0
  158. orbitoby-0.1.0/tests/test_window.py +277 -0
@@ -0,0 +1,23 @@
1
+ # AI 사용 기록 / AI usage record
2
+
3
+ AI 기여, 실제 검증, 사람 검토, 최종 결정을 구별한다. 작업 허용이나 자료 제공은 내용 전체의 사람 검토 완료가 아니다. 정확한 모델 식별자는 기록되지 않았으며 추정하지 않는다. / Distinguish AI contribution, performed validation, human review and final decisions. Task authorization or supplied material is not completed substantive human review. Exact model identifiers were not recorded and are not inferred.
4
+
5
+ | 날짜 / Date | 도구 / Tool | 기여·검증 이력 / Contribution and validation history | 사람 검토 / Human review |
6
+ | --- | --- | --- | --- |
7
+ | 2026-09-28 | Codex | 초기 계획·설계·metadata 검토, 15개 격리 합성 checks, read-only DB/hash, 당시 Ruff 19개와 pytest collection 0개 기록. v2 원문과 0–55절·250 IDs 대조. / Initial plan/design/metadata review, 15 isolated synthetic checks, read-only DB/hashes, historical 19 Ruff findings and zero collected pytest tests; comparison of v2 sections 0–55 and 250 IDs. | 세부 내용 검토 대기 / Substantive review pending |
8
+ | 2026-09-28 후속 / Follow-up | Codex | 당시 9/30 PyPI·DOI 목표와 사용자 실행 방식의 3일 계획 작성, 소스 해시 불변 확인. 현재 일정은 마스터플랜으로 대체. / Drafted the then-current three-day, user-run plan targeting September 30 PyPI/DOI and checked unchanged source hashes. Superseded by the current master plan. | 대기 / Pending |
9
+ | 2026-09-29 | Codex | 복제본 recovery 코드와 합성 tests 제공. 최초에는 AST·source hash만 확인했고 실행하지 않음. 이후 사용자 보고의 5-test/subset 성공을 기록하고 추가 restore rehearsal test 제공. / Supplied copied-archive recovery code and synthetic tests; initially checked only AST/source hashes without execution. Later recorded user-reported five-test/subset success and added restore-rehearsal coverage. | 당시 새 전체 검증은 사용자 실행 대기였음 / New full validation was pending user execution at that time |
10
+ | 2026-09-30 | Codex | 공개 repo 원칙 반영, 선택된 파일/history token 패턴 읽기 전용 점검. GCAT 복제본 OOM 진단. 제품 게시·전수 보안 인증은 하지 않음. / Reflected public-repository policy, read-only selected file/history token scans and GCAT copied-archive OOM diagnosis. No publication or comprehensive security certification. | 대기 / Pending |
11
+ | 2026-10-03 출시 검사 / Release audit | Codex | README·배너·문서·TODO, API 확인, 전체 249 tests, 6 fresh-wheel environments, strict Twine 및 metadata/내용 검사. recovery helper timezone digest 최소 수정과 회귀 test; package 기능·성능은 변경하지 않음. / README/banner/docs/TODO, API review, 249 full tests, six fresh-wheel environments, strict Twine and metadata/content checks; minimum recovery-helper timezone-digest fix and regression test, without package feature/performance changes. | 사용자 최종 검토·업로드 승인 대기 / Final user review and upload approval pending |
12
+ | 2026-10-03 문서 통합 / Documentation consolidation | Codex | 메인 1·2의 제공 대화와 기존 계획을 대조, 한/영 문서·250-ID 추적·통합 master 작성. 원본 백업 및 코드 freeze 해시 확인. 문서 변경 후 artifact 재검증 결과는 release report에 기록. / Compared available Main 1/2 conversation content and existing plans; authored bilingual docs, 250-ID traceability and consolidated master. Preserved original backups and checked code-freeze hashes. Post-edit artifact verification is recorded in the release report. | 내용 검토 대기 / Substantive review pending |
13
+
14
+ 역사적 검증 수와 현재 테스트 수는 다른 snapshot이다. 과거 기록을 이번에 다시 수행했다고 주장하지 않는다. 기존 기여 전체를 감사한 기록이나 저널 정책 준수 인증이 아니다. / Historical and current test counts refer to different snapshots. Earlier checks are not claimed as newly rerun. This is neither a complete audit of earlier contributions nor journal-policy certification.
15
+
16
+ ## 기록 원칙 / Recording rules
17
+
18
+ - 수행하지 않은 검증·사람 검토를 완료 처리하지 않는다. 최종 결정자는 사용자다. / Never mark unperformed validation or human review complete. The user makes final decisions.
19
+ - 주요 설계 근거는 ADR, 현재 계획은 통합 master, 실행 증거는 release report에 둔다. / Keep design rationale in ADRs, current plans in the master and execution evidence in the release report.
20
+ - 비밀값·계정정보·제한 자료는 기록하지 않는다. / Do not record secrets, account information or restricted data.
21
+ - 외부 투고 시 최신 disclosure 정책을 확인한다. 원래 기록은 문서 백업에 보존한다. / Recheck disclosure policies at submission; preserve original records in the documentation backup.
22
+
23
+ [마스터플랜 / Master plan](docs/ORBITOBY_MASTER_PLAN.md) · [릴리스 보고서 / Release report](docs/RELEASE_0_1_0_REPORT.md)
@@ -0,0 +1,32 @@
1
+ # 기여 안내 / Contributing
2
+
3
+ Orbitoby는 공개 연구 소프트웨어입니다. 현재 0.1.0 기능·성능 코드는 freeze 상태이며 확인된 오류의 최소 수정만 검증 후 반영합니다. 이후 기능은 [통합 계획](docs/ORBITOBY_MASTER_PLAN.md#roadmap)에 기록합니다.
4
+
5
+ Orbitoby is public research software. Feature and performance code is frozen for 0.1.0; only minimal, verified defect corrections belong in the candidate. Record later features in the [consolidated plan](docs/ORBITOBY_MASTER_PLAN.md#roadmap).
6
+
7
+ ## 개발 환경과 확인 / Development and checks
8
+
9
+ ```bash
10
+ uv sync
11
+ .venv/bin/ruff check --no-cache .
12
+ .venv/bin/ruff format --check --no-cache .
13
+ PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 PYTHONDONTWRITEBYTECODE=1 \
14
+ .venv/bin/python -B -W error -m pytest -q -p no:cacheprovider
15
+ ```
16
+
17
+ 전체 검사와 배포 확인은 [release.md](docs/release.md)를 따릅니다. 로컬 handoff 테스트가 없는 checkout은 이전 전체 249개보다 적게 수집될 수 있습니다. 숫자만 맞추려고 테스트를 추가·제외하지 않습니다.
18
+
19
+ Follow [release.md](docs/release.md) for complete verification. A checkout without local handoff tests may collect fewer than the previously reported 249 total. Do not add or exclude tests merely to match a count.
20
+
21
+
22
+ - 핵심 설계·과학적 판단의 최종 결정자는 사람입니다. / Humans make final architectural and scientific decisions.
23
+ - AI 보조 변경도 실제 검증과 사람 검토를 구별해 기록합니다. / Record actual validation and human review separately for AI-assisted changes.
24
+ - 기존 API·연구 데이터를 보호하고 migration은 복제본에서 검증합니다. / Protect existing APIs/data and validate migrations on copies.
25
+ - 새 source는 출처·권리·인증·필드/단위·fixture·제한된 live 증거를 갖춰야 합니다. / New sources require provenance, rights, auth, field/unit, fixture, and bounded live evidence.
26
+ - 비밀값·사용자 raw/DB를 commit하지 않습니다. / Never commit secrets or user raw/DB files.
27
+ - 문서는 한·영 병기하며 ADR에는 주요 선택 이유를 남깁니다. / Keep docs bilingual and record major design rationale in ADRs.
28
+ - commit 유형 / commit types: `feat`, `fix`, `test`, `docs`, `refactor`, `chore`.
29
+
30
+ 0.1.x의 공개 API·저장 형식을 v1.0 안정성 약속으로 해석하지 않습니다. 존재하지 않는 CLI나 계획 API를 문서 예제로 추가하지 마세요.
31
+
32
+ Do not treat 0.1.x APIs/storage as a v1.0 stability promise. Do not document nonexistent CLI commands or planned APIs as executable examples.
orbitoby-0.1.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
orbitoby-0.1.0/NOTICE ADDED
@@ -0,0 +1,15 @@
1
+ Orbitoby
2
+ Copyright 2026 Jin Yeseo (진예서)
3
+
4
+ Orbitoby 소프트웨어는 Apache License 2.0으로 배포됩니다.
5
+ The Orbitoby software is licensed under the Apache License 2.0.
6
+
7
+ 외부 과학 데이터는 원래 라이선스, 출처 표기 의무 및 재배포 제한을 유지합니다.
8
+ Third-party scientific datasets retain their original licenses,
9
+ attribution requirements, and redistribution restrictions.
10
+
11
+ Toby 마스코트, 사진 및 원본 브랜드 자산은 별도 표시가 없는 한
12
+ Copyright 2026 Jin Yeseo (진예서), All Rights Reserved입니다.
13
+ The Toby mascot, photographs, and original brand artwork are
14
+ Copyright 2026 Jin Yeseo (진예서), All Rights Reserved,
15
+ unless separately indicated.
@@ -0,0 +1,181 @@
1
+ Metadata-Version: 2.4
2
+ Name: orbitoby
3
+ Version: 0.1.0
4
+ Summary: A provenance-first research toolkit for space-weather and orbital time-series data.
5
+ Keywords: astronomy,space-weather,space-environment,satellite,timeseries,provenance
6
+ Author: Jin Yeseo
7
+ Author-email: Jin Yeseo <jinyeseo.public@gmail.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ License-File: NOTICE
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Topic :: Scientific/Engineering :: Astronomy
14
+ Classifier: Topic :: Scientific/Engineering :: Physics
15
+ Classifier: Programming Language :: Python :: 3 :: Only
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Requires-Dist: duckdb>=1.5.5
18
+ Requires-Dist: pandas>=3.0.6
19
+ Requires-Dist: pyarrow>=25.0.1
20
+ Requires-Dist: python-dotenv>=1.2.3
21
+ Requires-Dist: pytz>=2026.4
22
+ Requires-Dist: requests>=2.34.2
23
+ Requires-Dist: pymsis>=0.13,<0.14 ; extra == 'models'
24
+ Requires-Python: >=3.12
25
+ Project-URL: Homepage, https://github.com/JIN-ARTLW/Orbitoby
26
+ Project-URL: Repository, https://github.com/JIN-ARTLW/Orbitoby
27
+ Project-URL: Issues, https://github.com/JIN-ARTLW/Orbitoby/issues
28
+ Provides-Extra: models
29
+ Description-Content-Type: text/markdown
30
+
31
+ # Orbitoby
32
+
33
+ **Orbitoby core never guesses the data.**
34
+
35
+ Orbitoby는 우주환경·위성 궤도 연구를 위한 provenance-first Python 패키지입니다. 원본 수집, canonical 시계열, exact-time 정렬, catalogue·historical orbit, Swarm 밀도 및 명시적 NRLMSIS 계산을 연결합니다. v0.1.0은 alpha release candidate입니다.
36
+
37
+ Orbitoby is a provenance-first Python toolkit for space-weather and orbital research. It connects raw acquisition, canonical time series, exact-time alignment, catalogues, historical orbit, Swarm density and explicit NRLMSIS evaluation. Version 0.1.0 is an alpha release candidate.
38
+
39
+ ## 설치 / Installation
40
+
41
+ Python ≥3.12. 공개 전에는 검증한 로컬 wheel을 설치합니다. 다음 index 명령은 공개된 배포본을 위한 사용법입니다.
42
+
43
+ Use Python ≥3.12. Before publication, install the verified local wheel; index commands below are instructions for a published distribution.
44
+
45
+ ```bash
46
+ python -m pip install orbitoby
47
+ python -m pip install "orbitoby[models]"
48
+ # 공개 전 로컬 설치 / local installation before publication
49
+ python -m pip install "dist/orbitoby-0.1.0-py3-none-any.whl[models]"
50
+ ```
51
+
52
+ `[models]`는 pymsis를 추가합니다. 기본 탐색·시계열·저장·SVG 플롯에는 필요하지 않습니다. 설치형 CLI entry point는 제공하지 않습니다.
53
+
54
+ The models extra adds pymsis; base discovery, time series, storage and SVG plotting do not require it. No installed CLI entry point is provided.
55
+
56
+ ## Archive 빠른 시작 / Quick start
57
+
58
+ ```python
59
+ from orbitoby import Archive
60
+
61
+ with Archive() as archive:
62
+ print(archive.sources_available())
63
+ print(archive.datasets(metric="kp", live=False))
64
+ info = archive.dataset_info("gfz", "kp")
65
+ kp = archive.timeseries(
66
+ "kp", source="gfz", dataset="kp", start="2024-05-10", end="2024-05-11"
67
+ )
68
+ archive.plot(kp, kind="scatter", title="GFZ Kp").save("kp.svg")
69
+ window = archive.window(
70
+ fields=["kp", "ap"], source="gfz", start="2024-05-10", end="2024-05-11"
71
+ )
72
+ print(window.data, window.presence)
73
+ ```
74
+
75
+ `datasets()`·`dataset_info()`는 정적 또는 명시적 `live=True` 탐색을 지원합니다. provider-native 자료는 `fetch()`로, 지원된 canonical metric은 `timeseries()` 또는 `space_weather()`로 조회합니다. 모든 provider-native dataset에 canonical mapping이 있는 것은 아닙니다.
76
+
77
+ Discovery is static unless live lookup is requested. Use fetch() for provider-native data and timeseries()/space_weather() for supported canonical metrics. Native dataset support does not imply canonical mapping.
78
+
79
+ ## 과학적 의미 / Scientific semantics
80
+
81
+ Canonical 조회와 window는 UTC `[start,end)`입니다. ResearchWindow는 실제 timestamp의 합집합에 exact 정렬하고 `data`, `presence`, `missing_reason`, `provenance`, `units`를 반환합니다. 중복 metric/timestamp는 오류이며 결측값을 보간·평활·resample·ffill·bfill하지 않습니다. 플롯은 line/scatter SVG와 원 데이터·provenance를 반환합니다.
82
+
83
+ Canonical queries/windows use UTC [start,end). ResearchWindow aligns the union of actual timestamps and retains values, presence, missing reasons, provenance and units. Duplicate claims raise errors. There is no interpolation, smoothing, resampling or filling. Native plotting returns line/scatter SVG, data and provenance.
84
+
85
+ source가 모호하면 명시해야 합니다. `source_preference`는 첫 matching binding을 선택하며 장애 시 다른 source로 자동 fallback하지 않습니다. 기본 `artifact_resolution="all"`은 중복 주장을 보존합니다. 명시적 `preferred`는 우선순위 선택일 뿐 과학적 충돌 해결이 아닙니다. NRCan의 선언된 같은-source mergeable 제품은 함께 반환될 수 있습니다.
86
+
87
+ Ambiguous sources require selection. Source preference selects the first matching binding, not runtime outage fallback. Default artifact resolution preserves claims; explicitly requested preferred selection is a priority policy, not scientific adjudication. Declared mergeable products within NRCan can be returned together.
88
+
89
+ ## Population과 historical orbit / Population and orbit
90
+
91
+ ```python
92
+ with Archive(allow_dotenv=True) as archive:
93
+ candidates = archive.objects(
94
+ start="2024-05-10",
95
+ end="2024-05-11",
96
+ existence="throughout",
97
+ object_type="payload",
98
+ sync=True,
99
+ )
100
+ orbit = archive.orbit(norad_id=39452, start="2024-05-10", end="2024-05-11")
101
+ summary = archive.orbit_summary(
102
+ [39452],
103
+ start="2024-05-10",
104
+ end="2024-05-11",
105
+ periapsis_km=(200, 2000),
106
+ min_coverage=1.0,
107
+ sync=False,
108
+ )
109
+ ```
110
+
111
+ 기간 population은 전체 CelesTrak SATCAT의 launch/decay assertion으로 조회합니다. 기본 객체 검색은 로컬이며 `sync=True`로 SATCAT을 갱신합니다. historical orbit은 사용자 credential이 필요한 Space-Track GP_HISTORY이고 날짜 `[start,end)`입니다. 요약 coverage는 실제 레코드가 존재하는 날짜 비율이며 연속 관측을 뜻하지 않습니다.
112
+
113
+ Period population applies launch/decay assertions from complete CelesTrak SATCAT. Default object searches are local; sync=True refreshes SATCAT. Historical orbit uses authenticated Space-Track GP_HISTORY with date-based [start,end). Summary coverage is the fraction of dates with records, not continuous observation.
114
+
115
+ ## Swarm와 MSIS / Swarm and MSIS
116
+
117
+ Swarm A/B/C ACC·POD는 관측 기반 provider-derived 밀도이고 NRLMSIS 2.1은 별도 model_output입니다. trajectory는 UTC timestamp·경도/위도 degree·고도 km와 실제 provenance를 제공해야 합니다.
118
+
119
+ Swarm A/B/C ACC/POD are observation-derived provider products; NRLMSIS 2.1 is separate model output. Supply trajectory UTC timestamps, longitude/latitude in degrees, altitude in kilometres and real provenance.
120
+
121
+ ```python
122
+ # trajectory와 trajectory_parents 구성은 실행 예제를 참고하세요.
123
+ # See the runnable example for trajectory and real parent construction.
124
+ inputs, parents = archive.msis_inputs(
125
+ trajectory, driver_source="gfz", trajectory_parents=trajectory_parents
126
+ )
127
+ modeled = archive.msis_density(inputs, parents=parents)
128
+ comparison = observed.merge(
129
+ modeled,
130
+ on="timestamp",
131
+ how="outer",
132
+ suffixes=("_observed", "_model"),
133
+ validate="one_to_one",
134
+ indicator=True,
135
+ )
136
+ ```
137
+
138
+ `msis_inputs()`는 명시적으로 GFZ를 선택해 이전 일 F10.7, 완전한 중심 81일 평균, 지정 Ap vector를 구성합니다. 필수 day/bin 누락과 중복 유효 forcing은 오류입니다. 모델 정의 평균은 관측 보간이 아니며 중심 평균은 미래 정보를 사용합니다. 모델 output은 backend/version·parameters·parent lineage를 저장합니다.
139
+
140
+ Explicit GFZ forcing construction requires the previous-day F10.7, complete centered 81-day mean and defined Ap vector. Missing bins/days and duplicate valid drivers fail. Model-defined means are not observation interpolation; centered means use future information. Model output records versions, parameters and parent lineage.
141
+
142
+ ## 저장·확장 / Storage and extensions
143
+
144
+ 기본 저장소는 `~/.orbitoby`; import 전 `ORBITOBY_DATA_DIR`로 변경합니다. raw payload/manifest/SHA-256, DuckDB metadata, canonical Parquet와 derived/model Parquet를 분리하고 artifact·lineage로 연결합니다. `artifacts()`, `coverage()`, `product_store.lineage()`로 조사합니다.
145
+
146
+ The default archive is ~/.orbitoby, overridable before import. Raw payloads/manifests/hashes, DuckDB metadata and canonical/derived/model Parquet are separate and linked by artifact IDs and lineage.
147
+
148
+ HTTPS JSON/CSV/TSV declarative source를 등록하거나 명시적으로 신뢰한 `orbitoby.sources` Python plugin을 확장할 수 있습니다. canonical binding은 명시적으로 정의해야 하며 plugin은 사용자 권한으로 실행됩니다. credential은 runtime/keyring/environment/Colab/opt-in dotenv에서 해석하고 import만으로 .env를 로드하지 않습니다.
149
+
150
+ Extensions include declarative HTTPS JSON/CSV/TSV and explicitly trusted Python source plugins. Canonical bindings must be explicit; plugins run with user permissions. Credential resolution supports runtime/keyring/environment/Colab/opt-in dotenv without implicit .env loading on import.
151
+
152
+ ## 실행 예제와 연결 검사 / Workflow and connection check
153
+
154
+ 저장소 root에서 순차 실행하세요. 예제는 전체 population→명시적 1개 위성의 historical orbit→F10.7/Kp/Ap/Dst/solar wind→Swarm→MSIS→exact 비교를 시연합니다. 실패 단계는 분리해서 보고합니다.
155
+
156
+ Run sequentially from the repository root. The example demonstrates complete population, one explicitly selected historical orbit, weather indices, Swarm, MSIS and exact comparison, reporting stage failures separately.
157
+
158
+ ```bash
159
+ .venv/bin/python examples/science_day.py --allow-dotenv
160
+ .venv/bin/python scripts/check_connections.py --allow-dotenv
161
+ ```
162
+
163
+ 연결 검사는 source 수·API·DB/storage와 주요 provider를 PASS/FAIL/SKIP으로 표시하며 secrets를 출력하지 않습니다. credential 미설정은 SKIP, FAIL이 있으면 exit 1입니다. `--offline`, `--timeout 20`도 지원합니다. 연결 성공은 자료 전체의 완전성 인증이 아닙니다.
164
+
165
+ Diagnostics report registry, APIs, local storage and key providers without secrets. Missing credentials are SKIP; any FAIL exits 1. Offline mode and per-worker timeout are available. Connectivity does not certify scientific completeness.
166
+
167
+ ## 제약·문서·인용 / Limits, documentation and citation
168
+
169
+ 현재 snapshot의 과거 존재 판정은 당시 catalogue 복원이 아닙니다. 결측 물리/임무 metadata, quality flag, provider revision, GP ID 중복, cache freshness를 사용자가 검토해야 합니다. orbit propagation·항력/인과적 decay·자동 cohort·범용 CLI는 제공하지 않습니다. E2E 성공과 과학적 타당성 검증은 구별합니다.
170
+
171
+ Retrospective existence from a current snapshot is not a historical catalogue reconstruction. Researchers must assess missing metadata, quality, revisions, GP-ID deduplication and cache freshness. Propagation, drag/causal decay, automatic cohorts and a general CLI are outside this release. E2E success is distinct from scientific validation.
172
+
173
+ - [한·영 위키 / Bilingual wiki](docs/wiki/index.md)
174
+ - [전체 공개 API와 dataset / Complete inventory](docs/wiki/api-inventory.md)
175
+ - [연구 예제 코드 / Research example](examples/science_day.py)
176
+ - [검증 보고서 / Verification report](docs/RELEASE_0_1_0_REPORT.md)
177
+ - [기능 동결 / Feature freeze](docs/adr/2026-10-04-release-freeze.md)
178
+
179
+ 소프트웨어 인용: Jin Yeseo, Orbitoby, 사용 버전과 [저장소](https://github.com/JIN-ARTLW/Orbitoby). dataset·model 문헌은 별도로 인용하세요. 확인되지 않은 DOI는 제시하지 않습니다. 코드 라이선스는 [Apache-2.0](LICENSE), 자산·외부 자료 구분은 [NOTICE](NOTICE)를 따릅니다.
180
+
181
+ Cite Jin Yeseo, Orbitoby, the version used and the repository, plus original datasets and models. No unverified DOI is supplied. Code is Apache-2.0; NOTICE distinguishes assets and external materials.
@@ -0,0 +1,151 @@
1
+ # Orbitoby
2
+
3
+ **Orbitoby core never guesses the data.**
4
+
5
+ Orbitoby는 우주환경·위성 궤도 연구를 위한 provenance-first Python 패키지입니다. 원본 수집, canonical 시계열, exact-time 정렬, catalogue·historical orbit, Swarm 밀도 및 명시적 NRLMSIS 계산을 연결합니다. v0.1.0은 alpha release candidate입니다.
6
+
7
+ Orbitoby is a provenance-first Python toolkit for space-weather and orbital research. It connects raw acquisition, canonical time series, exact-time alignment, catalogues, historical orbit, Swarm density and explicit NRLMSIS evaluation. Version 0.1.0 is an alpha release candidate.
8
+
9
+ ## 설치 / Installation
10
+
11
+ Python ≥3.12. 공개 전에는 검증한 로컬 wheel을 설치합니다. 다음 index 명령은 공개된 배포본을 위한 사용법입니다.
12
+
13
+ Use Python ≥3.12. Before publication, install the verified local wheel; index commands below are instructions for a published distribution.
14
+
15
+ ```bash
16
+ python -m pip install orbitoby
17
+ python -m pip install "orbitoby[models]"
18
+ # 공개 전 로컬 설치 / local installation before publication
19
+ python -m pip install "dist/orbitoby-0.1.0-py3-none-any.whl[models]"
20
+ ```
21
+
22
+ `[models]`는 pymsis를 추가합니다. 기본 탐색·시계열·저장·SVG 플롯에는 필요하지 않습니다. 설치형 CLI entry point는 제공하지 않습니다.
23
+
24
+ The models extra adds pymsis; base discovery, time series, storage and SVG plotting do not require it. No installed CLI entry point is provided.
25
+
26
+ ## Archive 빠른 시작 / Quick start
27
+
28
+ ```python
29
+ from orbitoby import Archive
30
+
31
+ with Archive() as archive:
32
+ print(archive.sources_available())
33
+ print(archive.datasets(metric="kp", live=False))
34
+ info = archive.dataset_info("gfz", "kp")
35
+ kp = archive.timeseries(
36
+ "kp", source="gfz", dataset="kp", start="2024-05-10", end="2024-05-11"
37
+ )
38
+ archive.plot(kp, kind="scatter", title="GFZ Kp").save("kp.svg")
39
+ window = archive.window(
40
+ fields=["kp", "ap"], source="gfz", start="2024-05-10", end="2024-05-11"
41
+ )
42
+ print(window.data, window.presence)
43
+ ```
44
+
45
+ `datasets()`·`dataset_info()`는 정적 또는 명시적 `live=True` 탐색을 지원합니다. provider-native 자료는 `fetch()`로, 지원된 canonical metric은 `timeseries()` 또는 `space_weather()`로 조회합니다. 모든 provider-native dataset에 canonical mapping이 있는 것은 아닙니다.
46
+
47
+ Discovery is static unless live lookup is requested. Use fetch() for provider-native data and timeseries()/space_weather() for supported canonical metrics. Native dataset support does not imply canonical mapping.
48
+
49
+ ## 과학적 의미 / Scientific semantics
50
+
51
+ Canonical 조회와 window는 UTC `[start,end)`입니다. ResearchWindow는 실제 timestamp의 합집합에 exact 정렬하고 `data`, `presence`, `missing_reason`, `provenance`, `units`를 반환합니다. 중복 metric/timestamp는 오류이며 결측값을 보간·평활·resample·ffill·bfill하지 않습니다. 플롯은 line/scatter SVG와 원 데이터·provenance를 반환합니다.
52
+
53
+ Canonical queries/windows use UTC [start,end). ResearchWindow aligns the union of actual timestamps and retains values, presence, missing reasons, provenance and units. Duplicate claims raise errors. There is no interpolation, smoothing, resampling or filling. Native plotting returns line/scatter SVG, data and provenance.
54
+
55
+ source가 모호하면 명시해야 합니다. `source_preference`는 첫 matching binding을 선택하며 장애 시 다른 source로 자동 fallback하지 않습니다. 기본 `artifact_resolution="all"`은 중복 주장을 보존합니다. 명시적 `preferred`는 우선순위 선택일 뿐 과학적 충돌 해결이 아닙니다. NRCan의 선언된 같은-source mergeable 제품은 함께 반환될 수 있습니다.
56
+
57
+ Ambiguous sources require selection. Source preference selects the first matching binding, not runtime outage fallback. Default artifact resolution preserves claims; explicitly requested preferred selection is a priority policy, not scientific adjudication. Declared mergeable products within NRCan can be returned together.
58
+
59
+ ## Population과 historical orbit / Population and orbit
60
+
61
+ ```python
62
+ with Archive(allow_dotenv=True) as archive:
63
+ candidates = archive.objects(
64
+ start="2024-05-10",
65
+ end="2024-05-11",
66
+ existence="throughout",
67
+ object_type="payload",
68
+ sync=True,
69
+ )
70
+ orbit = archive.orbit(norad_id=39452, start="2024-05-10", end="2024-05-11")
71
+ summary = archive.orbit_summary(
72
+ [39452],
73
+ start="2024-05-10",
74
+ end="2024-05-11",
75
+ periapsis_km=(200, 2000),
76
+ min_coverage=1.0,
77
+ sync=False,
78
+ )
79
+ ```
80
+
81
+ 기간 population은 전체 CelesTrak SATCAT의 launch/decay assertion으로 조회합니다. 기본 객체 검색은 로컬이며 `sync=True`로 SATCAT을 갱신합니다. historical orbit은 사용자 credential이 필요한 Space-Track GP_HISTORY이고 날짜 `[start,end)`입니다. 요약 coverage는 실제 레코드가 존재하는 날짜 비율이며 연속 관측을 뜻하지 않습니다.
82
+
83
+ Period population applies launch/decay assertions from complete CelesTrak SATCAT. Default object searches are local; sync=True refreshes SATCAT. Historical orbit uses authenticated Space-Track GP_HISTORY with date-based [start,end). Summary coverage is the fraction of dates with records, not continuous observation.
84
+
85
+ ## Swarm와 MSIS / Swarm and MSIS
86
+
87
+ Swarm A/B/C ACC·POD는 관측 기반 provider-derived 밀도이고 NRLMSIS 2.1은 별도 model_output입니다. trajectory는 UTC timestamp·경도/위도 degree·고도 km와 실제 provenance를 제공해야 합니다.
88
+
89
+ Swarm A/B/C ACC/POD are observation-derived provider products; NRLMSIS 2.1 is separate model output. Supply trajectory UTC timestamps, longitude/latitude in degrees, altitude in kilometres and real provenance.
90
+
91
+ ```python
92
+ # trajectory와 trajectory_parents 구성은 실행 예제를 참고하세요.
93
+ # See the runnable example for trajectory and real parent construction.
94
+ inputs, parents = archive.msis_inputs(
95
+ trajectory, driver_source="gfz", trajectory_parents=trajectory_parents
96
+ )
97
+ modeled = archive.msis_density(inputs, parents=parents)
98
+ comparison = observed.merge(
99
+ modeled,
100
+ on="timestamp",
101
+ how="outer",
102
+ suffixes=("_observed", "_model"),
103
+ validate="one_to_one",
104
+ indicator=True,
105
+ )
106
+ ```
107
+
108
+ `msis_inputs()`는 명시적으로 GFZ를 선택해 이전 일 F10.7, 완전한 중심 81일 평균, 지정 Ap vector를 구성합니다. 필수 day/bin 누락과 중복 유효 forcing은 오류입니다. 모델 정의 평균은 관측 보간이 아니며 중심 평균은 미래 정보를 사용합니다. 모델 output은 backend/version·parameters·parent lineage를 저장합니다.
109
+
110
+ Explicit GFZ forcing construction requires the previous-day F10.7, complete centered 81-day mean and defined Ap vector. Missing bins/days and duplicate valid drivers fail. Model-defined means are not observation interpolation; centered means use future information. Model output records versions, parameters and parent lineage.
111
+
112
+ ## 저장·확장 / Storage and extensions
113
+
114
+ 기본 저장소는 `~/.orbitoby`; import 전 `ORBITOBY_DATA_DIR`로 변경합니다. raw payload/manifest/SHA-256, DuckDB metadata, canonical Parquet와 derived/model Parquet를 분리하고 artifact·lineage로 연결합니다. `artifacts()`, `coverage()`, `product_store.lineage()`로 조사합니다.
115
+
116
+ The default archive is ~/.orbitoby, overridable before import. Raw payloads/manifests/hashes, DuckDB metadata and canonical/derived/model Parquet are separate and linked by artifact IDs and lineage.
117
+
118
+ HTTPS JSON/CSV/TSV declarative source를 등록하거나 명시적으로 신뢰한 `orbitoby.sources` Python plugin을 확장할 수 있습니다. canonical binding은 명시적으로 정의해야 하며 plugin은 사용자 권한으로 실행됩니다. credential은 runtime/keyring/environment/Colab/opt-in dotenv에서 해석하고 import만으로 .env를 로드하지 않습니다.
119
+
120
+ Extensions include declarative HTTPS JSON/CSV/TSV and explicitly trusted Python source plugins. Canonical bindings must be explicit; plugins run with user permissions. Credential resolution supports runtime/keyring/environment/Colab/opt-in dotenv without implicit .env loading on import.
121
+
122
+ ## 실행 예제와 연결 검사 / Workflow and connection check
123
+
124
+ 저장소 root에서 순차 실행하세요. 예제는 전체 population→명시적 1개 위성의 historical orbit→F10.7/Kp/Ap/Dst/solar wind→Swarm→MSIS→exact 비교를 시연합니다. 실패 단계는 분리해서 보고합니다.
125
+
126
+ Run sequentially from the repository root. The example demonstrates complete population, one explicitly selected historical orbit, weather indices, Swarm, MSIS and exact comparison, reporting stage failures separately.
127
+
128
+ ```bash
129
+ .venv/bin/python examples/science_day.py --allow-dotenv
130
+ .venv/bin/python scripts/check_connections.py --allow-dotenv
131
+ ```
132
+
133
+ 연결 검사는 source 수·API·DB/storage와 주요 provider를 PASS/FAIL/SKIP으로 표시하며 secrets를 출력하지 않습니다. credential 미설정은 SKIP, FAIL이 있으면 exit 1입니다. `--offline`, `--timeout 20`도 지원합니다. 연결 성공은 자료 전체의 완전성 인증이 아닙니다.
134
+
135
+ Diagnostics report registry, APIs, local storage and key providers without secrets. Missing credentials are SKIP; any FAIL exits 1. Offline mode and per-worker timeout are available. Connectivity does not certify scientific completeness.
136
+
137
+ ## 제약·문서·인용 / Limits, documentation and citation
138
+
139
+ 현재 snapshot의 과거 존재 판정은 당시 catalogue 복원이 아닙니다. 결측 물리/임무 metadata, quality flag, provider revision, GP ID 중복, cache freshness를 사용자가 검토해야 합니다. orbit propagation·항력/인과적 decay·자동 cohort·범용 CLI는 제공하지 않습니다. E2E 성공과 과학적 타당성 검증은 구별합니다.
140
+
141
+ Retrospective existence from a current snapshot is not a historical catalogue reconstruction. Researchers must assess missing metadata, quality, revisions, GP-ID deduplication and cache freshness. Propagation, drag/causal decay, automatic cohorts and a general CLI are outside this release. E2E success is distinct from scientific validation.
142
+
143
+ - [한·영 위키 / Bilingual wiki](docs/wiki/index.md)
144
+ - [전체 공개 API와 dataset / Complete inventory](docs/wiki/api-inventory.md)
145
+ - [연구 예제 코드 / Research example](examples/science_day.py)
146
+ - [검증 보고서 / Verification report](docs/RELEASE_0_1_0_REPORT.md)
147
+ - [기능 동결 / Feature freeze](docs/adr/2026-10-04-release-freeze.md)
148
+
149
+ 소프트웨어 인용: Jin Yeseo, Orbitoby, 사용 버전과 [저장소](https://github.com/JIN-ARTLW/Orbitoby). dataset·model 문헌은 별도로 인용하세요. 확인되지 않은 DOI는 제시하지 않습니다. 코드 라이선스는 [Apache-2.0](LICENSE), 자산·외부 자료 구분은 [NOTICE](NOTICE)를 따릅니다.
150
+
151
+ Cite Jin Yeseo, Orbitoby, the version used and the repository, plus original datasets and models. No unverified DOI is supplied. Code is Apache-2.0; NOTICE distinguishes assets and external materials.
@@ -0,0 +1,25 @@
1
+ # 보안 정책 / Security policy
2
+
3
+ 현재 0.1.0 릴리스 후보를 준비 중입니다. 독립 보안 인증이나 모든 버전의 보안 지원을 주장하지 않습니다. 발견된 문제는 재현 증거와 영향 범위로 평가합니다.
4
+
5
+ A 0.1.0 release candidate is being prepared. This is not independent security certification or a promise of security support for every version. Evaluate findings using reproducible evidence and impact.
6
+
7
+ ## 비밀정보와 확장 / Secrets and extensions
8
+
9
+ 사용자는 자신의 provider 계정을 사용합니다. `.env`, API key, password, token, 인증 쿠키와 비공개 archive를 공개하지 마세요. URL·manifest·notebook 출력에도 비밀을 넣지 않습니다.
10
+
11
+ Users supply their own provider credentials. Do not publish `.env`, API keys, passwords, tokens, authentication cookies, or private archives. Keep secrets out of URLs, manifests, and notebook output.
12
+
13
+ Python plugin의 명시적 trust는 sandbox가 아닙니다. 설치·업데이트할 코드를 검토하세요. `settings.json`의 `0600`은 다른 파일까지 보호한다는 뜻이 아닙니다.
14
+
15
+ Explicit trust of a Python plugin is not a sandbox. Review code before installation or updates. Mode `0600` on `settings.json` does not protect every other file.
16
+
17
+ ## 취약점 제보 / Vulnerability reports
18
+
19
+ 민감한 내용이나 악용 절차를 공개 Issue에 올리지 말고 관리자에게 비공개로 제보하세요. 저장소는 [JIN-ARTLW/Orbitoby](https://github.com/JIN-ARTLW/Orbitoby)입니다. 비공개 신고 기능의 활성화 여부는 이 문서에서 확인했다고 주장하지 않습니다.
20
+
21
+ Report sensitive details or exploit instructions privately to the maintainer rather than in a public issue. The repository is [JIN-ARTLW/Orbitoby](https://github.com/JIN-ARTLW/Orbitoby). This document does not claim that a particular private-reporting feature has been enabled.
22
+
23
+ 최소 재현, 영향 버전, 환경, 예상/실제 동작을 비밀값 없이 전달하세요. 실제 토큰이나 전체 사용자 DB를 첨부하지 않습니다.
24
+
25
+ Provide a minimal reproduction, affected version, environment, and expected/actual behavior without secrets. Do not attach real tokens or a complete user database.