ballistics-engine 0.31.0 → 0.33.0

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.
package/README.md CHANGED
@@ -1,1039 +1,131 @@
1
- # Ballistics Engine
1
+ # ballistics-engine (WASM)
2
2
 
3
- A high-performance ballistics trajectory calculation engine with comprehensive physics modeling, automatic zeroing, and statistical analysis capabilities.
3
+ WebAssembly build of [`ballistics-engine`](https://github.com/ajokela/ballistics-engine), a
4
+ high-performance ballistics trajectory engine (RK4 integration, wind/Coriolis/spin-drift/Magnus
5
+ effects, custom drag tables, Monte Carlo, and more). This package exposes the same CLI-style
6
+ command surface as the native Rust binary, plus a small object-oriented `Calculator` class, to
7
+ JavaScript/TypeScript.
4
8
 
5
- **Project Website:** [https://ballistics.rs/](https://ballistics.rs/)
9
+ Built with `wasm-pack` and `--no-default-features` — the native crate's default `pdf`/`online`
10
+ features pull in dependencies that don't compile for `wasm32-unknown-unknown`, so the PDF dope-card
11
+ export and the online BC-estimation API are not available from WASM.
6
12
 
7
- ## Features
13
+ > This package is built from `pkg/` (the `wasm-pack --target bundler` output) via
14
+ > `scripts/build-npm.sh` in the source repo. The same script also produces a `pkg-web/` build
15
+ > (`--target web`) for use without a bundler — see "Browser without a bundler" below.
8
16
 
9
- - **Full 3D Trajectory Integration** - Six-state ballistic modeling with adaptive RK45 and fixed-step RK4 integration methods
10
- - **Advanced Drag Models** - Full standard-projectile family (G1, G2, G5, G6, G7, G8, GI, GS, and the British RA4 reference function), each backed by its own real Mach-indexed table with automatic transonic corrections, plus user-supplied custom Cd(Mach) drag tables (`--drag-table`, used as-is with endpoint hold outside their measured domain, no transonic correction applied — see [CLI_USAGE.md](CLI_USAGE.md#custom-drag-tables); `bc_value` is ignored while a custom table is active), with an optional `--cd-scale <FACTOR>` whole-curve truing multiplier (Hornady AFF / AB CDF style; `1.0` = neutral, typical range 0.90-1.10; requires `--drag-table` — see [CLI_USAGE.md](CLI_USAGE.md#whole-curve-drag-scale---cd-scale)). `true-velocity`/`plan-truing`'s forward model is deliberately G1/G7 only. GL is out of scope — its only public source is velocity-domain data, which doesn't fit this engine's Mach-indexed table format.
11
- - **Automatic Zeroing** - Calculate sight adjustments and apply zero angles automatically; `trajectory` echoes the solved bore angle (degrees, additive across table/JSON/CSV) whenever auto-zero ran, and `zero --from-angle <DEGREES>` solves the zero RANGE(S) a previously solved/stored bore angle produces — a bore angle generally implies two zeros (the classic 25/300-yard relationship), so both are reported rather than one being silently picked — so the angle can be captured once and reused later, independent of the day it was solved — see [CLI_USAGE.md](CLI_USAGE.md#solving-range-from-a-stored-angle---from-angle)
12
- - **Canted-Rifle Modeling** - Model a rifle zeroed level but fired canted (`--cant <DEGREES>`, alias `--cant-angle`, on `trajectory`/`monte-carlo`); clockwise cant shifts point of impact right and low downrange for a rifle with an upward zero correction — see [CLI_USAGE.md](CLI_USAGE.md#canted-shooting)
13
- - **Deliberate Zero POI Offset** - Record that the rifle is deliberately zeroed off — e.g. 0.1 in high / 0.2 in left at the zero range (Kestrel ZH/ZO semantics) — and shift the whole solution by the equivalent angular bias (`--zero-poi-up`/`--zero-poi-right`, inches imperial / cm metric, on `trajectory` and every zero-solving subcommand; solve-json `shot.zero_poi_up_m`/`zero_poi_right_m`; saved-profile fields; `.a7p` zero click counts convertible via `profile import --zero-click`) — see [CLI_USAGE.md](CLI_USAGE.md#sight-geometry-and-zero-state)
14
- - **Lateral Sight Offset** - Model offset-mounted optics (`--sight-offset`, inches imperial / mm metric, positive = sight right of bore): the bullet starts that far left of the sight line and the windage zero converges it onto the sight line at the zero range — physical mount geometry, distinct from and additive with the zero POI offset (solve-json `rifle.sight_offset_lateral_m`; saved-profile field; also on `monte-carlo`/WEZ mirroring `--cant`) — see [CLI_USAGE.md](CLI_USAGE.md#sight-geometry-and-zero-state)
15
- - **Multiple Named Zeroes / Per-Load Offsets in Profiles** - Store alternate zero conditions on a saved profile (Lapua Sight-In POI / ATrag zero-zone class): each named set carries an optional zero distance plus constant per-load dial corrections in mils (`profile zero-set add|remove|list`; `--zero-set NAME` on `trajectory`/`come-ups`/`wind-card`/`range-table`/`dsf`/`plan-truing`; corrections are added to total-correction dial outputs before the tracking-CF division; profile-CSV `V_OFFSET_MIL`/`H_OFFSET_MIL` columns and `.a7p --zero-click` import feed sets automatically; unknown names fail loudly listing the available sets) — see [CLI_USAGE.md](CLI_USAGE.md#named-zero-sets-and-per-load-offsets-profile-zero-set---zero-set)
16
- - **Drops Reference: LOS vs Target Plane** - Reference sampled drops to the line of sight (default, unchanged) or to the vertical target plane on steep inclined shots (`trajectory --drops-reference target`: drop ÷ cos(shooting angle), JBM's "target plane" checkbox; sampled table/CSV column relabeled `Drop (target)`/`drop_target_in`; solve-json `shot.drops_reference`) — see [CLI_USAGE.md](CLI_USAGE.md#drops-reference-los-vs-target-plane---drops-reference--mba-1403)
17
- - **Scope Tracking Correction Factors** - Compensate turrets that don't track their nominal click value: derive `CF = actual/dialed` from a tall-target test (`tall-target` subcommand, pure arithmetic), then `--elevation-cf`/`--windage-cf` (or validated saved-profile fields) DIVIDE every dial-unit output once at the shared conversion boundary — come-ups, range/compare/wind cards, mover lead/Ring, PDF dope card, zero MOA/mrad — never raw inches (an under-tracking scope, CF < 1, needs more dial); `true-velocity` multiplies dialed observations by the CF (scope-dial to true angular) so scope error is not baked into trued MV/BC — see [CLI_USAGE.md](CLI_USAGE.md#scope-tracking-correction-factors---elevation-cf---windage-cf-tall-target--mba-1358)
18
- - **Equivalent Horizontal Range (BDC shoot-to)** - Inclined zeroed shots print the flat range whose angular correction against the same zero matches the inclined solution (SIG AMR / Leica EHR / Gunwerks style, angular-match inversion over one flat re-solve — not the rifleman's-rule cosine), so fixed BDC turrets/reticles can dial as if flat (`trajectory` summary line; solve-json `summary.equivalent_horizontal_range_m`; public `TrajectorySolver::equivalent_horizontal_range`) — see [CLI_USAGE.md](CLI_USAGE.md#equivalent-horizontal-range-bdc-shoot-to--mba-1395)
19
- - **Reticle Hold Points** - Place a firing solution where you actually read it: a point in your own reticle, FFP/SFP aware with second-focal-plane subtensions rescaled for the magnification in use (`reticle hold`, native + browser terminal + a new appended C ABI export; `reticle generate mil-grid|tree|bdc` builds descriptions in one shared serde schema that saved profiles, `--reticle-json` and solve-json's optional `reticle` block all speak). Horus/TREMOR grid layouts, wind-dot calibration and any vendor catalog are deliberately excluded — see [CLI_USAGE.md](CLI_USAGE.md#reticle-hold-points-reticle--mba-1361)
20
- - **Reticle/BDC Inverse Solvers** - Three read-only solvers over an existing load, sharing one drop-vs-range root find: `mark-to-range` maps each reticle subtension to the range where it lands (Nightforce / Nikon Spot On / Swarovski / TRACT), reporting marks the load cannot reach rather than dropping them; `bdc-match` fits the magnification that makes an SFP BDC reticle match the load (Zeiss Rapid-Z; closed-form least squares, with a residual warning when nothing fits); `optimal-zero` min-max searches the one zero that minimizes the largest hold a whole target list needs and reports whether a dead-center hold keeps each inside its vital zone (GeoBallistics HDZ). CLI-only this train — see [CLI_USAGE.md](CLI_USAGE.md#reticlebdc-inverse-solvers--mba-1362)
21
- - **Robust Hold Corridors** - Solve a bounded set of NAMED segmented-wind scenarios at once (`hold-corridor --scenarios set.json --ranges 200,400,600 [--target rect:WxH|circle:D]`) and get, at every range, each scenario's hold, the min/max corridor they span, the minimax (Chebyshev-center) hold, the worst-case miss from it, and whether one hold keeps every scenario inside the target — with a versioned `RobustHoldReportV1` JSON form. Caps (≤8 scenarios, ≤64 ranges) and malformed segments are structured errors raised *before* any solving, and reordering scenarios cannot change the answer. No probabilities are assigned anywhere: the corridor is the span of the hypotheses you supplied, not a confidence interval — see [CLI_USAGE.md](CLI_USAGE.md#robust-hold-corridors-hold-corridor--mba-1349)
22
- - **Moving-Target Lead** - Wind-aware hold tables for targets moving at a constant speed/angle, with iterative intercept-range correction for non-perpendicular motion (`lead` subcommand; public `ballistics_engine::calculate_lead` API) — see [CLI_USAGE.md](CLI_USAGE.md#moving-target-lead)
23
- - **Mover Ring** - Field-tested alternative for engaging movers: a per-point ring radius (`target_speed × time-of-flight`) falls out of an already-solved trajectory with no second command or re-entered ballistic data (`trajectory --target-speed`, additive across table/JSON/CSV output); `lead` also gained `trajectory`'s powder-temperature flags for muzzle-velocity parity between the two — see [CLI_USAGE.md](CLI_USAGE.md#mover-ring---target-speed)
24
- - **Side-by-Side Load Comparison** - Compare 2-8 loads at identical conditions with per-load independent zeroing (`compare --load "NAME:DRAG:BC:MASS:VELOCITY[:DIAMETER]"`, mixable with saved profiles); JSON/CSV output carries per-row deltas against the first load — see [CLI_USAGE.md](CLI_USAGE.md#load-comparison-compare)
25
- - **Powder Temperature Command** - Resolve the temperature-adjusted muzzle velocity standalone, without a trajectory solve (`powder` subcommand): linear fps-per-degree model or a measured temperature→velocity curve, optional `--sweep` velocity ladder and muzzle energy; shares the solvers' exact resolution code (public `resolve_powder_adjusted_velocity` API) — see [CLI_USAGE.md](CLI_USAGE.md#powder-temperature-velocity-powder)
26
- - **Unit Conversion** - Seamless switching between Imperial (default) and Metric units
27
- - **BC Segmentation** - Velocity-dependent ballistic coefficient modeling with automatic estimation
28
- - **Atmospheric Modeling** - Temperature, pressure, humidity, and altitude effects with ICAO standard atmosphere; also accepts a single **density altitude** reading (`trajectory --density-altitude`, feet imperial / meters metric) as a direct alternative to entering altitude/pressure/temperature separately — back-solves an ISA-equivalent atmosphere (preserving Mach/lapse-rate/segmented-atmosphere behavior, not a density-only shortcut) and supersedes `--altitude`/`--pressure`/`--pressure-type` entirely, with an explicit `--temperature` still honored for correct powder-temperature sensitivity — see [CLI_USAGE.md](CLI_USAGE.md#density-altitude-as-a-direct-input---density-altitude)
29
- - **Clock-Position Wind Entry** - Enter wind direction as the dominant field convention: marked clock positions (`--wind-direction 3oc`, `10h30`, or `10:30`; 12 o'clock = headwind, minutes count 0.5°) alongside plain degrees on every wind-direction flag and the WASM terminal; inside `--wind-segment` the colon-free forms apply (`10:3oc:400`) while `10:30:400` keeps its numeric SPEED:ANGLE:DIST meaning; bare numbers stay degrees everywhere — see [CLI_USAGE.md](CLI_USAGE.md#wind-direction-entry-degrees-clock-positions--mba-1367)
30
- - **Earth-Fixed Compass Wind Bearings** - Store wind as absolute compass bearings and let the solver re-reference them against the shot azimuth (`--wind-ref compass` + `--shot-direction` on `trajectory`/`monte-carlo`; covers the single direction, location-CSV WIND_DIR, and every `--wind-segment` angle; Monte Carlo converts before dispersion sampling; solve-json `wind.wind_reference`; WASM builder `setWindReference`/`setShotDirection`; wind FROM north on a shot due north = pure headwind, pinned) — see [CLI_USAGE.md](CLI_USAGE.md#earth-fixed-compass-bearings---wind-ref-compass--mba-1368)
31
- - **Wind Effects** - 3D wind calculations with altitude-dependent wind shear modeling, **downrange-segmented wind** (`--wind-segment SPEED:ANGLE:DIST[:VERTICAL]`, repeatable — model wind that varies along the path, e.g. muzzle plus downrange sensor readings), and **vertical wind** (`--wind-vertical <SPEED>` on `trajectory`/`monte-carlo`, or the segment's optional 4th field; positive = updraft, raises point of impact) — see [CLI_USAGE.md](CLI_USAGE.md#vertical-wind)
32
- - **Oblique Wind-Drift Cards** - Wind dope cards at any wind-FROM angle, not just full-value 90° crosswind (`wind-card --wind-angle <DEG>` or `--wind-angles <CSV>` for one card per angle); each cell is a real trajectory solve, default (no flags) unchanged from the classic full-value 90° card — see [CLI_USAGE.md](CLI_USAGE.md#wind-card)
33
- - **Monte Carlo Simulations** - Statistical analysis with parameter uncertainties
34
- - **BC Estimation** - Estimate ballistic coefficients from trajectory data
35
- - **Advanced Physics**:
36
- - **Spin Effects**: Magnus effect and empirical Litz spin drift
37
- - **Earth Effects**: Coriolis effect with latitude-dependent calculations
38
- - **Angular Motion**: Gyroscopic precession and nutation physics
39
- - **Transonic Analysis**: Pitch damping coefficients and stability warnings
40
- - **Trajectory Sampling**: Regular interval data collection for analysis
41
- - **Form Factor Corrections**: Bullet-specific drag adjustments
42
- - **Multiple Output Formats** - JSON, CSV, formatted tables, and printable PDF dope cards
43
- - **Terminal Chart** - Inline drop, drift, velocity, and energy vs. range charts right in the terminal (`trajectory --plot`, Unicode braille-dot canvas by default, `--plot ascii` fallback); pure Rust, zero new dependencies, no ANSI colors — see [CLI_USAGE.md](CLI_USAGE.md#terminal-chart---plot)
44
- - **Profile import**: `ballistics profile import file.a7p` — imports ArcherBC2 `.a7p` profiles (rifle, bullet, atmosphere, zero) with a full mapping report; `--dry-run` previews without saving
45
-
46
- ## Installation
47
-
48
- ### From crates.io
49
-
50
- ```bash
51
- cargo install ballistics-engine
52
- ```
53
-
54
- ### From Source
55
-
56
- ```bash
57
- git clone https://github.com/ajokela/ballistics-engine.git
58
- cd ballistics-engine
59
- cargo build --release
60
- ```
61
-
62
- The binary will be at: `target/release/ballistics`
63
-
64
- ### Feature Flags
65
-
66
- | Feature | Default | Description |
67
- |---------|---------|-------------|
68
- | `online` | ✅ Yes | HTTP client for API integration (`--online` flag) |
69
-
70
- To build without network capabilities:
71
- ```bash
72
- cargo build --release --no-default-features
73
- ```
74
-
75
- ## Quick Start
76
-
77
- ### Basic Trajectory (Imperial Units - Default)
78
-
79
- ```bash
80
- # .308 Winchester, 168gr bullet at 2700 fps
81
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --max-range 1000
82
-
83
- # With automatic zeroing at 200 yards
84
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --auto-zero 200 --max-range 500
85
- ```
86
-
87
- ### Metric Units
88
-
89
- ```bash
90
- # Same bullet in metric units
91
- ./ballistics trajectory --units metric -v 823 -b 0.475 -m 10.9 -d 7.82 --max-range 1000
92
- ```
93
-
94
- ## Unit Systems
95
-
96
- The engine supports two unit systems, selectable with the `--units` flag:
97
-
98
- ### Imperial (Default)
99
- - **Velocity**: feet per second (fps)
100
- - **Mass**: grains
101
- - **Distance**: yards
102
- - **Diameter**: inches
103
- - **Temperature**: Fahrenheit
104
- - **Pressure**: inHg
105
- - **Wind**: mph
106
-
107
- ### Metric
108
- - **Velocity**: meters per second (m/s)
109
- - **Mass**: grams
110
- - **Distance**: meters
111
- - **Diameter**: millimeters
112
- - **Temperature**: Celsius
113
- - **Pressure**: hPa (millibars)
114
- - **Wind**: m/s
115
-
116
- ## Commands
117
-
118
- ### Trajectory Calculation
119
-
120
- Calculate ballistic trajectory with environmental conditions:
121
-
122
- ```bash
123
- # Imperial units (default)
124
- ./ballistics trajectory \
125
- -v 2700 # Velocity (fps)
126
- -b 0.475 # Ballistic coefficient
127
- -m 168 # Mass (grains)
128
- -d 0.308 # Diameter (inches)
129
- --drag-model g7 # G7 drag model
130
- --angle 0 # Launch angle (degrees)
131
- --max-range 1000 # Maximum range (yards)
132
- --wind-speed 10 # Wind speed (mph)
133
- --wind-direction 90 # Wind from right (degrees)
134
- --temperature 59 # Temperature (Fahrenheit)
135
- --pressure 29.92 # Pressure (inHg)
136
- --humidity 50 # Relative humidity (%)
137
- --altitude 0 # Altitude (feet)
138
- --full # Show all trajectory points
139
- ```
140
-
141
- #### Auto-Zero Feature
142
-
143
- Automatically calculate and apply the zero angle for a specific distance:
144
-
145
- ```bash
146
- # Zero at 200 yards and show trajectory to 500 yards
147
- ./ballistics trajectory \
148
- -v 2700 -b 0.475 -m 168 -d 0.308 \
149
- --auto-zero 200 \ # Automatically zero at 200 yards
150
- --max-range 500 \
151
- --full
152
-
153
- # Custom sight height for auto-zero
154
- ./ballistics trajectory \
155
- -v 2700 -b 0.475 -m 168 -d 0.308 \
156
- --auto-zero 100 \
157
- --sight-height 0.055 # 2.2 inches in yards
158
- ```
159
-
160
- #### Zero-Day Conditions (zero shift)
161
-
162
- A rifle's zero is a fixed barrel angle set on the day you sighted in. If you later shoot
163
- in different weather — or with a different muzzle velocity (e.g. a cold vs. warm powder
164
- temperature) — the point of impact shifts. By default `--auto-zero` solves the zero angle
165
- using the same conditions you pass for the shot, which assumes you zeroed in today's
166
- conditions. The `--zero-*` flags let you decouple the two: the zero **angle** is solved
167
- under the conditions the rifle was actually zeroed in, while the trajectory itself runs
168
- under the current shot-day conditions.
169
-
170
- ```bash
171
- # Zeroed on a cold morning (28 F) at 2600 fps; shooting this afternoon at 85 F / 2700 fps.
172
- # The zero angle is solved for the cold/slow load, then the warm/fast trajectory is
173
- # computed against it — so the dope correctly shows the point of impact drifting high.
174
- ./ballistics trajectory \
175
- -v 2700 -b 0.19 -m 77 -d 0.224 --drag-model g7 \
176
- --temperature 85 --pressure 29.92 \
177
- --auto-zero 100 --max-range 1000 --full \
178
- --zero-velocity 2600 \
179
- --zero-temperature 28
180
- ```
181
-
182
- Available overrides (each independently optional; any omitted flag falls back to the
183
- shot-day value, so leaving them all off reproduces the previous behavior exactly):
184
-
185
- | Flag | Meaning | Units (imperial / metric) |
186
- |------|---------|---------------------------|
187
- | `--zero-velocity` | Muzzle velocity on the zeroing day | fps / m·s⁻¹ |
188
- | `--zero-temperature` | Air temperature on the zeroing day | °F / °C |
189
- | `--zero-pressure` | Barometric pressure on the zeroing day | inHg / hPa |
190
- | `--zero-humidity` | Relative humidity on the zeroing day | percent |
191
- | `--zero-altitude` | Altitude on the zeroing day | feet / meters |
192
-
193
- #### Powder Temperature
194
-
195
- Propellant temperature changes muzzle velocity. Two models are available:
196
-
197
- **Linear** — a constant sensitivity (fps or m/s per degree) applied relative to the
198
- temperature the load was chronographed at:
199
-
200
- ```bash
201
- ./ballistics trajectory -v 2700 -b 0.19 -m 77 -d 0.224 --drag-model g7 \
202
- --temperature 85 --use-powder-sensitivity \
203
- --powder-temp-sensitivity 1.2 --powder-temp 70 # +1.2 fps per F above 70 F
204
- ```
205
-
206
- **Measured curve (non-linear)** — real powders aren't perfectly linear (temperature-
207
- stable powders flatten; others steepen when hot). If you've chronographed the load at
208
- several temperatures, pass the points directly and the muzzle velocity is interpolated
209
- at the powder temperature (clamped at the endpoints — no extrapolation). This
210
- **overrides** `--powder-temp-sensitivity` when supplied:
211
-
212
- ```bash
213
- ./ballistics trajectory -v 2700 -b 0.19 -m 77 -d 0.224 --drag-model g7 \
214
- --temperature 85 \
215
- --powder-temp-curve "40:2620,70:2700,100:2760" # TEMP:VELOCITY points
216
- ```
217
-
218
- **Powder temperature vs air temperature.** The curve maps *powder* temperature to
219
- velocity, while `--temperature` drives air *density*. These are decoupled: the curve is
220
- looked up at `--powder-temp` when given, otherwise at `--temperature` (powder assumed at
221
- air temperature). So a load left in a hot chamber or a cold pocket:
222
-
223
- ```bash
224
- # 85 F air (density), but the powder is at 60 F (velocity from the curve at 60 F)
225
- ./ballistics trajectory ... --temperature 85 --powder-temp 60 \
226
- --powder-temp-curve "40:2620,70:2700,100:2760"
227
- ```
228
-
229
- Both powder models compose with `--auto-zero`, symmetrically. For the linear model,
230
- `--zero-temperature` resolves zero-day velocity relative to the reference `--powder-temp`.
231
- For a curve, `--zero-powder-temp` overrides the powder lookup; otherwise an explicit
232
- `--zero-temperature` is used, or the shot-day `--powder-temp` is inherited when no zero-day
233
- temperature was supplied. Zero-day atmosphere flags still drive air density independently.
234
- An explicit `--zero-velocity` takes precedence over either powder model.
235
-
236
- #### Bore Height and Ground Impact
237
-
238
- Control bore height above ground and ground impact detection:
239
-
240
- ```bash
241
- # Set bore height for prone shooting position (2 feet)
242
- ./ballistics trajectory \
243
- -v 2700 -b 0.475 -m 168 -d 0.308 \
244
- --auto-zero 100 \
245
- --bore-height 2 # 2 feet (imperial) or meters (metric)
246
-
247
- # Disable ground impact detection for full trajectory to max range
248
- ./ballistics trajectory \
249
- -v 2700 -b 0.475 -m 168 -d 0.308 \
250
- --auto-zero 100 \
251
- --max-range 1000 \
252
- --ignore-ground-impact
253
- ```
254
-
255
- Bore height defaults: 5 feet (imperial) / 1.5 meters (metric) - standing position.
256
-
257
- #### Advanced BC Modeling
258
-
259
- Enable velocity-dependent BC modeling for more accurate long-range predictions:
260
-
261
- ```bash
262
- # Enable BC segmentation (velocity-based BC changes)
263
- ./ballistics trajectory \
264
- -v 2700 -b 0.475 -m 168 -d 0.308 \
265
- --use-bc-segments \
266
- --auto-zero 600 \
267
- --max-range 1000
268
- ```
269
-
270
- #### Advanced Physics - Magnus and Spin Drift
271
-
272
- Enable advanced gyroscopic and aerodynamic effects:
273
-
274
- ```bash
275
- # Magnus effect and spin drift calculation
276
- ./ballistics trajectory \
277
- -v 2700 -b 0.475 -m 168 -d 0.308 \
278
- --twist-rate 10 # 1:10" barrel twist
279
- --twist-right # Right-hand twist
280
- --enable-magnus # Enable Magnus effect
281
- --enable-spin-drift # Enable empirical Litz spin drift
282
- --wind-speed 10 \
283
- --wind-direction 90 \
284
- --max-range 1000
285
-
286
- # Coriolis effect for extreme long range
287
- ./ballistics trajectory \
288
- -v 3000 -b 0.750 -m 250 -d 0.338 \
289
- --enable-coriolis \
290
- --latitude 45 # Shooting latitude
291
- --shooting-angle 90 # Azimuth (0=N, 90=E)
292
- --max-range 2000
293
- ```
294
-
295
- ### Zero Calculation
296
-
297
- Calculate the sight adjustment needed to zero at a specific distance:
298
-
299
- ```bash
300
- # Calculate zero for 200 yards
301
- ./ballistics zero \
302
- -v 2700 -b 0.475 -m 168 -d 0.308 \
303
- --target-distance 200
304
-
305
- # With custom sight height (default is 0.05 yards / 1.8 inches)
306
- ./ballistics zero \
307
- -v 2700 -b 0.475 -m 168 -d 0.308 \
308
- --target-distance 300 \
309
- --sight-height 0.055 # 2.2 inches
310
-
311
- # Metric example
312
- ./ballistics zero --units metric \
313
- -v 823 -b 0.475 -m 10.9 -d 7.82 \
314
- --target-distance 200 # 200 meters
315
- ```
316
-
317
- Output includes:
318
- - Zero angle in degrees
319
- - Adjustment in MOA (Minutes of Angle)
320
- - Adjustment in mrad (milliradians)
321
- - Maximum ordinate (highest point of trajectory)
322
-
323
- ### Monte Carlo Simulation
324
-
325
- Run statistical analysis with parameter variations:
326
-
327
- ```bash
328
- ./ballistics monte-carlo \
329
- -v 2700 # Base velocity (fps)
330
- -b 0.475 # Base BC
331
- -m 168 # Mass (grains)
332
- -d 0.308 # Diameter (inches)
333
- -n 1000 # Number of simulations
334
- --velocity-std 10 # Velocity std dev (fps)
335
- --angle-std 0.5 # Angle std dev (degrees)
336
- --bc-std 0.01 # BC std dev
337
- --wind-std 2 # Wind speed std dev (mph)
338
- --wind-direction-std 5 # Wind direction std dev (degrees)
339
- --target-distance 300 # Target distance for hit probability
340
- ```
341
-
342
- ### BC Estimation
343
-
344
- Estimate ballistic coefficient from observed trajectory data:
17
+ ## Install
345
18
 
346
19
  ```bash
347
- ./ballistics estimate-bc \
348
- -v 2700 -m 168 -d 0.308 \
349
- --distance1 100 --drop1 0.0 # First data point
350
- --distance2 200 --drop2 0.023 # Second data point
20
+ npm install @SCOPE/ballistics-engine
351
21
  ```
352
22
 
353
- ### True Velocity (Velocity Truing)
23
+ `@SCOPE` is a placeholder — see the source repo's `README.md` ("WASM / npm Package" section) for
24
+ the real published name once one exists.
354
25
 
355
- Calculate the effective muzzle velocity that produces a measured drop at a known range. This helps "true" your ballistic system by identifying discrepancies between chronograph readings and real-world performance.
26
+ ## Quick start (bundler: webpack, Vite, Rollup, Parcel)
356
27
 
357
- ```bash
358
- # Basic offline calculation
359
- ./ballistics true-velocity \
360
- --measured-drop 5.1 --range 600 \
361
- --bc 0.27 --drag-model g7 \
362
- --mass 140 --diameter 0.264 \
363
- --offline
364
-
365
- # With chronograph comparison
366
- ./ballistics true-velocity \
367
- --measured-drop 5.1 --range 600 \
368
- --bc 0.27 --drag-model g7 \
369
- --mass 140 --diameter 0.264 \
370
- --chrono-velocity 2822 \
371
- --offline
372
-
373
- # Chronograph measured downrange, not at the muzzle (MBA-1377): most
374
- # chronographs read 10-15 ft (or 25 m) downrange, so --chrono-distance
375
- # back-solves the true muzzle velocity from the raw reading
376
- ./ballistics true-velocity \
377
- --measured-drop 5.1 --range 600 \
378
- --bc 0.27 --drag-model g7 \
379
- --mass 140 --diameter 0.264 \
380
- --chrono-velocity 2822 --chrono-distance 15 \
381
- --offline
382
-
383
- # With BC5D tables for improved accuracy
384
- ./ballistics true-velocity \
385
- --measured-drop 5.1 --range 600 \
386
- --bc 0.27 --drag-model g7 \
387
- --mass 140 --diameter 0.264 \
388
- --bc-table-auto --offline
389
-
390
- # Joint MV + BC calibration from multiple observed impacts
391
- ./ballistics true-velocity \
392
- --range 300 --measured-drop 1.30 \
393
- --observed 600:4.40 --observed 900:9.00 \
394
- --bc 0.45 --drag-model g1 \
395
- --mass 168 --diameter 0.308
396
- ```
397
-
398
- Use case: A shooter measures 5.1 MIL of drop at 600 yards. Their chronograph showed 2822 fps. The command calculates the effective velocity is actually ~2740 fps, suggesting a -82 fps adjustment for accurate ballistic predictions.
399
-
400
- **Downrange chronograph correction (MBA-1377).** Most chronographs (and radar units) read some distance downrange rather than at the muzzle — 10-15 ft is typical for optical screens, 25 m for Lapua/JBM's reference distance — so the raw reading is a few fps low. `--chrono-distance` back-solves the true muzzle velocity from that reading via secant iteration on the same forward drag model (BC/`--drag-model`/atmosphere) the rest of the command uses; zero or absent is an exact no-op. It's a pure display-side correction (`--chrono-velocity` never feeds the drop-based solve either way) and validates its input to a sane 1-98 ft / 0.3-30 m band (100 ft is out of range) rather than silently extrapolating a bad distance into a bad velocity.
28
+ This package's `main` entry imports its `.wasm` file as a native ES module, which is how
29
+ `wasm-pack --target bundler` output is meant to be consumed. It works out of the box with Vite and
30
+ Rollup (`@rollup/plugin-wasm`), and with webpack once `experiments.asyncWebAssembly` (or
31
+ `experiments.syncWebAssembly`) is enabled — check your bundler's WASM docs if the import fails.
401
32
 
402
- **Joint velocity + BC truing.** With two or more `--observed RANGE:DROP` impacts spanning supersonic to transonic ranges, `true-velocity` fits *both* muzzle velocity and ballistic coefficient against the real trajectory solver. When the observation set is too short/closely-spaced to separate the two, it refuses the joint fit, trues velocity only, and says so — no false-precision BC. See [CLI_USAGE.md](CLI_USAGE.md#joint-mv--bc-calibration-multiple-observed-impacts) for details.
33
+ ```js
34
+ import { WasmBallistics } from '@SCOPE/ballistics-engine';
403
35
 
404
- **Plan the observations before shooting (MBA-1346).** `plan-truing` evaluates a
405
- discrete set of ranges with the same forward model and finite-difference Jacobian
406
- used by the fitter, then chooses an exact-size, minimum-separation-compliant design.
407
- It reports information gain, singular values, conditioning, rejected/unreachable
408
- candidates, and an explicit MV-only recommendation when the available facility
409
- cannot identify BC:
36
+ const calc = new WasmBallistics();
410
37
 
411
- ```bash
412
- ./ballistics plan-truing \
413
- -v 2700 -b 0.475 --drag-model g1 -m 168 -d 0.308 \
414
- --candidate-ranges 200,300,400,500,600,700,800,900 \
415
- --observation-count 3 --minimum-separation 100 \
416
- --measurement-resolution 0.03 --drop-unit mil
417
- ```
418
-
419
- `--measurement-resolution` is the assumed independent **one-standard-deviation**
420
- impact-reading error, not a tolerance or extreme bound. A saved scalar G1/G7
421
- profile may replace the explicit load flags (`--profile NAME`); velocity-banded BC
422
- profiles and custom drag curves are rejected because they do not have one scalar BC
423
- parameter to identify.
424
-
425
- **Quantify what the observations actually learned (MBA-1353).** Add
426
- `--observation-sigma` to opt into a weighted joint MV/BC MAP fit and local Gaussian
427
- uncertainty report. A third `--observed RANGE:DROP:SIGMA` field overrides the default
428
- for one reading. Optional priors are always visible and explicit; predictive output
429
- separates uncertainty in the modeled drop from the wider interval for a future
430
- reading:
431
-
432
- ```bash
433
- ./ballistics true-velocity \
434
- --range 500 --measured-drop 3.18 \
435
- --observed 600:4.35:0.03 --observed 900:8.89:0.02 \
436
- --observation-sigma 0.03 \
437
- --bc 0.45 --drag-model g1 --mass 168 --diameter 0.308 \
438
- --predict-range 1000 --prediction-sigma 0.03 --output json
38
+ // The command surface mirrors the native CLI (see CLI_USAGE.md in the source repo for the full
39
+ // flag reference): .308 Winchester, 168gr @ 2700 fps, zeroed at 200 yd, table out to 500 yd.
40
+ const table = calc.runCommand(
41
+ 'trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --max-range 500 --auto-zero 200',
42
+ );
43
+ console.log(table);
439
44
  ```
440
45
 
441
- The report includes MV/BC 95% intervals, covariance and correlation, chi-square,
442
- effective degrees of freedom, prior-domination/weak-identification warnings, and
443
- propagated drop bands. Declared sigmas are treated as absolute known errors, so the
444
- covariance is not rescaled by residual RMS. With no uncertainty flags, the existing
445
- point estimate and output schema are unchanged.
46
+ ### Custom drag tables (`loadDragTable`)
446
47
 
447
- ### Wind-Call Truing (`true-wind`)
48
+ Supply a measured or manufacturer-published Mach:Cd drag curve (Hornady CDM data, a Lapua/Doppler
49
+ deck, or your own) instead of a G1/G7 model + BC. Once loaded it's applied automatically to every
50
+ `trajectory`, `zero`, `lead`, and `monte-carlo` run — no extra flag needed.
448
51
 
449
- `true-velocity` trues the vertical axis; `true-wind` (MBA-1392) trues the other one.
450
- Give it where your groups actually landed left/right of the aim point and it back-solves
451
- the crosswind that reproduces that miss through the real forward model, plus a wind-call
452
- correction factor against the wind you *called*:
52
+ ```js
53
+ const csv = 'mach,cd\n0.5,0.220\n0.8,0.230\n1.0,0.520\n1.2,0.480\n1.5,0.400\n2.0,0.330\n2.5,0.300\n';
54
+ calc.loadDragTable(new TextEncoder().encode(csv));
55
+ calc.hasDragTable(); // true
453
56
 
454
- ```bash
455
- ./ballistics true-wind \
456
- --miss 500:14.0 --miss 700:29.5 \
457
- -v 2700 -b 0.475 -m 168 -d 0.308 --drag-model g7 \
458
- --twist-rate 11 --called-wind 9
57
+ calc.runCommand('trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --max-range 500');
459
58
  ```
460
59
 
461
- A horizontal miss is not purely wind, so the command separates it: `--twist-rate` is
462
- **required** and gyroscopic spin drift is always modelled and subtracted (a 1:11" .308
463
- drifts ~3.5 in right at 700 yd read as wind, that alone is several mph of error), and
464
- `--latitude` with `--shot-direction` adds Coriolis. Anything the model had no data for
465
- stays absorbed in the solved wind and is named in the report, so a contaminated number is
466
- never presented as pure wind. Signs are documented in one block: `--miss` positive =
467
- impact **right** of aim, solved wind positive = wind **from the shooter's left**
468
- (9 o'clock) pushing impacts right. `--miss` values are linear inches off the target, not
469
- dial readings, so scope tracking correction factors deliberately do not apply.
470
- See [CLI_USAGE.md](CLI_USAGE.md#wind-call-truing-true-wind--mba-1392).
60
+ `loadDragTable` takes raw bytes because WASM has no filesystem access fetch the CSV yourself
61
+ (`fetch()` in the browser, `fs.readFileSync` in Node) and pass the bytes in. The CSV format is
62
+ documented in the source repo's `CLI_USAGE.md` ("Custom Drag Tables"); a matching
63
+ `loadBc5dTable(bytes)` / `hasBc5dTable()` pair exists for BC5D correction tables.
471
64
 
472
- ### DSF (Drop-Scale-Factor) Truing
65
+ ## Browser without a bundler
473
66
 
474
- Second stage of the Applied Ballistics-style two-stage truing workflow (MBA-1357).
475
- Once `true-velocity` has fixed the supersonic (Mach > 1.2) muzzle velocity/BC, the
476
- drop discrepancies that grow through the transonic region and into subsonic flight are
477
- no longer fixable by a single MV correction — the residual is a slowly-varying function
478
- of Mach. `dsf` records observed-drop/predicted-drop ratios at specific Mach <= 1.2
479
- ranges and keys them, one saved profile at a time, to a Mach-indexed table:
67
+ For a plain `<script type="module">` page (no build step), use the `pkg-web/` build instead
68
+ produced by the same `scripts/build-npm.sh`, and the same build already deployed at
69
+ [ballistics.sh](https://ballistics.sh). It ships an explicit async `init()` you call once before
70
+ constructing `WasmBallistics`:
480
71
 
481
- ```bash
482
- # Stage 1: true the muzzle velocity from a supersonic-range drop reading (as above).
483
- ./ballistics true-velocity \
484
- --measured-drop 3.2 --range 500 \
485
- --bc 0.475 --mass 168 --diameter 0.308 \
486
- --offline
72
+ ```html
73
+ <script type="module">
74
+ import init, { WasmBallistics } from './ballistics_engine.js';
487
75
 
488
- # Stage 2: record a subsonic/transonic drop observation on the trued, saved profile.
489
- ./ballistics dsf --saved-profile my-rifle --range 900 --observed-drop 5.1mil
76
+ await init(); // fetches and instantiates ballistics_engine_bg.wasm relative to this file
77
+ const calc = new WasmBallistics();
78
+ console.log(calc.runCommand('trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --max-range 500'));
79
+ </script>
490
80
  ```
491
81
 
492
- `dsf` takes no ballistic parameters of its own it solves the named saved profile's
493
- own trajectory (no CLI overrides) and derives everything else from `--range` and
494
- `--observed-drop` (`mil`, `moa`, or `in`, no separator between number and unit). An
495
- observation whose target-range Mach exceeds 1.2 is rejected outright, pointing back to
496
- `true-velocity`. Up to 6 distinct Mach-keyed points accumulate per profile; a new point
497
- within 0.05 Mach of an existing one supersedes it (announced on stdout); a 7th distinct
498
- point is rejected, naming `--clear-dsf` to make room. `trajectory --saved-profile` and
499
- `come-ups --profile` then auto-apply the table as a **drop-only** correction — velocity,
500
- energy, and time of flight are byte-identical to the untrued solve — printing a
501
- table-output-only note; JSON/CSV carry the corrected drop numbers with no equivalent
502
- text. `profile save NAME ... --clear-dsf` removes an existing table. See
503
- [CLI_USAGE.md](CLI_USAGE.md#dsf-drop-scale-factor-truing) for the full staging-gate
504
- reference.
82
+ Serve `ballistics_engine.js` and `ballistics_engine_bg.wasm` from the same directory, and make sure
83
+ your host serves `.wasm` with `Content-Type: application/wasm` (all major static hosts and CDNs do
84
+ this by default).
505
85
 
506
- ## Advanced Features
86
+ This `pkg-web/` build is not published to npm as part of this package in the current release —
87
+ it's built locally alongside `pkg/` for direct use or self-hosting. If you need it from npm, either
88
+ vendor the files from `pkg-web/` yourself or publish it as a second package.
507
89
 
508
- ### Online Mode (API Integration)
90
+ ### Node.js without a bundler
509
91
 
510
- The CLI can query a remote ballistics API server instead of calculating locally. This enables access to enhanced BC data, ML-augmented predictions, and doppler-derived drag curves.
92
+ Plain Node `import`/`require` cannot load this package's bundler-target `.wasm` import directly.
93
+ Use the `pkg-web/` build instead, passing the file bytes explicitly (Node's `fetch()` does not
94
+ support `file://` URLs):
511
95
 
512
- > **Important:** The `--online` feature connects to a **proprietary cloud service** that is not covered by the MIT license. When using `--online`, trajectory parameters and your IP address are transmitted to our servers. See [ONLINE_SERVICE.md](ONLINE_SERVICE.md) for full terms, privacy policy, and data handling practices.
96
+ ```js
97
+ import { readFileSync } from 'node:fs';
98
+ import init, { WasmBallistics } from './pkg-web/ballistics_engine.js';
513
99
 
514
- ```bash
515
- # Use online mode to query the API
516
- ./ballistics trajectory \
517
- -v 2700 -b 0.475 -m 168 -d 0.308 \
518
- --online \
519
- --max-range 1000
520
-
521
- # Custom API endpoint
522
- ./ballistics trajectory \
523
- -v 2700 -b 0.475 -m 168 -d 0.308 \
524
- --online \
525
- --api-url https://your-api.example.com/v1/calculate \
526
- --max-range 1000
527
- ```
528
-
529
- **Default API**: `https://api.ballistics.7.62x51mm.sh/v1/calculate`
100
+ const wasmBytes = readFileSync(new URL('./pkg-web/ballistics_engine_bg.wasm', import.meta.url));
101
+ await init({ module_or_path: wasmBytes });
530
102
 
531
- Online mode benefits:
532
- - **Enhanced BC data** - Access to doppler-derived ballistic coefficients
533
- - **ML predictions** - Machine learning augmented trajectory calculations
534
- - **BC segments** - Velocity-dependent BC modeling from measured data
535
- - **Form factor corrections** - Bullet-specific drag adjustments
536
-
537
- **Data transmitted when using --online:**
538
- - All trajectory parameters (BC, mass, velocity, wind, atmospheric conditions, etc.)
539
- - Your IP address and client version
540
- - Request logs retained for 30 days, then deleted
541
-
542
- To use only local calculations (no network, no data transmission):
543
- ```bash
544
- cargo install ballistics-engine --no-default-features
103
+ const calc = new WasmBallistics();
104
+ console.log(calc.runCommand('trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --max-range 500'));
545
105
  ```
546
106
 
547
- ### Integration Methods
548
-
549
- The engine supports two numerical integration methods:
107
+ If you need a CommonJS (`require()`) Node build, generate one yourself:
108
+ `wasm-pack build --target nodejs --no-default-features`.
550
109
 
551
- - **RK45 (Dormand-Prince Adaptive)** - Default method, provides best accuracy with adaptive step sizing
552
- - **RK4 (Runge-Kutta 4th Order Fixed-Step)** - Available with `--use-rk4-fixed` flag for faster computation
110
+ ## Caveats
553
111
 
554
- ### Wind Shear Modeling
555
-
556
- Model altitude-dependent wind variations:
557
-
558
- ```bash
559
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 \
560
- --wind-speed 10 --wind-direction 90 \
561
- --enable-wind-shear \
562
- --max-range 1000
563
- ```
564
-
565
- ### Transonic Stability Analysis
566
-
567
- Analyze projectile stability through the transonic regime:
568
-
569
- ```bash
570
- ./ballistics trajectory -v 3000 -b 0.475 -m 168 -d 0.308 \
571
- --enable-pitch-damping \
572
- --max-range 2000
573
- ```
574
-
575
- Provides warnings about transonic instability and minimum pitch damping coefficients.
576
-
577
- ### Trajectory Sampling
578
-
579
- Collect trajectory data at regular intervals for detailed analysis:
580
-
581
- ```bash
582
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 \
583
- --sample-trajectory \
584
- --sample-interval 25 # Sample every 25 meters
585
- --max-range 1000 -o json
586
- ```
587
-
588
- ### Angular Motion Physics
589
-
590
- Model precession and nutation of spinning projectiles:
591
-
592
- ```bash
593
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 \
594
- --twist-rate 10 \
595
- --enable-precession \
596
- --max-range 1000
597
- ```
598
-
599
- ### Complete Advanced Physics Example
600
-
601
- ```bash
602
- ./ballistics trajectory \
603
- -v 2850 -b 0.690 -m 230 -d 0.338 \
604
- --drag-model g7 \
605
- --twist-rate 8.5 --twist-right \
606
- --enable-magnus \
607
- --enable-coriolis \
608
- --enable-spin-drift \
609
- --enable-wind-shear \
610
- --enable-pitch-damping \
611
- --enable-precession \
612
- --sample-trajectory \
613
- --latitude 38.5 \
614
- --shooting-angle 45 \
615
- --wind-speed 15 --wind-direction 270 \
616
- --altitude 6000 \
617
- --max-range 2000
618
- ```
619
-
620
- ## Physics Modeling
621
-
622
- The ballistics engine implements comprehensive physics modeling for accurate trajectory prediction:
623
-
624
- ### Aerodynamic Effects
625
- - **Drag Modeling** - Full standard-projectile family (G1, G2, G5, G6, G7, G8, GI, GS, RA4) plus custom Cd(Mach) curves, with transonic flow corrections
626
- - **Form Factor** - Projectile efficiency corrections based on shape and design
627
- - **Reynolds Number Effects** - Reynolds diagnostics and an opt-in helper for genuinely low-Re flow; standard drag tables are not multiplied by an extra correction
628
-
629
- ### Gyroscopic Effects
630
- - **Spin Drift** - Lateral deviation due to gyroscopic and Magnus effects
631
- - **Precession** - Gyroscopic precession of spinning projectile
632
- - **Nutation** - Oscillatory motion superimposed on precession
633
- - **Spin Decay** - Reduction in spin rate over time due to aerodynamic damping
634
- - **Pitch Damping** - Aerodynamic moments opposing angular motion
635
-
636
- ### Environmental Effects
637
- - **Coriolis Effect** - Earth's rotation influence on long-range trajectories
638
- - **Magnus Effect** - Force from spinning projectile in crossflow
639
- - **Wind Shear** - Altitude-dependent wind variations
640
- - **Atmospheric Stratification** - Density and sound speed variations with altitude
641
-
642
- ### Stability Modeling
643
- - **Dynamic Stability** - Gyroscopic and aerodynamic stability calculations
644
- - **Yaw of Repose** - Gravity/gyroscopic equilibrium yaw; crosswind yaw is a transient handled by aerodynamic jump
645
- - **Limit Cycle Yaw** - Bounded oscillatory motion analysis
646
-
647
- ## Language Bindings
648
-
649
- Official language bindings are maintained as separate projects:
650
-
651
- - **Python**: [ballistics-engine-py](https://github.com/ajokela/ballistics-engine-py) - PyO3 bindings via maturin
652
- - **Ruby**: [ballistics-engine-rb](https://github.com/ajokela/ballistics-engine-rb) - Magnus bindings via rb_sys
653
-
654
- These bindings depend on the `ballistics-engine` crate published on [crates.io](https://crates.io/crates/ballistics-engine).
655
-
656
- ### WASM / npm Package
657
-
658
- The engine also compiles to WebAssembly (`src/wasm.rs`, `wasm-bindgen`) and already powers
659
- [ballistics.sh](https://ballistics.sh) and [ballistics.rs](https://ballistics.rs) in the browser.
660
- It is not yet published to npm for third-party use — `scripts/build-npm.sh` builds and prepares a
661
- publish-ready package; publishing itself is a manual step (see below).
662
-
663
- ```bash
664
- scripts/build-npm.sh
665
- ```
666
-
667
- This builds two `wasm-bindgen` targets, both with `--no-default-features` (the default
668
- `pdf`/`online` features pull in `printpdf`/`ureq`+`ring`, which do not compile for
669
- `wasm32-unknown-unknown` — see "Updating the WASM Module" in `CLAUDE.md`):
670
-
671
- - **`pkg/`** — `--target bundler`, the package meant for `npm publish`. Consumed via a native
672
- `.wasm` ES import by bundlers that understand it (webpack with `experiments.asyncWebAssembly`,
673
- Vite, Rollup + `@rollup/plugin-wasm`, Parcel).
674
- - **`pkg-web/`** — `--target web`, a no-bundler build for direct `<script type="module">` browser
675
- use or manual Node usage without a bundler — the same `--target` already used to build
676
- ballistics.sh/ballistics.rs's WASM. Documented and built for completeness; not published under
677
- the primary package name in this initial pass.
678
-
679
- `wasm-pack` has no built-in dual-target/"publish both" mode, and stitching bundler- and web-target
680
- output into one package.json via manual `exports` conditions isn't something `wasm-pack` generates
681
- or tests for you — see the comment header of `scripts/build-npm.sh` for the full reasoning. A
682
- single bundler-target package as the published npm artifact, with the web build documented
683
- separately, is the ecosystem-standard shape for `wasm-bindgen` crates on npm.
684
-
685
- The script also post-processes each `package.json` (name, description, license, repository,
686
- keywords, and the `files` list — including an `LICENSE-APACHE` entry `wasm-pack` itself omits even
687
- though it copies the file) and installs `README-npm.md` as the package's `README.md`.
688
-
689
- **Before publishing**, edit `pkg/package.json`'s `"name"` — it ships as the placeholder
690
- `"@SCOPE/ballistics-engine"`. Replace `SCOPE` with the maintainer's real npm org/user scope (a
691
- scope decision, plus an npm account with publish rights to it, are both needed and don't exist yet
692
- as of this writing). Then:
693
-
694
- ```bash
695
- scripts/build-npm.sh
696
- cd pkg
697
- npm pack --dry-run # sanity-check the tarball contents first
698
- npm publish --access public
699
- ```
700
-
701
- (`--access public` is required the first time a scoped package is published, since scoped packages
702
- default to private on free npm accounts; `pkg/package.json` also sets `publishConfig.access` to
703
- `public` so a plain `npm publish` works too.)
704
-
705
- ## FFI Layer
706
-
707
- The library includes a Foreign Function Interface (FFI) layer for integration with iOS, Android, and other platforms. The FFI provides C-compatible bindings for all major functionality.
708
-
709
- <img src="ios.png" alt="iOS Integration Example" width="35%">
710
-
711
- ### FFI Features
712
- - **C-Compatible Structures** - All data structures use C-compatible layouts
713
- - **Safe Memory Management** - Proper handling of memory across language boundaries
714
- - **iOS/Swift Integration** - Ready for use with Swift through bridging headers
715
- - **Android/JNI Support** - Compatible with Java Native Interface
716
- - **Monte Carlo Simulation** - Statistical analysis with parameter variations
717
- - **Error Handling** - Graceful error propagation across FFI boundary
718
-
719
- ### Example FFI Usage (C/Swift)
720
- ```c
721
- // Create input parameters
722
- FFIBallisticInputs inputs = {
723
- .muzzle_velocity = 823.0, // m/s
724
- .ballistic_coefficient = 0.475,
725
- .mass = 0.0109, // kg
726
- .diameter = 0.00782, // meters
727
- .drag_model = 0, // G1
728
- .sight_height = 0.05, // meters
729
- .temperature = 15.0, // Celsius
730
- .altitude = 0.0
731
- };
732
-
733
- // Calculate trajectory. The final argument is the integration step in milliseconds
734
- // (minimum 0.1 ms; smaller or non-finite values return NULL).
735
- FFITrajectoryResult* result = ballistics_calculate_trajectory(&inputs, NULL, NULL, 1000.0, 0.1);
736
-
737
- // NULL also reports invalid inputs or the 250,000-point resource ceiling.
738
- // Increase the step, reduce the range, or use adaptive RK45 for an over-budget solve.
739
- if (result != NULL) {
740
- printf("Max range: %.2f meters\n", result->max_range);
741
- ballistics_free_trajectory_result(result);
742
- }
743
- ```
744
-
745
- ### Monte Carlo Simulation via FFI
746
- ```c
747
- // Set up Monte Carlo parameters
748
- FFIMonteCarloParams params = {
749
- .num_simulations = 1000,
750
- .velocity_std_dev = 10.0, // m/s variation
751
- .angle_std_dev = 0.001, // radian variation (elevation)
752
- .bc_std_dev = 0.01, // BC variation
753
- .wind_speed_std_dev = 2.0, // m/s wind variation
754
- .target_distance = 600.0, // Target at 600m
755
- .azimuth_std_dev = 0.001 // radian variation (horizontal)
756
- };
757
-
758
- // Run simulation with an independent 0.1-radian wind-direction sigma.
759
- // Use ballistics_monte_carlo(...) when no direction variation is desired.
760
- FFIMonteCarloResults* results =
761
- ballistics_monte_carlo_with_direction_std_dev(&inputs, NULL, &params, 0.1);
762
-
763
- // Use statistical results
764
- printf("Mean range: %.2f m (σ=%.2f)\n", results->mean_range, results->std_dev_range);
765
- printf("Hit probability at 600m: %.1f%%\n", results->hit_probability * 100);
766
-
767
- // Access individual shots
768
- for (int i = 0; i < results->num_results; i++) {
769
- printf("Shot %d: Range %.2f m, Impact velocity %.2f m/s\n",
770
- i, results->ranges[i], results->impact_velocities[i]);
771
- }
772
-
773
- // Clean up
774
- ballistics_free_monte_carlo_results(results);
775
- ```
776
-
777
- ## Output Formats
778
-
779
- All commands support three output formats via the `-o` flag:
780
-
781
- - **table** (default) - Formatted ASCII table for terminal display
782
- - **json** - Complete data in JSON format for programmatic use
783
- - **csv** - Comma-separated values for spreadsheet analysis
784
-
785
- ## Practical Examples
786
-
787
- ### Hunting Zero
788
-
789
- Zero a hunting rifle at 200 yards with environmental conditions:
790
-
791
- ```bash
792
- # Calculate zero angle
793
- ./ballistics zero \
794
- -v 2650 -b 0.460 -m 180 -d 0.308 \
795
- --target-distance 200
796
-
797
- # Verify trajectory with auto-zero
798
- ./ballistics trajectory \
799
- -v 2650 -b 0.460 -m 180 -d 0.308 \
800
- --auto-zero 200 \
801
- --max-range 400 \
802
- --wind-speed 15 \
803
- --wind-direction 270 \
804
- --temperature 32 \
805
- --humidity 30 \
806
- --altitude 5000 \
807
- --full
808
- ```
809
-
810
- ### Long Range Shooting
811
-
812
- Analyze trajectory for 1000-yard shot:
813
-
814
- ```bash
815
- ./ballistics trajectory \
816
- -v 2850 -b 0.690 -m 230 -d 0.338 \
817
- --drag-model g7 \
818
- --auto-zero 100 \
819
- --max-range 1100 \
820
- --wind-speed 10 \
821
- --wind-direction 45 \
822
- --full \
823
- -o json > trajectory.json
824
- ```
825
-
826
- ### Load Development
827
-
828
- Compare different loads using Monte Carlo:
829
-
830
- ```bash
831
- # Load 1: Higher velocity, more variation
832
- ./ballistics monte-carlo \
833
- -v 2750 -b 0.475 -m 168 -d 0.308 \
834
- -n 1000 \
835
- --velocity-std 15 \
836
- --target-distance 600
837
-
838
- # Load 2: Lower velocity, more consistent
839
- ./ballistics monte-carlo \
840
- -v 2680 -b 0.475 -m 168 -d 0.308 \
841
- -n 1000 \
842
- --velocity-std 8 \
843
- --target-distance 600
844
- ```
845
-
846
- ## Advanced Features
847
-
848
- ### BC Segmentation
849
-
850
- Velocity-dependent BC modeling accounts for how ballistic coefficient changes as the bullet slows down. Enable with `--use-bc-segments`:
851
-
852
- - Automatically estimates BC segments based on bullet characteristics
853
- - No external data required - uses caliber, weight, and BC
854
- - Identifies bullet type (Match, Hunting, VLD, etc.) from parameters
855
- - Applies physics-based BC degradation curves
856
-
857
- Example:
858
- ```bash
859
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --use-bc-segments --max-range 1000
860
- ```
861
-
862
- **Manual velocity-keyed BC segments** — supply your own `VMIN:VMAX:BC` pairs (repeatable,
863
- velocities in `--units`) instead of the auto-estimated/table ones. Keyed to velocity, so it
864
- composes with distance-keyed `--wind-segment`; implies `--use-bc-segments` and overrides
865
- `--bc-table` and `--bc-table-dir`:
866
- ```bash
867
- ./ballistics trajectory -v 2600 -b 0.243 -m 175 -d 0.308 --drag-model g7 --max-range 1000 \
868
- --bc-segment 1800:4000:0.243 --bc-segment 1500:1800:0.228 --bc-segment 1200:1500:0.205
869
- ```
870
-
871
- ### BC5D Correction Tables
872
-
873
- BC5D tables provide ML-derived, 5-dimensional BC corrections indexed by weight, BC, muzzle velocity, current velocity, and drag model. Tables are caliber-specific and capture the complete velocity-dependent behavior.
874
-
875
- **Auto-Download Mode** (requires `online` feature):
876
- ```bash
877
- # Downloads tables automatically on first use
878
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --bc-table-auto
879
-
880
- # Force refresh cached tables
881
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --bc-table-auto --bc-table-refresh
882
- ```
883
-
884
- **Offline Mode** with pre-downloaded tables:
885
- ```bash
886
- ./ballistics trajectory -v 2700 -b 0.475 -m 168 -d 0.308 --bc-table-dir ./bc_tables/
887
- ```
888
-
889
- **Available calibers:** .224, .243, .264, .277, .284, .308, .338
890
-
891
- **Cache locations:**
892
- - macOS: `~/Library/Caches/ballistics-engine/bc5d/`
893
- - Linux: `~/.cache/ballistics-engine/bc5d/`
894
- - Windows: `%LOCALAPPDATA%\ballistics-engine\cache\bc5d\`
895
-
896
- Tables are approximately 1-1.5 MB each and include CRC32 validation to ensure data integrity.
897
-
898
- ### Advanced Physics Modeling
899
-
900
- When enabled, the engine calculates:
901
- - **Magnus Effect** - Side force from spinning projectiles
902
- - **Spin Drift** - Lateral drift due to gyroscopic effects
903
- - **Coriolis Effect** - Earth rotation effects (with latitude input)
904
- - **Transonic Drag** - Enhanced drag modeling in transonic regime
905
- - **Low-Reynolds Helper** - Opt-in viscous correction below the standard projectile-table regime
906
-
907
- ## Building from Source
908
-
909
- ### Requirements
910
-
911
- - Rust 1.70 or later
912
- - Cargo build system
913
-
914
- ### Build Commands
915
-
916
- ```bash
917
- # Debug build
918
- cargo build
919
-
920
- # Release build (optimized)
921
- cargo build --release
922
-
923
- # Run tests
924
- cargo test
925
-
926
- # Build documentation
927
- cargo doc --open
928
- ```
929
-
930
- ## Library Usage
931
-
932
- Use as a Rust library in your own projects:
933
-
934
- ```rust
935
- use ballistics_engine::{
936
- BallisticInputs, TrajectorySolver,
937
- WindConditions, AtmosphericConditions
938
- };
939
-
940
- fn main() -> Result<(), Box<dyn std::error::Error>> {
941
- let inputs = BallisticInputs {
942
- muzzle_velocity: 823.0, // m/s
943
- launch_angle: 0.0, // radians
944
- ballistic_coefficient: 0.475,
945
- mass: 0.0109, // kg
946
- diameter: 0.00782, // meters
947
- sight_height: 0.05, // meters
948
- ..Default::default()
949
- };
950
-
951
- let wind = WindConditions {
952
- speed: 5.0, // m/s
953
- direction: 1.5708, // 90 degrees in radians
954
- ..Default::default()
955
- };
956
-
957
- let atmosphere = AtmosphericConditions {
958
- temperature: 15.0, // Celsius
959
- pressure: 1013.25, // hPa
960
- humidity: 50.0, // %
961
- altitude: 0.0, // meters
962
- ..Default::default()
963
- };
964
-
965
- let solver = TrajectorySolver::new(inputs, wind, atmosphere);
966
- let result = solver.solve()?;
967
-
968
- println!("Max range: {:.2} m", result.max_range);
969
- println!("Max height: {:.2} m", result.max_height);
970
- println!("Time of flight: {:.3} s", result.time_of_flight);
971
-
972
- Ok(())
973
- }
974
- ```
975
-
976
- ## Performance
977
-
978
- Optimized Rust implementation provides:
979
- - Single trajectory (1000m): ~5ms
980
- - Monte Carlo (1000 runs): ~500ms
981
- - BC estimation: ~50ms
982
- - Zero calculation: ~10ms
983
-
984
- ## Common Ballistic Coefficients
985
-
986
- | Caliber | Weight | BC (G1) | BC (G7) | Description |
987
- |---------|--------|---------|---------|-------------|
988
- | .223 | 55gr | 0.250 | - | FMJ |
989
- | .223 | 77gr | 0.362 | 0.182 | Match |
990
- | .308 | 168gr | 0.475 | 0.224 | Match |
991
- | .308 | 175gr | 0.505 | 0.253 | Match |
992
- | .308 | 180gr | 0.480 | - | Hunting |
993
- | .338 | 300gr | 0.768 | 0.383 | Match |
994
- | 6.5mm | 140gr | 0.620 | 0.310 | Match |
995
- | .50 | 750gr | 1.050 | 0.520 | Match |
996
-
997
- ## Troubleshooting
998
-
999
- ### Trajectory hits ground early
1000
- - Check if you're using `--auto-zero` or setting `--angle` manually
1001
- - Default angle is 0° (horizontal), which will hit ground quickly
1002
- - Use `--auto-zero <distance>` to automatically calculate proper angle
1003
-
1004
- ### Units confusion
1005
- - Default is Imperial (fps, grains, yards)
1006
- - Use `--units metric` for metric system
1007
- - All inputs must match the selected unit system
1008
-
1009
- ### Unexpected BC behavior
1010
- - G1 and G7 models have different BC values for same bullet
1011
- - G7 typically better for boat-tail bullets
1012
- - BC segmentation automatically applied based on bullet type
1013
-
1014
- ## Contributing
1015
-
1016
- Contributions are welcome! Please:
1017
- 1. Fork the repository
1018
- 2. Create a feature branch
1019
- 3. Add tests for new features
1020
- 4. Run `cargo test` and `cargo fmt`
1021
- 5. Submit a pull request
112
+ - **Size**: the `.wasm` binary is roughly 430 KB (about 175 KB gzipped). It is not code-split or
113
+ lazily loaded — the whole engine loads up front.
114
+ - **Single-threaded**: no SIMD/threads assumptions; no `SharedArrayBuffer` or
115
+ cross-origin-isolation (COOP/COEP) headers required.
116
+ - **No filesystem/network**: table loaders (`loadDragTable`, `loadBc5dTable`) and any file-based
117
+ CLI flags (e.g. native `--drag-table <FILE>`) need the host to fetch bytes and hand them in; see
118
+ `loadDragTable` above.
119
+ - **`pdf`/`online` features are unavailable**: this build excludes them (see above), so
120
+ PDF dope-card export and the online BC-estimation API are not part of the WASM surface.
121
+ - Full API surface (including the `Calculator` builder class) is documented in the bundled
122
+ `.d.ts`; the full CLI flag reference `runCommand` accepts is documented in the source repo's
123
+ `CLI_USAGE.md`.
1022
124
 
1023
125
  ## License
1024
126
 
1025
- This project is licensed under the MIT License - see LICENSE file for details.
1026
-
1027
- **Note:** The MIT license applies to the open source ballistics-engine library, CLI, and FFI bindings. The `--online` feature connects to a proprietary cloud service with separate terms. See [ONLINE_SERVICE.md](ONLINE_SERVICE.md) for details.
1028
-
1029
- ## Acknowledgments
1030
-
1031
- - Ballistics physics based on Robert McCoy's "Modern Exterior Ballistics"
1032
- - Drag tables from military ballistics research
1033
- - BC segmentation algorithms from Bryan Litz's research
1034
- - Community contributions and testing
127
+ MIT OR Apache-2.0 see `LICENSE` and `LICENSE-APACHE` in this package.
1035
128
 
1036
- ## Support
129
+ ## Source
1037
130
 
1038
- For issues, questions, or contributions:
1039
- - GitHub Issues: [github.com/ajokela/ballistics-engine/issues](https://github.com/ajokela/ballistics-engine/issues)
131
+ https://github.com/ajokela/ballistics-engine