sopran 0.0.0__tar.gz

sopran-0.0.0/.gitignore

@@ -0,0 +1,22 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+site/
+.mypy_cache/
+.ruff_cache/
+.vscode/
+
+.venv/
+.venvs/
+build/
+dist/
+*.egg-info/
+
+data/
+datasets/
+sopran_data/
+sopran_cache/
+cache/
+outputs/
+working/
+_handoff/

sopran-0.0.0/AGENTS.md

@@ -0,0 +1,92 @@
+# SOPRAN Agent Guide
+
+このリポジトリは `SOPRAN` (Satellite Observation Package for Retrieval,
+Analysis, and Navigation) を開発するための場所です。月・惑星圏の衛星データを
+Python から一貫した使用感で扱い、必要な重い処理は Rust に逃がす方針で進めます。
+
+## 目的
+
+- KAGUYA/SELENE、ARTEMIS などの衛星データ解析をまず月周辺ミッションから整備する。
+- ミッションごとのデータ形式・測定器差分は `projects/<mission>` に閉じ込める。
+- 利用者向け API はできるだけ共通化し、時刻範囲、instrument、product、座標系、
+  metadata、dataset root を同じ考え方で扱えるようにする。
+- IDL/SPEDAS スクリプトの挙動を読み解き、公開 API としては pure Python + Rust で
+  再実装する。
+
+## 参照元
+
+- 旧実装の参考場所: `F:\idl\lunarsat`
+- 旧実装は解析しながら育った作業リポジトリなので、設計や文章を丸写ししない。
+- 有用な reader、dataset layout、KAGUYA 処理、Rust backend の境界は参考にしてよい。
+- 旧リポジトリや既存データセットを変更・削除・移動しない。必要な場合は明示確認する。
+
+## 想定構成
+
+まだ初期化中のため、最初の実装では次の方向を優先します。
+
+```text
+src/sopran/
+  core/              # 共通データモデル、loader protocol、dataset registry
+  projects/
+    kaguya/          # KAGUYA/SELENE 固有 reader と product builder
+    artemis/         # ARTEMIS 固有 reader と product builder
+  frames/            # 座標系、SPICE、時刻変換
+  analysis/          # mission 非依存の解析補助
+  plotting/          # 可視化補助
+crates/
+  sopran-backend/    # 重い decode、binning、fit、shard 処理
+docs/
+tests/
+```
+
+## 設計方針
+
+- Python API を主入口にする。Rust は backend、CLI、batch 境界で使い、細かすぎる FFI を
+  乱立させない。
+- mission 固有の loader と instrument 差分は隠蔽しすぎない。共通化は
+  `TimeRange`, `Dataset`, `Product`, `Instrument`, `Metadata`, `CoordinateFrame`
+  など自然な境界から始める。
+- SPEDAS/tplot に近い使用感は目指すが、IDL common block やグローバル状態は公開 API に
+  持ち込まない。
+- データファイルの探索は dataset registry / layout 経由にし、解析コードに絶対パスを
+  直接埋め込まない。
+- 大量処理は日別 shard や chunk 単位で中間成果物とログが残る形にする。
+- 解析ノート由来の一時処理を package API に入れる前に、再利用可能な reader、変換、
+  product builder、workflow のどれなのかを分ける。
+
+## コーディング規約
+
+- Python は typed dataclass / pathlib / 明示的な型境界を優先する。
+- 配列処理は `numpy`、表形式は必要に応じて `pandas` または `polars`、CDF は `cdflib`、
+  SPICE は `spiceypy` など、標準的なライブラリを優先する。
+- Rust は決定的で重い処理、バイナリ decode、binning、fit、shard 出力などに使う。
+- public API は小さく保ち、mission 固有 API は `sopran.missions.<mission>` に置く。
+- ドキュメントと利用者向け説明は日本語でよい。API 名、ファイル名、外部仕様名は英語のままにする。
+- ファイル検索は `rg`、手作業の編集は `apply_patch` を優先する。
+
+## データ安全
+
+- 実データ、ダウンロードキャッシュ、大きな生成物、secret は git に入れない。
+- `datasets/`, `data/`, `cache/`, `outputs/`, `working/` は原則として作業生成物扱いにする。
+- ユーザーが明示しない限り、外部データセットの削除、再配置、再帰的な書き換えを行わない。
+- 旧 `lunarsat` 側のファイルは読み取り参考に留める。
+
+## 検証
+
+スキャフォールド後は、変更内容に応じて次の確認を用意・実行します。
+
+```powershell
+python -m pytest -q
+python -m compileall src
+cargo test
+cargo fmt --check
+```
+
+環境作成スクリプトや smoke script を追加したら、この節を実際のコマンドに更新してください。
+
+## Git 運用
+
+- 変更前後に `git status --short` を確認する。
+- ユーザーが明示しない限り、既存変更を revert しない。
+- タスクに関係しない refactor や大きな整形を混ぜない。
+- 設計変更を伴う場合は README または `docs/` も同時に更新する。

sopran-0.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+      Copyright 2026 SOPRAN contributors
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.

sopran-0.0.0/NOTICE

@@ -0,0 +1,9 @@
+SOPRAN
+Copyright 2026 SOPRAN contributors
+
+This product is licensed under the Apache License, Version 2.0.
+
+SOPRAN is designed to interoperate with and validate behavior against
+third-party space science software and data products. Third-party source
+code is not incorporated unless its license has been reviewed and its
+required notices are retained.

sopran-0.0.0/PIPELINE.md

@@ -0,0 +1,74 @@
+# SOPRAN Pipeline Spec
+
+Status: draft
+
+Pipeline is the advanced batch/storage API. It is not the beginner-facing API.
+The beginner path is object-first:
+
+```python
+flux = kg.esa1.energy_flux.load(time)
+flux.plot()
+```
+
+Pipeline is used for raw download, decode, normalization, parquet generation,
+feature generation, database products, quicklook batches, and Rust backend
+stages.
+
+## Naming Rules
+
+Variable names are endpoints in the object API:
+
+```python
+kg.esa1.energy_flux
+```
+
+Pipeline should not use `.energy_flux()` as a primary stage name. Use
+`select_variables(...)` for stored variables and `derive(...)` for derived
+products.
+
+```python
+pipe = (
+    kg.esa1
+    .pipeline(time)
+    .download()
+    .decode()
+    .normalize()
+    .select_variables("energy_flux", "counts", "quality")
+    .quicklook("esa1_counts")
+    .write("kaguya.esa1.normalized", layer="normalized")
+)
+```
+
+Derived products:
+
+```python
+pipe = (
+    kg.esa1
+    .pipeline(time)
+    .from_normalized()
+    .derive("pitch_angle_distribution")
+    .write("kaguya.esa1.pitch_angle_distribution", layer="features")
+)
+```
+
+Rust backends should be large stages taking manifests, catalogs, shard paths,
+and JSON config. v0.1 uses Python reference implementations first.
+
+## Quicklook Stage
+
+`quicklook()` records a preview generation stage. The current KAGUYA ESA1
+Python backend writes Matplotlib PNG quicklooks and JSON metadata under the
+output dataset `preview/` directory after parquet output succeeds.
+
+```python
+(
+    kg.esa1.pipeline(time)
+    .decode()
+    .select_variables("counts")
+    .quicklook("counts")
+    .write("kaguya.esa1.counts", layer="normalized")
+    .run()
+)
+```
+
+The first implementation supports one selected variable and `backend="matplotlib"`.