Skip to main content

Module run

Module run 

Source
Expand description

Running cases: fly what the case says, measure it, and compare against the reference.

Structs§

CaseRun
What running one case gives.
DescentDevice
One device as the reference declares it.
DescentSetup
The parts of a reference a descent case needs, read from the generator’s own JSON.
FlightDevice
One recovery device of a whole flight, as the reference declares it.
FlightMotor
The motor of a whole flight, as the reference records RocketPy flying it.
WholeFlightSetup
The parts of a reference a whole-flight case needs, read from the generator’s own JSON.

Enums§

ValidateError
What can go wrong running a case.

Constants§

DESCENT_METRICS
The metric names a descent case can report.
GAP_CLOSED_HINT
What to do when a case declares a known gap that hpr no longer has: the hint that ends that refusal’s message.
HINTS
The hints that end some of ValidateError::Case’s messages, after "; ". A program can show one apart from the fact (ValidateError::help), such as on a help: line.
WHOLE_FLIGHT_METRICS
The metric names a whole-flight case can report: flight.py’s, as RocketPy defines them, and the root mean square of hpr’s height and speed less the reference’s series, whose reference is 0, exact agreement.

Functions§

run_case
Runs one case: flies it, measures it, and compares every metric it names.
run_lock
Runs every case the lock names, in its order, and reports the comparisons.

Type Aliases§

SeriesRow
One instant of a trajectory: time since ignition, height of the center of dry mass above where it started, and its speed, s, m and m/s.