deploy: cadc6ed

Author: SiboVG

.gitignore

@@ -0,0 +1,9 @@
+.idea
+**/.venv
+
+# Build output
+metadata.json
+motors.db
+motors.db.gz
+
+.env

LICENSE

@@ -0,0 +1,230 @@
+# OpenRocket Motor Database
+
+This repository acts as the dynamic backend for OpenRocket's thrust curve data.
+
+## Deployment & API Endpoints
+
+This repository utilizes **GitHub Pages** to act as a static Content Delivery Network (CDN) for the compiled motor data. This ensures high availability and fast downloads for OpenRocket users without requiring a dedicated backend server.
+
+## Architecture
+
+1.  **Source:** John Coker's [ThrustCurve.org](https://www.thrustcurve.org/) API (thanks a lot for this incredible resource!).
+2.  **Automation:** GitHub Actions runs weekly.
+3.  **Process:**
+    *   Checks for new motors.
+    *   Downloads raw `.eng` and `.rse` files to `data/`.
+    *   Compiles them into a SQLite database (`motors.db`).
+    *   GZips and hashes the database.
+4.  **Distribution:** The resulting `motors.db.gz` and `metadata.json` are published to GitHub Pages.
+
+The deployment process follows a split-branch strategy:
+
+1.  **`main` branch:** Contains the source code, scripts, and the raw text cache (`.eng`/`.rse` files).
+2.  **`gh-pages` branch:** Contains **only** the build artifacts (`motors.db.gz` and `metadata.json`).
+
+Every time the [Update Workflow](.github/workflows/update-motors.yml) runs (scheduled weekly), it commits the new raw data to `main`, compiles the database, and force-pushes the binary artifacts to `gh-pages`.
+
+### Public Endpoints
+
+The OpenRocket client (and other interested 3rd parties) can access the live data at the following URLs:
+
+| File | URL | Description |
+| :--- | :--- | :--- |
+| **Manifest** | `https://openrocket.github.io/motor-database/metadata.json` | Lightweight JSON file. Contains `database_version`, `generated_at`, `last_checked`, `sha256`, and the signature fields for verification. Checked by the client on startup. |
+| **Database** | `https://openrocket.github.io/motor-database/motors.db.gz` | GZipped SQLite database. Downloaded by the client *only* if the manifest version differs from the local cache. |
+
+### Manifest Format
+The `metadata.json` structure is defined as follows:
+`database_version` is a sortable timestamp in `YYYYMMDDHHMMSS` format.
+```json
+{
+  "schema_version": 2,
+  "database_version": 20251225140000,
+  "generated_at": "2025-12-25T14:00:00.000000",
+  "last_checked": "2025-12-27T14:00:00.000000",
+  "motor_count": 1033,
+  "curve_count": 1320,
+  "sha256": "a1b2c3d4e5f6...",
+  "sha256_gz": "a1b2c3d4e5f6...",
+  "sig": "base64-signature...",
+  "download_url": "https://openrocket.github.io/motor-database/motors.db.gz"
+}
+```
+
+Signature notes:
+- `sig` is an Ed25519 signature over `openrocket-motordb-v1\n{database_version}\n{sha256_gz}\n`.
+- `sha256_gz` is the SHA-256 of the gzipped database; `sha256` is kept for backward compatibility.
+- `key_id` is optional for key rotation.
+
+## Database Schema
+
+The SQLite schema lives in `schema/V1__initial_schema.sql` and is optimized for fast client lookups. Foreign keys are enabled with cascade deletes.
+
+### Entity Relationship
+
+```
+manufacturers          motors              thrust_curves           thrust_data
+┌──────────────┐      ┌──────────────┐     ┌──────────────┐        ┌──────────────┐
+│ id (PK)      │◄─────│ mfr_id (FK)  │     │ id (PK)      │◄───────│ curve_id(FK) │
+│ name         │  1:N │ id (PK)      │◄────│ motor_id(FK) │    1:N │ id (PK)      │
+│ abbrev       │      │ tc_motor_id  │ 1:N │ tc_simfile_id│        │ time_seconds │
+└──────────────┘      │ designation  │     │ source       │        │ force_newtons│
+                      │ impulse_class│     │ format       │        └──────────────┘
+                      │ ...          │     │ ...          │
+                      └──────────────┘     └──────────────┘
+```
+
+- **manufacturers** → **motors**: One manufacturer has many motors
+- **motors** → **thrust_curves**: One motor can have multiple thrust curves (different sources/measurements)
+- **thrust_curves** → **thrust_data**: One curve has many time/thrust data points
+
+### Tables and Columns
+
+**meta**
+
+| Column | Type | Notes |
+| :--- | :--- | :--- |
+| key | TEXT | Primary key |
+| value | TEXT | Required |
+
+Keys stored: `schema_version`, `database_version`, `generated_at`, `motor_count`, `curve_count`.
+
+---
+
+**manufacturers**
+
+| Column | Type | Notes |
+| :--- | :--- | :--- |
+| id | INTEGER | Primary key, autoincrement |
+| name | TEXT | Required, unique (e.g. "AeroTech") |
+| abbrev | TEXT | Short name (e.g. "AT") |
+
+---
+
+**motors**
+
+| Column | Type | Notes |
+| :--- | :--- | :--- |
+| id | INTEGER | Primary key, autoincrement |
+| manufacturer_id | INTEGER | FK to `manufacturers.id` |
+| tc_motor_id | TEXT | ThrustCurve.org motor ID |
+| designation | TEXT | Required (e.g. "H128W") |
+| common_name | TEXT | Display name (e.g. "H128") |
+| impulse_class | TEXT | Letter class: A, B, C, ... O |
+| diameter | REAL | Motor diameter in mm |
+| length | REAL | Motor length in mm |
+| total_impulse | REAL | Total impulse in Ns |
+| avg_thrust | REAL | Average thrust in N |
+| max_thrust | REAL | Maximum thrust in N |
+| burn_time | REAL | Burn time in seconds |
+| propellant_weight | REAL | Propellant weight in grams |
+| total_weight | REAL | Total weight in grams |
+| type | TEXT | "SU" (single-use), "reload", "hybrid" |
+| delays | TEXT | Available delays, e.g. "0,6,10,14" |
+| case_info | TEXT | Case info, e.g. "RMS 38/360" |
+| prop_info | TEXT | Propellant info, e.g. "White Lightning" |
+| sparky | INTEGER | 1 if sparky motor, 0 otherwise |
+| info_url | TEXT | URL to motor info page |
+| data_files | INTEGER | Number of data files on ThrustCurve |
+| updated_on | TEXT | Last update date from ThrustCurve |
+| description | TEXT | RASP file comments (header notes, newlines removed) |
+| source | TEXT | Data source (e.g. "thrustcurve.org", "manual") |
+
+---
+
+**thrust_curves**
+
+Each motor can have multiple thrust curves from different sources (certification, manufacturer, user submissions).
+
+| Column | Type | Notes |
+| :--- | :--- | :--- |
+| id | INTEGER | Primary key, autoincrement |
+| motor_id | INTEGER | FK to `motors.id`, cascade delete |
+| tc_simfile_id | TEXT | ThrustCurve.org simfile ID |
+| source | TEXT | "cert", "mfr", or "user" |
+| format | TEXT | "RASP" or "RSE" |
+| license | TEXT | "PD", "free", or other |
+| info_url | TEXT | URL to simfile info page |
+| data_url | TEXT | URL to download simfile |
+| total_impulse | REAL | Calculated total impulse (Ns) |
+| avg_thrust | REAL | Calculated average thrust (N) |
+| max_thrust | REAL | Calculated max thrust (N) |
+| burn_time | REAL | Calculated burn time (s) |
+
+---
+
+**thrust_data**
+
+Time/thrust data points for each thrust curve.
+
+| Column | Type | Notes |
+| :--- | :--- | :--- |
+| id | INTEGER | Primary key, autoincrement |
+| curve_id | INTEGER | FK to `thrust_curves.id`, cascade delete |
+| time_seconds | REAL | Time in seconds |
+| force_newtons | REAL | Thrust force in Newtons |
+
+---
+
+### Indices
+
+| Index | Table | Columns | Purpose |
+| :--- | :--- | :--- | :--- |
+| idx_motor_mfr | motors | manufacturer_id | Filter by manufacturer |
+| idx_motor_diameter | motors | diameter | Filter by size |
+| idx_motor_impulse | motors | total_impulse | Filter by impulse |
+| idx_motor_impulse_class | motors | impulse_class | Filter by class (A-O) |
+| idx_motor_tc_id | motors | tc_motor_id | Lookup by ThrustCurve ID |
+| idx_curve_motor | thrust_curves | motor_id | Get curves for a motor |
+| idx_curve_simfile | thrust_curves | tc_simfile_id | Lookup by simfile ID |
+| idx_thrust_curve | thrust_data | curve_id | Get data for a curve |
+
+## Manual Usage
+
+1.  `pip install -r scripts/requirements.txt`
+2.  `python scripts/fetch_updates.py` (Downloads new files)
+3.  `python scripts/build_database.py` (Generates DB)
+
+## State Files
+
+- `state/last_update.json`: timestamp of the most recent data/metadata change detected by `scripts/fetch_updates.py`.
+- `state/last_check.json`: timestamp of the most recent update check, even if no changes were found.
+- `state/last_build.json`: input hash + build outputs used by `scripts/build_database.py` to skip rebuilding when the schema/data inputs are unchanged.
+
+## Signing
+
+Signing is done in CI after the database build completes.
+
+What is signed:
+- Canonical message: `openrocket-motordb-v1\n{database_version}\n{sha256_gz}\n`
+- `sha256_gz` is the SHA-256 of `motors.db.gz` (the compressed DB)
+
+What gets added to `metadata.json` by the signing step:
+- `sha256_gz`: SHA-256 of `motors.db.gz` (currently matches `sha256`)
+- `sig`: base64-encoded Ed25519 signature of the canonical message
+- `key_id` (optional): identifier for key rotation
+
+How CI handles it:
+- `.github/workflows/update-motors.yml` installs `cryptography`
+- It runs `python scripts/sign_database.py motors.db.gz metadata.json`
+- The private key is provided via secrets
+
+Set the private key in:
+
+- `MOTOR_DB_PRIVATE_KEY_BASE64` (Ed25519 private key, DER or PEM encoded, then base64)
+- `MOTOR_DB_KEY_ID` (optional, for key rotation)
+
+Manual signing: `python scripts/sign_database.py motors.db.gz metadata.json`
+
+## Unit Tests
+
+1.  `pip install -r scripts/requirements.txt`
+2.  `pip install pytest cryptography`
+3.  `pytest`
+
+## Data Attribution & License
+The motor data in this repository is cached from [ThrustCurve.org](https://www.thrustcurve.org). 
+
+*   **Source:** ThrustCurve.org (maintained by John Coker).
+*   **Copyright:** The data files (`.eng`, `.rse`) retain their original internal copyright headers.
+*   **Usage:** This data is intended for use within OpenRocket. If you wish to use this data for other projects, please use the [ThrustCurve.org API](https://www.thrustcurve.org/info/api.html) directly to ensure you are respecting the latest updates and restrictions.

README.md

@@ -0,0 +1,102 @@
+Resource: https://www.thrustcurve.org/info/raspformat.html, accessed on 2025-12-26 at 23:06 UTC.
+
+
+# RASP File Format
+
+RASP was the original rocket flight simulator, started by the model rocket pioneer G. Harry Stine. This format, named 
+"RASP" or "ENG", has become the standard for motor data interchange and most modern flight simulators can use these 
+files directly or import them into their own proprietary formats.
+
+RASP was a very simple program and had relatively strict requirements for the format and data values. Modern simulators
+are generally more forgiving, but it's still preferable to make your files comply to the original standard to allow them 
+to work with as many programs as possible.
+
+For the hard-core, the [source code](http://www.ibiblio.org/pub/archives/rec.models.rockets/RASP/MRASP/mac_raspinfo.c) 
+for the RASP engine database listing program is the ultimate authority.
+
+This page gives you enough information to create and edit these files by hand. There is also a tool you can use to trace 
+the thrust curve from a graph image and produce RASP data files automatically. See the TCtracer page for more info.
+
+## The Header Line
+
+Blank lines and lines beginning with semicolons are ignored at the begnning of the entry. The first line interpreted is 
+the "header line", which contains info on the motor itself. The header contains seven pieces of info, separated by 
+spaces. All seven must be present for the entry to be read successfully.
+
+Here's a sample fragment, with a few comments and the header line:
+
+![raspheader.png](raspheader.png)
+
+1. The common name of the motor; just the impulse class and average thrust.
+2. The casing diameter in millimeters (mm).
+3. The casing length, also in millimeters.
+4. The list of available delays, separated by dashes. If the motor has an ejection charge but no delay use "0" and if 
+   it has no ejection charge at all use "P" (plugged).
+5. The weight of all consumables in the motor. For solid motors this is simply the propellant itself, but for hybrids 
+   it is the fuel grain(s) plus the oxidizer (such as N2O). This weight is expressed in kilograms (Kg).
+6. The weight of the motor loaded and ready for flight, also in kilograms.
+7. The motor manufacturer abbreviated to a few letters. NAR maintains a list of manufacturer abbreviations on page 2 
+   of the [combined master list](https://www.nar.org/SandT/pdf/CombinedMotorsByImpulse.pdf).
+
+## Data Points
+
+Starting immediately after the header line, the remaining lines contain sample data points. Each sample specifies a time 
+(seconds) and a thrust (Newtons) as two floating-point numbers, usually preceded by a few spaces for readability.
+
+An implicit first point at 0,0 is assumed and should not be specified explicitly. The final point must have a thrust of 
+zero and it indicates the motor's burn time. The points should be in increasing order of time and the thrusts should 
+trace out the thrust curve as representatively as possible.
+
+After the final data point, the entry may end or contain comments and blank lines, but nothing else.
+
+RASP supported a maximum of 32 data points, including the final (zero) point. This site does not enforce that limitation 
+since modern simulator programs don't either. However, files with more than 32 data points will not work with some 
+older programs.
+
+It is common to put a single line containing just a semicolon after the sample data. This is not interpreted by the 
+software, but it does prevent two entries from running together if multiple entries are present in the same file. Here's 
+the first example we created on the [contribute page](https://www.thrustcurve.org/info/contribute.html):
+
+```
+; Rocketvision F32
+; from NAR data sheet updated 11/2000
+; created by John Coker 5/2006
+F32 24 124 5-10-15 .0377 .0695 RV
+   0.01 50
+   0.05 56
+   0.10 48
+   2.00 24
+   2.20 19
+   2.24  5
+   2.72  0
+;
+```
+
+## Common Problems
+
+One common problem with RASP data floating around is that the thrust drops to zero before the end of the data. However, 
+a sample with zero thrust represents the end of the data. Note that a point at zero time is not required. (It is a 
+common mistake to create an initial point at zero time, zero thrust.) This site will detect this problem and reject an 
+entry with zero thrust at other than the last point.
+
+The burn always starts at zero time and thus the burn time is simply the time at the final (zero thrust) point. The 
+final point must have zero thrust and this site will detect this problem and reject an entry without it.
+
+The data points need not be spaced evenly apart, but they must be in order of time. This site will detect this problem 
+and reject an entry where a data point occurs before the previous point (or where the first point occurs in negative 
+time).
+
+The original RASP would only read a motor descriptions from a single file (RASP.ENG). All motor entries were located in 
+this file, separated by comment lines (beginning with a semicolon). When maintaining multiple motor entries in a single 
+file, make sure that each entry is separated by at least one comment line. Since this site is database-oriented, each 
+entry is stored in a separate record. This site will parse these multi-motor files and attempt to pick out the correct 
+motor.
+
+Finally, a perennial problem is with the manufacturer name. Originally, only a few manufacturers existed and each had a 
+single-letter code (E=Estes, A=AeroTech, K=Kosdon, and so on). With the rapid increase in the number of manufacturers, 
+this has become impractical. NAR maintains a list of manufacturer abbreviations in the combined master list, but 
+unfortunately they aren't used consistently.
+
+This site has collected the abbreviations from the NAR master list and those used by various simulator programs and 
+listed them as aliases along with the other manufacturer info (See the Manufacturers page). When scanning simulator 
+files, it checks against the full name, abbreviation and the set of aliases to match the manufacturer.