Skip to content

Commit 9dd93e4

Browse files
重組目錄:rocket_program 套件、docs、scripts、README、MIT 授權與 pyproject
Made-with: Cursor
1 parent b5f0ba7 commit 9dd93e4

100 files changed

Lines changed: 493 additions & 115 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/GITHUB_SETUP.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# GitHub 儲存庫設定(Description、Topics、Releases、Packages、Tags)
2+
3+
以下需在 [github.com/dragonheart8787/rocket_program](https://github.com/dragonheart8787/rocket_program) 網頁上手動操作(無法只靠 Git 推送完成)。
4+
5+
## Repository description(簡短說明)
6+
7+
建議貼上(英文,搜尋友善):
8+
9+
```text
10+
Python rocket design toolkit: mission ΔV, propulsion, structures, thermal, GNC, V&V, UQ, benchmarks, aero surrogates. MIT.
11+
```
12+
13+
或中文版:
14+
15+
```text
16+
Python 火箭設計工具:任務 ΔV、推進、結構、熱力、GNC、V&V、不確定度、對標與氣動代理。MIT 授權。
17+
```
18+
19+
設定位置:**倉庫首頁 → About 右側齒輪 → Description**
20+
21+
## Topics(核心關鍵字標籤)
22+
23+
建議新增 Topics(可搜尋、利於探索):
24+
25+
`rocket` `aerospace` `propulsion` `launch-vehicle` `trajectory` `GNC` `systems-engineering` `python` `numpy` `verification-validation` `uncertainty-quantification` `aerodynamics` `rocket-science` `engineering-simulation` `LEO`
26+
27+
設定位置:**About → ⚙️ → Topics**
28+
29+
## Tags(版本標籤)
30+
31+
在本地建立並推送標籤(與 [CHANGELOG.md](../CHANGELOG.md) 版本一致):
32+
33+
```bash
34+
git tag -a v1.0.0 -m "Release v1.0.0: packaged layout, README, MIT license"
35+
git push origin v1.0.0
36+
```
37+
38+
## Releases(發行說明)
39+
40+
1. 推送 `v1.0.0`**tag** 後,到 **Releases → Draft a new release**
41+
2. **Choose a tag**`v1.0.0`
42+
3. **Release title**:例如 `v1.0.0`
43+
4. **Describe release**:可複製 `CHANGELOG.md` 中該版本段落,或簡述「套件化目錄、README、授權」。
44+
5. 可附加 **Source code (zip/tar)**(GitHub 會自動產生)。
45+
46+
可選:在 **Actions** 啟用 `.github/workflows/release.yml` 後,推送 tag 會自動建立 Release 草稿/紀錄(依 workflow 內容而定)。
47+
48+
## Packages(套件/容器)
49+
50+
- **Python(PyPI)**:本專案已提供 `pyproject.toml`。若要發佈到 PyPI,需帳號與 API token,於 CI 使用 `twine upload`(勿將 token 寫入程式碼)。
51+
- **GitHub Packages**:可發佈 Docker 映像或 Maven/npm 等;本專案為純 Python 函式庫時,多數使用者以 `pip install git+https://github.com/dragonheart8787/rocket_program.git` 或本地 `pip install -e .` 即可。
52+
53+
建議在 README 註明安裝方式即可,不必強制開 GitHub Packages。

.github/workflows/release.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# 推送符合 v*.*.* 的 tag 時建立 GitHub Release(僅紀錄,不含 PyPI 發佈)
2+
name: Release
3+
4+
on:
5+
push:
6+
tags:
7+
- "v*.*.*"
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
release:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Create GitHub Release
21+
uses: softprops/action-gh-release@v2
22+
with:
23+
generate_release_notes: true
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
本專案依 [Semantic Versioning](https://semver.org/lang/zh-TW/) 標註版本;Git **Tags** 建議與此對齊(例如 `v1.0.0`)。
4+
5+
## [1.0.0] — 2026-03-29
6+
7+
### Added
8+
- `rocket_program` 套件:任務規劃、推進、結構、熱力、GNC、外觀/引擎設計生成
9+
- V&V、UQ/敏感度、可重現包、Benchmark Pack、氣動升級與代理管線
10+
- 根目錄精簡:`scripts/` 啟動腳本、`docs/` 說明文件
11+
- `pyproject.toml`(pip 可安裝)、`LICENSE`(MIT)、整合版 `README.md`
12+
13+
### Changed
14+
- 專案內 `import` 改為套件內相對匯入;資料路徑以儲存庫根目錄為準

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 dragonheart8787
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# rocket_program
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
5+
[![Code style: repository](https://img.shields.io/badge/repository-rocket__program-181717?logo=github)](https://github.com/dragonheart8787/rocket_program)
6+
7+
**Modular Python toolkit for conceptual rocket / launch-vehicle design and engineering analysis** — mission ΔV & staging, propulsion cycles, structures, thermal & TPS, gravity-turn GNC, exterior & engine geometry (JSON/SVG), **V&V**, **uncertainty / sensitivity**, benchmark packs (CEA / GMAT / Sutton–Graves style checks), pluggable aero & surrogate pipelines.
8+
9+
> **Keywords:** `rocket`, `aerospace`, `launch-vehicle`, `propulsion`, `trajectory`, `GNC`, `thermal`, `structures`, `V&V`, `verification`, `validation`, `UQ`, `Monte Carlo`, `sensitivity`, `aerodynamics`, `MDO`, `systems engineering`, `LEO`, `RocketCEA`, `Python`, `NumPy`
10+
11+
繁體中文:**火箭/運載器概念設計與工程分析**(任務、推進、結構、熱力、導引、外觀與引擎生成、驗證確認、不確定度、對標與氣動代理)。
12+
13+
---
14+
15+
## Repository layout
16+
17+
| Path | Purpose |
18+
|------|---------|
19+
| [`rocket_program/`](rocket_program/) | Core Python package (all library modules) |
20+
| [`scripts/`](scripts/) | Thin entrypoints (`run_complete.py`, `run_design_example.py`) |
21+
| [`docs/`](docs/) | Extended documentation & engineering notes |
22+
| [`data/`](data/) | Benchmark / aero sample data |
23+
| [`pyproject.toml`](pyproject.toml) | Package metadata, dependencies, PyPI-oriented keywords |
24+
| [`LICENSE`](LICENSE) | MIT License |
25+
| [`CHANGELOG.md`](CHANGELOG.md) | Version history (align with Git **tags**, e.g. `v1.0.0`) |
26+
27+
Generated outputs (when you run the tools) typically land in the repo root or `full_design_output/`, e.g. `V_V_Report_v1.0.*`, `UQ_Sensitivity_Report_v1.0.json`, `整合工程報告.md`.
28+
29+
---
30+
31+
## Quick start
32+
33+
```bash
34+
# Clone
35+
git clone https://github.com/dragonheart8787/rocket_program.git
36+
cd rocket_program
37+
38+
# Editable install (recommended)
39+
pip install -e .
40+
41+
# Or: run without install (repo root on PYTHONPATH via scripts)
42+
python scripts/run_design_example.py # design + report
43+
python scripts/run_complete.py # design + V&V/UQ/repro pack + summary report
44+
```
45+
46+
Optional extras (see `pyproject.toml`):
47+
48+
```bash
49+
pip install -e ".[cea,optuna,salib]"
50+
```
51+
52+
---
53+
54+
## GitHub: description, topics, releases, packages, tags
55+
56+
Repository **description**, **Topics**, **Releases**, and **Tags** are configured on GitHub (not only in Git files). See **[`.github/GITHUB_SETUP.md`](.github/GITHUB_SETUP.md)** for copy-paste text and step-by-step notes.
57+
58+
- Push a version tag: `git tag -a v1.0.0 -m "Release v1.0.0" && git push origin v1.0.0`
59+
- Optional: workflow [`.github/workflows/release.yml`](.github/workflows/release.yml) creates a **Release** when you push `v*.*.*` tags.
60+
61+
---
62+
63+
## Documentation index
64+
65+
- Design generator overview: [`docs/ROCKET_DESIGN_README.md`](docs/ROCKET_DESIGN_README.md)
66+
- TRL4 / benchmarks roadmap: [`docs/TRL4_ROADMAP.md`](docs/TRL4_ROADMAP.md)
67+
- SAP / delivery notes: [`docs/SAP_DELIVERY_SPEC.md`](docs/SAP_DELIVERY_SPEC.md)
68+
- More notes: everything under [`docs/`](docs/)
69+
70+
---
71+
72+
## License
73+
74+
[MIT](LICENSE) — Copyright (c) 2026 dragonheart8787.

UQ_Sensitivity_Report_v1.0.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"report_version": "1.0",
3-
"report_date": "2026-03-12T08:39:54.995433",
3+
"report_date": "2026-03-29T20:36:03.779824",
44
"monte_carlo": {
55
"n_samples": 1000,
66
"random_seed": 42,
@@ -121,51 +121,51 @@
121121
"thrust": {
122122
"P90_CI": {
123123
"percentile": 90,
124-
"value": 2993.6307448312846,
125-
"ci_lower": 2974.6831225437572,
126-
"ci_upper": 3008.048057999512,
124+
"value": 2982.41586139052,
125+
"ci_lower": 2964.5444428943256,
126+
"ci_upper": 2999.0750937605612,
127127
"confidence": 0.95,
128-
"ci_width": 33.364935455754676
128+
"ci_width": 34.530650866235646
129129
}
130130
},
131131
"max_q": {
132132
"P90_CI": {
133133
"percentile": 90,
134-
"value": 11316.937127815547,
135-
"ci_lower": 11189.268295211812,
136-
"ci_upper": 11372.297798728812,
134+
"value": 11326.228798197684,
135+
"ci_lower": 11212.33184351538,
136+
"ci_upper": 11471.690378244564,
137137
"confidence": 0.95,
138-
"ci_width": 183.0295035170002
138+
"ci_width": 259.3585347291846
139139
}
140140
},
141141
"drag": {
142142
"P90_CI": {
143143
"percentile": 90,
144-
"value": 3478.610264070605,
145-
"ci_lower": 3424.3160729910996,
146-
"ci_upper": 3517.477487262619,
144+
"value": 3465.7480861571694,
145+
"ci_lower": 3427.7865621823357,
146+
"ci_upper": 3525.0330231030866,
147147
"confidence": 0.95,
148-
"ci_width": 93.16141427151933
148+
"ci_width": 97.2464609207509
149149
}
150150
},
151151
"fuel_margin": {
152152
"P90_CI": {
153153
"percentile": 90,
154-
"value": 9.383915178820242,
155-
"ci_lower": 9.336805016592097,
156-
"ci_upper": 9.408051547872017,
154+
"value": 9.380864578203271,
155+
"ci_lower": 9.354406236063772,
156+
"ci_upper": 9.410872655419789,
157157
"confidence": 0.95,
158-
"ci_width": 0.07124653127991998
158+
"ci_width": 0.05646641935601693
159159
}
160160
},
161161
"heat_flux": {
162162
"P90_CI": {
163163
"percentile": 90,
164-
"value": 106259.24261298556,
165-
"ci_lower": 105560.01274783161,
166-
"ci_upper": 106743.08962330225,
164+
"value": 106225.46856112134,
165+
"ci_lower": 105640.10436112777,
166+
"ci_upper": 106580.92700229849,
167167
"confidence": 0.95,
168-
"ci_width": 1183.0768754706369
168+
"ci_width": 940.8226411707146
169169
}
170170
}
171171
}

V_V_Report_v1.0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"report_version": "1.0",
3-
"report_date": "2026-03-12T08:39:54.743110",
3+
"report_date": "2026-03-29T20:36:03.541695",
44
"n_test_cases": 10,
55
"n_passed": 10,
66
"n_failed": 0,
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)